Queries all the accelerated domain names that belong to your Alibaba Cloud account based on a specified feature ID (FuncId).

Note The maximum number of times that each user can call this operation per second is 100.

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 DescribeDcdnUserDomainsByFunc

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

FuncId Integer Yes 7

The ID of the feature, which can be queried by calling BatchSetDcdnDomainConfigs.

For example, the ID of the feature that is used to set a path expiration time is 7.

FuncFilter String No config

Specifies whether to enable the FuncId feature.

  • config: yes
  • unconfig: no
DomainName String No example.com

The accelerated domain name.

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-acfmyuji4b6****

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 is displayed in the format that is specified by the PageData parameter.

PageData
Cname String example.com.w.alikunlun.net

The CNAME of the accelerated domain name.

Description String audit failed

The reason why the accelerated domain failed the review.

DomainName String example.com

The accelerated domain name.

DomainStatus String configure_failed

The status of the accelerated domain name. Valid values:

  • online: The domain name is enabled.
  • offline: The domain name is disabled.
  • configuring: The domain name is being configured.
  • configure_failed: The domain name failed to be configured.
  • checking: The domain name is under review.
  • check_failed: The domain name failed the review.
GmtCreated String 2015-10-28T09:32:51Z

The time when the accelerated domain name was added to Dynamic Route for CDN (DCDN).

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

The time when the accelerated domain was modified.

ResourceGroupId String rg-acfmyuji4b6r4**

The ID of the resource group.

Sandbox String normal

Specifies whether the accelerated domain name is in a sandbox.

Sources Array of Source

The information about the origin server.

Source
Content String image.developer.aliyundoc.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.

Type String oss

The type of the origin server.

Weight String 20

The weight of the origin server.

SslProtocol String on

Specifies whether to enable HTTPS. Valid values:

  • on: yes
  • off: no
PageNumber Long 1

The number of the page to return.

PageSize Long 5

The number of entries to return on each 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-*****</ResourceGroupId>
        </PageData>
        <PageData>
              <DomainStatus>configure_failed</DomainStatus>
              <DomainName>example.org</DomainName>
              <GmtModified>2015-10-28T11:05:50Z</GmtModified>
              <GmtCreated>2015-10-28T09:31:59Z</GmtCreated>
              <ResourceGroupId>rg-*****</ResourceGroupId>
        </PageData>
        <PageData>
              <Cname>example.net.w.alikunlun.net</Cname>
              <DomainStatus>online</DomainStatus>
              <DomainName>example.net</DomainName>
              <GmtModified>2015-10-27T06:26:34Z</GmtModified>
              <GmtCreated>2015-10-23T09:30:00Z</GmtCreated>
              <ResourceGroupId>rg-*****</ResourceGroupId>
        </PageData>
        <PageData>
              <Cname>example.edu.w.kunlunAr.com</Cname>
              <DomainStatus>online</DomainStatus>
              <DomainName>example.edu</DomainName>
              <GmtModified>2015-10-23T09:23:29Z</GmtModified>
              <GmtCreated>2015-10-23T09:23:20Z</GmtCreated>
              <ResourceGroupId>rg-*****</ResourceGroupId>
        </PageData>
        <PageData>
              <Cname>aliyundoc.com.w.alikunlun.com</Cname>
              <DomainStatus>online</DomainStatus>
              <DomainName>aliyundoc.com</DomainName>
              <GmtModified>2015-10-23T09:02:11Z</GmtModified>
              <GmtCreated>2015-10-23T09:01:57Z</GmtCreated>
              <ResourceGroupId>rg-*****</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-*****"
      },
      {
        "DomainStatus": "configure_failed",
        "DomainName": "example.org",
        "GmtModified": "2015-10-28T11:05:50Z",
        "GmtCreated": "2015-10-28T09:31:59Z",
        "ResourceGroupId":"rg-*****"
      },
      {
        "Cname": "example.net.w.alikunlun.net",
        "DomainStatus": "online",
        "DomainName": "example.net",
        "GmtModified": "2015-10-27T06:26:34Z",
        "GmtCreated": "2015-10-23T09:30:00Z",
        "ResourceGroupId":"rg-*****"
      },
      {
        "Cname": "example.edu.w.kunlunAr.com",
        "DomainStatus": "online",
        "DomainName": "example.edu",
        "GmtModified": "2015-10-23T09:23:29Z",
        "GmtCreated": "2015-10-23T09:23:20Z",
        "ResourceGroupId":"rg-*****"
      },
      {
        "Cname": "aliyundoc.com.w.alikunlun.com",
        "DomainStatus": "online",
        "DomainName": "aliyundoc.com",
        "GmtModified": "2015-10-23T09:02:11Z",
        "GmtCreated": "2015-10-23T09:01:57Z",
        "ResourceGroupId":"rg-*****"
      }
    ]
  }
}

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 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.