Queries all the accelerated domain names based on the FuncId parameter under your account.

Debugging

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

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeDcdnUserDomainsByFunc

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

FuncId Integer Yes 7

The ID of the feature. For example, set the value to 7 for the expiration rules for directories.

PageNumber Integer No 1

The number of the page to return. Default value: 1.

Valid values: 1 to 100000.

PageSize Integer No 20

The number of domain names to return on each page. Default value: 20.

Valid values: 1 to 500.

ResourceGroupId String No rg-xxxxx

The ID of the resource group.

Response parameters

Parameter Type Example Description
Domains Array of PageData

The detailed information about each accelerated domain name. The returned information appears in the format that is specified by the PageData parameter.

PageData
CdnType String web

The workload type of the accelerated domain name. Valid values:

  • web: the acceleration of image and small file distribution.
  • download: the acceleration of large file downloads.
  • video: the acceleration of on-demand video and audio streaming.
Cname String example2.com.w.alikunlun.net

The canonical name (CNAME) allocated to the accelerated domain name.

Description String audit failed

The reason why the accelerated domain name failed the content review.

DomainName String example.com

The name of the accelerated domain name.

DomainStatus String configure_failed

The state 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 content review.
  • check_failed: The domain has failed the content review.
GmtCreated String 2015-10-28T09:32:51Z

The time when the accelerated domain was added.

GmtModified String 2015-10-28T11:05:50Z

The last time when the accelerated domain was modified.

ResourceGroupId String rg-xxxxx

The ID of the resource group.

Sandbox String normal

Indicates whether the accelerated domain is in a sandbox environment.

Sources Array of Source

The information about the origin server.

Source
Content String oss-xxx-client.com

The address of the origin server.

Port Integer 80

The port of the origin server.

Priority String 20

The priority of the origin server if multiple origin servers have been specified.

Type String oss

The type of the origin server.

Weight String 20

The weight of the origin server if multiple origin servers have been specified.

SslProtocol String on

Indicates whether the HTTPS protocol is enabled. Valid values:

  • on: HTTPS is enabled.
  • off: HTTPS is disabled.
PageNumber Long 1

The number of the returned page.

PageSize Long 5

The number of returned domain names per page.

RequestId String AA75AADB-5E25-4970-B480-EAA1F5658483

The ID of the request.

TotalCount Long 16

The total number of domain names.

Examples

Sample requests

http(s)://dcdn.aliyuncs.com/?Action=DescribeDcdnUserDomainsByFunc
&FuncId=7
&<Common request parameters>

Sample success responses

XML format

<DescribeDcdnUserDomainsByFuncResponse>
      <PageNumber>1</PageNumber>
      <TotalCount>16</TotalCount>
      <PageSize>5</PageSize>
      <RequestId>AA75AADB-5E25-4970-B480-EAA1F5658483</RequestId>
      <Domains>
            <PageData>
                  <DomainStatus>configure_failed</DomainStatus>
                  <DomainName>example.com</DomainName>
                  <GmtModified>2015-10-28T11:05:52Z</GmtModified>
                  <GmtCreated>2015-10-28T09:32:51Z</GmtCreated>
                  <Description>audit failed</Description>
                  <ResourceGroupId>rg-xxxxx</ResourceGroupId>
            </PageData>
            <PageData>
                  <DomainStatus>configure_failed</DomainStatus>
                  <DomainName>example1.com</DomainName>
                  <GmtModified>2015-10-28T11:05:50Z</GmtModified>
                  <GmtCreated>2015-10-28T09:31:59Z</GmtCreated>
                  <ResourceGroupId>rg-xxxxx</ResourceGroupId>
            </PageData>
            <PageData>
                  <Cname>example2.com.w.alikunlun.net</Cname>
                  <DomainStatus>online</DomainStatus>
                  <DomainName>example2.com</DomainName>
                  <GmtModified>2015-10-27T06:26:34Z</GmtModified>
                  <GmtCreated>2015-10-23T09:30:00Z</GmtCreated>
                  <ResourceGroupId>rg-xxxxx</ResourceGroupId>
            </PageData>
            <PageData>
                  <Cname>example3.com.w.kunlunAr.com</Cname>
                  <DomainStatus>online</DomainStatus>
                  <DomainName>example3.com</DomainName>
                  <GmtModified>2015-10-23T09:23:29Z</GmtModified>
                  <GmtCreated>2015-10-23T09:23:20Z</GmtCreated>
                  <ResourceGroupId>rg-xxxxx</ResourceGroupId>
            </PageData>
            <PageData>
                  <Cname>example4.com.w.alikunlun.com</Cname>
                  <DomainStatus>online</DomainStatus>
                  <DomainName>example4.com</DomainName>
                  <GmtModified>2015-10-23T09:02:11Z</GmtModified>
                  <GmtCreated>2015-10-23T09:01:57Z</GmtCreated>
                  <ResourceGroupId>rg-xxxxx</ResourceGroupId>
            </PageData>
      </Domains>
  </DescribeDcdnUserDomainsByFuncResponse>

