Queries the information about all the domains that are added to IP Application Accelerator (IPA) under your account.

You can filter domains by name or by state. Fuzzy match is supported. An accelerated domain supports the following states:

  • Online: The domain is enabled.
  • Offline
  • Configuring
  • Configure_failed
  • Checking
  • Check_failed

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 Position Type Required Example Description
Action Query String Yes DescribeDcdnIpaUserDomains

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

PageSize Query Integer No 20

The number of entries to return on each page. Valid values: 1 to 50. Default value: 20.

PageNumber Query Integer No 20

The number of the page to return. Valid values: 1 to 100000.

DomainName Query String No example.com

The name of the accelerated domain. This parameter is used as a condition to filter domain names. Fuzzy match is supported.

DomainStatus Query String No online

The domain status. This parameter is used as a condition to filter domain names.

DomainSearchType Query String No fuzzy_match

The search method. Default value: fuzzy_match. Valid values:

  • fuzzy_match: fuzzy match.
  • pre_match: prefix match.
  • suf_match: suffix match.
  • full_match: exact match.
CheckDomainShow Query Boolean No false

Specifies whether to display the domains in the checking, check_failed, or configure_failed state. Valid values: true or false.

ResourceGroupId Query String No ResourceGroupId

The ID of the resource group.

FuncId Query String No 98

The ID of the feature. For example, a value of 98 specifies the image pornography detection feature.

FuncFilter Query String No config

The configuration status of the specified feature. This parameter is used as a condition to filter domain names. Valid values: config and unconfig. A value of config specifies the configured features. A value of unconfig specifies the features that are not configured.

Response parameters

Parameter Type Example Description
Domains Array of PageData

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

PageData
Cname String example4.com.w.alikunlun.com

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

Description String audit failed

The reason why the accelerated domain failed review.

DomainName String example.com

The name of the accelerated domain.

DomainStatus String online

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 review.
  • check_failed: The domain failed the content review.
GmtCreated String 2015-10-23T09:23:29Z

The time when the domain was added to IPA.

GmtModified String 2015-10-23T09:23:29Z

The time when the accelerated domain was last modified.

ResourceGroupId String abcd1234abcd1234

The ID of the resource group.

SSLProtocol String on

Indicates whether the HTTPS protocol is enabled. Valid values: on and off.

Sandbox String normal

Indicates whether the accelerated domain is in a sandbox.

Sources Array of Source

The origin information.

Source
Content String oss-xxx-client.com

The address of the origin.

Port Integer 80

The port of the origin.

Priority String 20

The priority of the origin if multiple origins are specified.

Type String oss

The type of the origin.

Weight String 20

The weight of the origin if multiple origins are specified.

PageNumber Long 5

The number of the returned page.

PageSize Long 5

The number of entries returned on each page.

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

The ID of the request.

TotalCount Long 10

The total number of the returned entries.

Examples

Sample requests

https://dcdn.aliyuncs.com/?Action=DescribeDcdnIpaUserDomains
&PageNumber=1
&PageSize=5
&DomainSearchType=fuzzy_match
&<Common request parameters>

Sample success responses

XML format

