Domain name for API request: vod.intl.tencentcloudapi.com.
This API is used to query the list of VOD domain names.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: DescribeVodDomains. |
| Version | Yes | String | Common Params. The value used for this API: 2018-07-17. |
| Region | No | String | Common Params. This parameter is not required. |
| Domains.N | No | Array of String | Domain name list. When this field is left empty, list all domain information by default. The limits are as follows: |
| Limit | No | Integer | Maximum number of results returned for pagination pull. Default value: 20. |
| Offset | No | Integer | Starting offset for pagination pull. Default value: 0. |
| SubAppId | No | Integer | VOD application ID. Customers who activate VOD services after December 25, 2023 must fill this field with the application ID when accessing resources in on-demand applications (whether default or newly created). |
| Parameter Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Total number of domains. |
| DomainSet | Array of DomainDetailInfo | List of domain names. |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
Query all domain info.
https://vod.intl.tencentcloudapi.com/?Action=DescribeVodDomains
&<Common request parameters>
{
"Response": {
"TotalCount": 1,
"DomainSet": [
{
"Domain": "myexample.com",
"Type": "VOD",
"AccelerateAreaInfos": [
{
"Area": "Internation",
"TencentDisableReason": "",
"TencentEdgeDomain": "myexmample.com.dnsv1.com"
}
],
"RefererAuthPolicy": {
"Status": "Disabled",
"AuthType": "",
"BlankRefererAllowed": "No",
"Referers": []
},
"DeployStatus": "Deploying",
"HTTPSConfig": {
"CloudCertId": "K******7",
"CertExpireTime": "2030-01-23T07:25:52Z"
},
"UrlSignatureAuthPolicy": {
"Status": "Enabled",
"EncryptedKey": "acmowmeomeo13432a"
},
"CreateTime": "2019-12-23T07:25:52Z",
"QUICConfig": null,
"IPFilterPolicy": null
}
],
"RequestId": "aeomo-133w3-amomow-22"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| FailedOperation | Operation failed. |
| FailedOperation.InvalidVodUser | The VOD service is not activated. |
| InvalidParameter | Parameter error. |
| InvalidParameterValue.Limit | Invalid parameter: Limit. |
| InvalidParameterValue.LimitTooLarge | Incorrect parameter value: Limit is too large. |
| InvalidParameterValue.Offset | Incorrect parameter value: invalid Offset. |
| InvalidParameterValue.OffsetTooLarge | Incorrect parameter value: Offset is too large. |
文档反馈