DescribeVodDomains

最后更新时间:2021-05-21 11:27:00

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 parameter. The value used for this API: DescribeVodDomains.
Version Yes String Common parameter. The value used for this API: 2018-07-17.
Region No String Common parameter. This parameter is not required for this API.
Domains.N No Array of String List of domain names. If this parameter is left empty, all domain names will be listed.
  • Maximum number of domain names listed: 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 VOD subapplication ID. If you need to access a resource in a subapplication, set this parameter to the subapplication ID; otherwise, leave it empty.

    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, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Querying all domain names

    Input Example

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

    Output Example

    {
      "Response": {
        "TotalCount": 10,
        "DomainSet": [
          {
            "Domain": "myexample.com",
            "AccelerateAreaInfos": [
              {
                "Area": "Internation",
                "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"
          }
        ],
        "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 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.