tencent cloud

Feedback

DescribeCDNDomains

Last updated: 2024-01-02 12:24:16

    1. API Description

    Domain name for API request: vod.tencentcloudapi.com.

    Describe CDN Domains

    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: DescribeCDNDomains.
    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 List of domain. If this field is left blank, all domain information will be listed by default.
    Limit No Integer The maximum number of returned results for pagination fetching. Default value: 20.
    Offset No Integer The starting offset of paged pull. 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
    DomainSet Array of CDNDomainInfo Domain information list.
    TotalCount Integer The total number of CDN domains under the current application.
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Describe CDN Domains

    Describe CDN Domains

    Input Example

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

    Output Example

    {
        "Response": {
            "DomainSet": [
                {
                    "Domain": "myexample.com",
                    "DeployStatus": "online",
                    "Cname": "",
                    "CreateTime": "2022-01-01T00:00:00+08:00",
                    "Config": {
                        "Area": "mainland",
                        "Origin": {
                            "Origins": [
                                "src.myexample.com"
                            ],
                            "OriginType": "domain",
                            "ServerName": "",
                            "OriginPullProtocol": "http",
                            "BackupOrigins": [
                                "xxx.com"
                            ],
                            "BackupOriginType": "domain",
                            "BackupServerName": "",
                            "OriginCompany": "others"
                        },
                        "IpFilter": null,
                        "UserAgentFilter": null,
                        "FollowRedirect": null,
                        "RequestHeader": null,
                        "ResponseHeader": null,
                        "Cache": null,
                        "Https": null,
                        "Authentication": null,
                        "ForceRedirect": null,
                        "Referer": null,
                        "MaxAge": null,
                        "Ipv6Access": null,
                        "Quic": null,
                        "AwsPrivateAccess": null,
                        "OssPrivateAccess": null,
                        "HwPrivateAccess": null,
                        "OthersPrivateAccess": null
                    }
                }
            ],
            "TotalCount": 1,
            "RequestId": "12ae8d8e-dce3-4551-9d4b-5594145287e"
        }
    }
    

    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
    AuthFailure CAM signature/authentication error.
    FailedOperation Operation failed.
    FailedOperation.InvalidVodUser The VOD service is not activated.
    InvalidParameter Invalid parameter.
    Contact Us

    Contact our sales team or business advisors to help your business.

    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    7x24 Phone Support