All Products
Search
Document Center

ApsaraVideo VOD:DescribeVodDomainDetail

Last Updated:May 22, 2024

Queries the basic information about a specified domain name for CDN.

Operation description

Note This operation is available only in the China (Shanghai) region.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
vod:DescribeVodDomainDetailRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DomainNamestringYes

The domain name for CDN.

example.com

Response parameters

ParameterTypeDescriptionExample
object

The returned datas.

RequestIdstring

The ID of the request.

09ABE829-6CD3-4FE0-556113E2****
DomainDetailobject

The basic information about the domain name for CDN.

GmtCreatedstring

The time when the domain name for CDN was added. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

2017-11-27T06:51:26Z
Weightstring

The weight of the origin server.

1
SSLPubstring

The public key of the certificate. The value of this parameter is returned if HTTPS is enabled.

yourSSLPub
Descriptionstring

The description of the domain name for CDN.

testDescription
SSLProtocolstring

Indicates whether the Secure Sockets Layer (SSL) certificate is enabled. Valid values:

  • on: indicates that the SSL certificate is enabled.
  • off: indicates that the SSL certificate is disabled.
on
CertNamestring

The name of the certificate. The value of this parameter is returned if HTTPS is enabled.

testCertName
Scopestring

This parameter is applicable to users of level 3 or higher in mainland China and users outside mainland China. Valid values:

  • domestic: mainland China. This is the default value.
  • overseas: outside mainland China.
  • global: regions in and outside mainland China.
domestic
Cnamestring

The CNAME that is assigned to the domain name for CDN. You must add a CNAME record in the system of your Domain Name System (DNS) service provider to map the domain name for CDN to the CNAME.

example.com.w.alikunlun.net
DomainStatusstring

The status of the domain name for CDN. Value values:

  • online: indicates that the domain name is enabled.
  • offline: indicates that the domain name is disabled.
  • configuring: indicates that the domain name is being configured.
  • configure_failed: indicates that the domain name failed to be configured.
  • checking: indicates that the domain name is under review.
  • check_failed: indicates that the domain name failed the review.
online
GmtModifiedstring

The last time when the domain name for CDN was modified. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

2017-11-27T06:55:26Z
DomainNamestring

The domain name for CDN.

example.com
Sourcesobject []

The information about the origin server.

Typestring

The type of the origin server. Valid values:

  • ipaddr: a server that you can access by using an IP address.
  • domain: a server that you can access by using a domain name.
  • oss: the URL of an Object Storage Service (OSS) bucket.
oss
Prioritystring

The priority of the origin server.

50
Portinteger

The port number. Valid values: 443 and 80.

80
Contentstring

The address of the origin server.

****.oss-cn-hangzhou.aliyuncs.com
Enabledstring

The status of the origin server. Valid values:

  • online: indicates that the origin server is enabled.
  • offline: indicates that the origin server is disabled.
online

Examples

Sample success responses

JSONformat

{
  "RequestId": "09ABE829-6CD3-4FE0-556113E2****",
  "DomainDetail": {
    "GmtCreated": "2017-11-27T06:51:26Z",
    "Weight": "1",
    "SSLPub": "yourSSLPub",
    "Description": "testDescription",
    "SSLProtocol": "on",
    "CertName": "testCertName",
    "Scope": "domestic",
    "Cname": "example.com.w.alikunlun.net",
    "DomainStatus": "online",
    "GmtModified": "2017-11-27T06:55:26Z",
    "DomainName": "example.com",
    "Sources": {
      "Source": [
        {
          "Type": "oss",
          "Priority": "50",
          "Port": 80,
          "Content": "****.oss-cn-hangzhou.aliyuncs.com",
          "Enabled": "online"
        }
      ]
    }
  }
}

Error codes

For a list of error codes, visit the Service error codes.

The following table describes the common errors that this operation can return. For more information about errors common to all operations, see Error codes.

Error codeError messageHTTP status codeDescription
InvalidDomain.NotFoundThe domain provided does not belong to you.404The error message returned because the specified domain name does not exist or does not belong to you.
ServiceBusyThe specified Domain is configuring, please retry again later.403The error message returned because the domain name is being configured. Try again later.