tencent cloud

云点播

DescribeVodDomains

下载
聚焦模式
字号
最后更新时间: 2026-09-18 15:59:59

1. API Description

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.

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. If this field is not specified, all domain information is listed by default. The limits of this field are as follows:
  • The maximum number of domains is 20.
  • 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.

    3. Output Parameters

    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.

    4. Example

    Example1 Query all domain names

    Query all domain info.

    Input Example

    https://vod.intl.tencentcloudapi.com/?Action=DescribeVodDomains
    &<Common request parameters>

    Output Example

    {
        "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"
        }
    }

    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

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

    帮助和支持

    本页内容是否解决了您的问题?

    填写满意度调查问卷,共创更好文档体验。

    文档反馈