Domain name for API request: vod.intl.tencentcloudapi.com.
This API is used to query the information list of on-demand 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. If this field is not specified, all domain information is listed by default. The limits of this field 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 | ID of the on-demand application. For customers who activate on-demand services after December 25, 2023, this field must be set to the app ID when accessing resources in on-demand applications, whether in the default application or a newly created application. |
| 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 | Parameter error: Limit. |
| InvalidParameterValue.LimitTooLarge | Parameter value error: Limit is too large. |
| InvalidParameterValue.Offset | Parameter value error. Offset is invalid. |
| InvalidParameterValue.OffsetTooLarge | Parameter value error: Offset is too large. |
文档反馈