<DescribeDcdnIpaUserDomainsResponse>
  <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>abcd1234abcd1234</ResourceGroupId>
              <Sources>
                    <Source>
                          <Content>oss-xxx-client.com</Content>
                          <Port>80</Port>
                          <Priority>20</Priority>
                          <Type>oss</Type>
                          <Weight>20</Weight>
                    </Source>
              </Sources>
        </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>abcd1234abcd1234</ResourceGroupId>
              <Sources>
                    <Source>
                          <Content>oss-yyy-client.com</Content>
                          <Port>80</Port>
                          <Priority>20</Priority>
                          <Type>oss</Type>
                          <Weight>20</Weight>
                    </Source>
              </Sources>
        </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>abcd1234abcd1234</ResourceGroupId>
              <Sources>
                    <Source>
                          <Content>oss-yyy-client.com</Content>
                          <Port>80</Port>
                          <Priority>20</Priority>
                          <Type>oss</Type>
                          <Weight>20</Weight>
                    </Source>
              </Sources>
        </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>abcd1234abcd1234</ResourceGroupId>
              <Sources>
                    <Source>
                          <Content>oss-zzz-client.com</Content>
                          <Port>80</Port>
                          <Priority>20</Priority>
                          <Type>oss</Type>
                          <Weight>20</Weight>
                    </Source>
              </Sources>
        </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>abcd1234abcd1234</ResourceGroupId>
              <Sources>
                    <Source>
                          <Content>oss-aaa-client.com</Content>
                          <Port>80</Port>
                          <Priority>20</Priority>
                          <Type>oss</Type>
                          <Weight>20</Weight>
                    </Source>
              </Sources>
        </PageData>
  </Domains>
</DescribeDcdnIpaUserDomainsResponse>

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":"abcd1234abcd1234",
        "Sources": {
          "Source": [
            {
              "Content": "oss-xxx-client.com",
              "Port": 80,
              "Priority": "20",
              "Type": "oss",
              "Weight": "20"
            }
          ]
        }
      },
      {
        "DomainStatus": "configure_failed",
        "DomainName": "example1.com",
        "GmtModified": "2015-10-28T11:05:50Z",
        "GmtCreated": "2015-10-28T09:31:59Z",
        "ResourceGroupId":"abcd1234abcd1234",
        "Sources": {
          "Source": [
            {
              "Content": "oss-yyy-client.com",
              "Port": 80,
              "Priority": "20",
              "Type": "oss",
              "Weight": "20"
            }
          ]
        }
      },
      {
        "Cname": "example2.com.w.alikunlun.net",
        "DomainStatus": "online",
        "DomainName": "example2.com",
        "GmtModified": "2015-10-27T06:26:34Z",
        "GmtCreated": "2015-10-23T09:30:00Z",
        "ResourceGroupId":"abcd1234abcd1234",
        "Sources": {
          "Source": [
            {
              "Content": "oss-yyy-client.com",
              "Port": 80,
              "Priority": "20",
              "Type": "oss",
              "Weight": "20"
            }
          ]
        }
      },
      {
        "Cname": "example3.com.w.kunlunAr.com",
        "DomainStatus": "online",
        "DomainName": "example3.com",
        "GmtModified": "2015-10-23T09:23:29Z",
        "GmtCreated": "2015-10-23T09:23:20Z",
        "ResourceGroupId":"abcd1234abcd1234",
        "Sources": {
          "Source": [
            {
              "Content": "oss-zzz-client.com",
              "Port": 80,
              "Priority": "20",
              "Type": "oss",
              "Weight": "20"
            }
          ]
        }
      },
      {
        "Cname": "example4.com.w.alikunlun.com",
        "DomainStatus": "online",
        "DomainName": "example4.com",
        "GmtModified": "2015-10-23T09:02:11Z",
        "GmtCreated": "2015-10-23T09:01:57Z",
        "ResourceGroupId":"abcd1234abcd1234",
        "Sources": {
          "Source": [
            {
              "Content": "oss-aaa-client.com",
              "Port": 80,
              "Priority": "20",
              "Type": "oss",
              "Weight": "20"
            }
          ]
        }
      }
    ]
  }
}

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 PageNumber parameter is invalid.
400 InvalidPageSize.ValueNotSupported The specified value of PageSize is invalid. The error message returned because the specified PageSize parameter is invalid.
400 InvalidDomainStatus.ValueNotSupported The specified value of DomainStatus is invalid. The error message returned because the specified DomainStatus parameter is invalid.
400 InvalidDomainName.Malformed The specified DomainName is invalid. The error message returned because the specified DomainName parameter is invalid.
400 InvalidDomainSearchType.ValueNotSupported The specified value of DomainSearchType is invalid. The error message returned because the specified DomainSearchType parameter is invalid.

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