Tencent Cloud

Download PDF

DescribeVodDomains

Last updated: 2024-03-27 16:10:00

Download PDF

1. API Description

Domain name for API request: vod.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.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

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 blank, all domain name information will be listed by default. The limitations of this field are as follows: The maximum number of domain names is 20.
Limit	No	Integer	Maximum results to return for pulling paginated queries. Default value: 20
Offset	No	Integer	Page number offset from the beginning of paginated queries. Default value: 0
SubAppId	No	Integer	The VOD application ID. For customers who activate VOD service from December 25, 2023, if they want to access resources in a VOD application (whether it's the default application or a newly created one), they must fill in this field with the application ID.

3. Output Parameters

Parameter Name	Type	Description
TotalCount	Integer	Total number of domain names
DomainSet	Array of DomainDetailInfo	Domain name information list
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.

4. Example

Example1 Describe Vod Domains

Describe Vod Domains.

Input Example

https://vod.tencentcloudapi.com/?Action=DescribeVodDomains
&<Public Request Parameter>

Output Example

{
    "Response": {
        "TotalCount": 1,
        "DomainSet": [
            {
                "Domain": "myexample.com",
                "AccelerateAreaInfos": [
                    {
                        "Area": "Internation",
                        "TencentDisableReason": "",
                        "TencentEdgeDomain": "myexmample.com.dnsv1.com"
                    }
                ],
                "RefererAuthPolicy": {
                    "Status": "Disabled",
                    "AuthType": "",
                    "BlankRefererAllowed": "No",
                    "Referers": []
                },
                "DeployStatus": "Deploying",
                "HTTPSConfig": {
                    "CertExpireTime": "2030-01-23T07:25:52Z"
                },
                "UrlSignatureAuthPolicy": {
                    "Status": "Enabled",
                    "EncryptedKey": "acmowmeomeo13432a"
                },
                "CreateTime": "2019-12-23T07:25:52Z",
                "QUICConfig": null
            }
        ],
        "RequestId": "aeomo-133w3-amomow-22"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

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	Invalid parameter.
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.

tencent cloud

Recent Pages

DescribeVodDomains

1. API Description

2. Input Parameters

3. Output Parameters

4. Example

Example1 Describe Vod Domains

Input Example

Output Example

5. Developer Resources

SDK

Command Line Interface

6. Error Code

Was this page helpful?

Was this page helpful?

tencent cloud

Sign Up

Log in

Recent Pages

DescribeVodDomains

1. API Description

2. Input Parameters

3. Output Parameters

4. Example

Example1 Describe Vod Domains

Input Example

Output Example

5. Developer Resources

SDK

Command Line Interface

6. Error Code

Was this page helpful?

Was this page helpful?