JSON format

{
  "PageNumber": 1,
  "TotalCount": 16,
  "PageSize": 5,
  "RequestId": "AA75AADB-5E25-4970-B480-EAA1F5658483",
  "Domains": {
    "PageData": [
      {
        "DomainStatus": "configure_failed",
        "DomainName": "example.com",
        "GmtModified": "2015-10-28T11:05:52Z",
        "GmtCreated": "2015-10-28T09:32:51Z",
        "Description": "audit failed",
        "ResourceGroupId":"rg-xxxxx"
      },
      {
        "DomainStatus": "configure_failed",
        "DomainName": "example1.com",
        "GmtModified": "2015-10-28T11:05:50Z",
        "GmtCreated": "2015-10-28T09:31:59Z",
        "ResourceGroupId":"rg-xxxxx"
      },
      {
        "Cname": "example2.com.w.alikunlun.net",
        "DomainStatus": "online",
        "DomainName": "example2.com",
        "GmtModified": "2015-10-27T06:26:34Z",
        "GmtCreated": "2015-10-23T09:30:00Z",
        "ResourceGroupId":"rg-xxxxx"
      },
      {
        "Cname": "example3.com.w.kunlunAr.com",
        "DomainStatus": "online",
        "DomainName": "example3.com",
        "GmtModified": "2015-10-23T09:23:29Z",
        "GmtCreated": "2015-10-23T09:23:20Z",
        "ResourceGroupId":"rg-xxxxx"
      },
      {
        "Cname": "example4.com.w.alikunlun.com",
        "DomainStatus": "online",
        "DomainName": "example4.com",
        "GmtModified": "2015-10-23T09:02:11Z",
        "GmtCreated": "2015-10-23T09:01:57Z",
        "ResourceGroupId":"rg-xxxxx"
      }
    ]
  }
}

Error codes

HttpCode Error code Error message Description
400 InvalidPageNumber.ValueNotSupported The specified value of PageNumber is not supported. The error message returned because the specified value of the PageNumber parameter is invalid. Specify a valid value.
400 InvalidPageSize.ValueNotSupported The specified value of PageSize is invalid. The error message returned because the specified value of the PageSize parameter is invalid. Specify a valid value.
400 InvalidDomainStatus.ValueNotSupported The specified value of DomainStatus is invalid. The error message returned because the specified value of the DomainStatus parameter is invalid. Specify a valid value.
400 InvalidDomainName.Malformed The specified DomainName is invalid. The error message returned because the format of the specified domain name is invalid.
400 InvalidDomainSearchType.ValueNotSupported The specified value of DomainSearchType is invalid. The error message returned because the specified value of the DomainSearchType parameter is invalid. Specify a valid value.
400 InvalidChangeStartTime.Malformed The specified ChangeStartTime is invalid. The error message returned because the specified value of the ChangeStartTime parameter is invalid.
400 InvalidChangeEndTime.Malformed The specified ChangeEndTime is invalid. The error message returned because the specified value of the ChangeEndTime parameter is invalid.

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