You can call this operation to query information about all domains that have been added to IP Application Accelerator (IPA) under your account.

You can filter domains by name or by state. Fuzzy match is supported.

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 DescribeDcdnIpaUserDomains

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

CheckDomainShow Boolean No false

Specifies whether to display domains in the checking, check_failed, or configure_failed state.

DomainName String No example.com

The domain name, which is used as a condition to match and filter domain names.

DomainSearchType 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
DomainStatus String No online

The state of the domain, which is used as a condition to filter domain names. Valid values:

  • online: The domain is enabled.
  • offline: The domain is disabled.
  • configuring: The domain is being configured.
  • configure_failed: The domain configuration has failed.
  • checking: The domain is under content review.
  • check_failed: The domain has failed content review.
FuncFilter String No config

The configuration status of the specified feature, which 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.

FuncId String No 98

The ID of the feature. For example, a value of 98 specifies the illicit content moderation feature.

PageNumber Integer No 20

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

PageSize Integer No 20

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

ResourceGroupId String No ResourceGroupId

The ID of the resource group.

Response parameters

Parameter Type Example Description
Domains

The detailed information about each accelerated domain returned.

PageData

In XML format, this parameter indicates the detailed information about one accelerated domain. In JSON format, this parameter indicates the detailed information about all returned accelerated domains.

Cname String example4.com.w.alikunlun.com

The canonical name 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 has failed.
  • checking: The domain is under review.
  • check_failed: The domain has 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

The origin information.

Source

The origin information.

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 have been specified.

Type String oss

The type of the origin.

Weight String 20

The weight of the origin if multiple origins have been specified.

PageNumber Long 5

The page number of the returned page.

PageSize Long 5

The number of entries returned per page.

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

The ID of the request.

TotalCount Long 10

The total number of entries returned.

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>
		    </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>
		    </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>
		    </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>
		    </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>
		    </PageData>
	  </Domains>
</DescribeDcdnIpaUserDomainsResponse>

JSON format

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

Error codes

HTTP status code 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.