Queries the basic information about a specified accelerated domain.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeDcdnIpaDomainDetail

The operation that you want to perform. Set the value to DescribeDcdnIpaDomainDetail.

DomainName String Yes example.com

The name of the accelerated domain whose basic information is to be queried. You can specify only one domain name at a time.

Response parameters

Parameter Type Example Description
DomainDetail Struct

The detailed information about the accelerated domain.

CertName String yourCertName

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

Cname String example.com

The canonical name (CNAME) that is assigned to the domain name.

Description String audit failed

The description.

DomainName String example.com

The name of the accelerated domain.

DomainStatus String online

The status of the accelerated domain. Valid values:

  • online: The domain is enabled.
  • offline: The domain is disabled.
  • configuring: The domain is being configured.
  • configure_failed: The domain configuration failed.
  • checking: The domain is under review.
  • check_failed: The domain failed the content review.
GmtCreated String 2017-11-27T06:51:26Z

The time when the accelerated domain was created.

GmtModified String 2017-11-27T06:51:26Z

The time when the accelerated domain was last modified.

ResourceGroupId String rg-acfmyuji4b6xxxx

The ID of the resource group.

SSLProtocol String on

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

SSLPub String SSLPub

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

Scope String overseas

The region where your acceleration service is deployed. Valid values:

  • domestic: mainland China
  • overseas: outside mainland China
  • global: all the countries in the world
Sources Array

The origin information.

Source
Content String xxx.oss-cn-hangzhou.aliyuncs.com

The address of the origin.

Enabled String online

The status of the origin.

Port Integer 80

The port number. Valid values: 0 to 65535.

Priority String 50

The priority of the origin if multiple origins are specified.

Type String oss

The type of the origin. Valid values:

  • ipaddr: an IP address.
  • domain: a domain name.
  • oss: this value is not supported.
Weight String 10

The weight of the origin if multiple origins are specified.

RequestId String 09ABE829-6CD3-4FE0-AFEE-556113E29727

The ID of the request.

Examples

Sample requests

http://dcdn.aliyuncs.com/?Action=DescribeDcdnIpaDomainDetail
&DomainName=example.com
&<Common request parameters>

Sample success responses

XML format

<DescribeDcdnIpaDomainDetailResponse>
  <RequestId>09ABE829-6CD3-4FE0-AFEE-556113E29727</RequestId>
  <DomainDetail>
        <Cname>example.com.dcdn7mhp.com</Cname>
        <ResourceGroupId>rg-acfmyuji4b6xxxx</ResourceGroupId>
        <DomainStatus>online</DomainStatus>
        <DomainName>example.com</DomainName>
        <Sources>
              <Source>
                    <Enabled>online</Enabled>
                    <Port>80</Port>
                    <Type>oss</Type>
                    <Content>xxx.oss-cn-hangzhou.aliyuncs.com</Content>
                    <Priority>50</Priority>
                    <Weight>10</Weight>
              </Source>
        </Sources>
        <GmtModified>2017-11-27T06:51:26Z</GmtModified>
        <GmtCreated>2017-11-27T06:51:25Z</GmtCreated>
  </DomainDetail>
</DescribeDcdnIpaDomainDetailResponse>

JSON format

{
  "RequestId": "09ABE829-6CD3-4FE0-AFEE-556113E29727",
  "DomainDetail": {
    "Cname": "example.com.dcdn7mhp.com",
    "ResourceGroupId": "rg-acfmyuji4b6xxxx",
    "DomainStatus": "online",
    "DomainName": "example.com",
    "Sources": {
      "Source": [
        {
          "Enabled": "online",
          "Port": 80,
          "Type": "oss",
          "Content": "xxx.oss-cn-hangzhou.aliyuncs.com",
          "Priority": "50",
          "Weight": "10"
        }
      ]
    },
    "GmtModified": "2017-11-27T06:51:26Z",
    "GmtCreated": "2017-11-27T06:51:25Z"
  }
}

Error codes

For a list of error codes, visit the API Error Center.