DescribeDcdnIpaUserDomains - Edge Security Acceleration - Alibaba Cloud Documentation Center

Queries information about all domain names that are accelerated by IP Application Accelerator (IPA) in your account. Fuzzy search and filtering by domain status are supported.

Operation description

Note You can call this operation up to 30 times per second per account.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
PageSize	integer	No	The number of domain names per page. Default value: 20.** Valid values: 1 to 500**.	5
PageNumber	integer	No	The page number. Valid values: 1 to 100000. Default value: 1.	1
DomainName	string	No	The domain name that is used as a keyword to filter domain names. Fuzzy match is supported.	example.com
DomainStatus	string	No	The status of the domain name. Valid values: online: enabled offline: disabled configuring: configuring configure_failed: configuration failed checking: reviewing check_failed: review failed	online
DomainSearchType	string	No	The search method. Default value: full_match. Valid values: fuzzy_match: fuzzy match pre_match: prefix match suf_match: suffix match full_match: exact match	fuzzy_match
CheckDomainShow	boolean	No	Specifies whether to display domain names that are under review, failed the review, or failed to be configured. Valid values: true false	false
ResourceGroupId	string	No	The ID of the resource group.	abcd1234abcd****
FuncId	string	No	The ID of the feature. For example, a value of 7 specifies the feature of configuring an expiration rule for a specific directory. For more information about feature IDs, see Parameters for configuring features for domain names.	7
FuncFilter	string	No	The status of the feature. config: The feature is enabled. unconfig: The feature is not enabled.	config
Tag	array<object>	No	The tags of the command.
	object	No	Description of the tags.
Key	string	No	The tag key. Valid values of N: 1 to 20. You can call the TagDcdnResources operation to set a tag for a domain name.	1
Value	string	No	The tag value. Valid values of N: 1 to 20.	1

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	AA75AADB-5E25-4970-B480-EAA1F5658483
PageNumber	long	The page number of the returned page.	1
PageSize	long	The number of domain names returned per page.	20
TotalCount	long	The total number of domain names returned.	1
Domains	array<object>	The array that consists of multiple PageData parameters. The details about each accelerated domain name are included in a separate PageData parameter.
PageData	object
GmtCreated	string	The time when the accelerated domain name was added to Alibaba Cloud CDN.	2015-10-28T09:32:51Z
Description	string	The reason why the accelerated domain name failed the review.	audit failed
SSLProtocol	string	The status of HTTPS. on off	on
ResourceGroupId	string	The ID of the resource group.	abcd1234abcd****
Sandbox	string	Indicates whether the accelerated domain name was in a sandbox.	normal
DomainStatus	string	The status of the accelerated domain name. Valid values: online: enabled offline: disabled configuring: configuring configure_failed: configuration failed checking: reviewing check_failed: review failed	online
Cname	string	The CNAME assigned to the accelerated domain name.	example.com.*.com
GmtModified	string	The time when the accelerated domain name was modified.	2015-10-28T11:05:52Z
DomainName	string	The accelerated domain name.	example.com
Sources	array<object>	The information about the origin server.
Source	object
Type	string	The type of the origin server.	OSS Domain
Weight	string	The weight of the origin server if multiple origin servers have been specified.	20
Priority	string	The priority.	20
Port	integer	The port of the origin server.	80
Content	string	The address of the origin server.	*.aliyuncs.com

Examples

Sample success responses

JSONformat

{
  "RequestId": "AA75AADB-5E25-4970-B480-EAA1F5658483",
  "PageNumber": 1,
  "PageSize": 20,
  "TotalCount": 1,
  "Domains": {
    "PageData": [
      {
        "GmtCreated": "2015-10-28T09:32:51Z",
        "Description": "audit failed",
        "SSLProtocol": "on",
        "ResourceGroupId": "abcd1234abcd****",
        "Sandbox": "normal",
        "DomainStatus": "online",
        "Cname": "example.com.*.com",
        "GmtModified": "2015-10-28T11:05:52Z",
        "DomainName": "example.com",
        "Sources": {
          "Source": [
            {
              "Type": "OSS Domain\n",
              "Weight": "20",
              "Priority": "20",
              "Port": 80,
              "Content": "*.aliyuncs.com"
            }
          ]
        }
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidPageNumber.ValueNotSupported	The specified value of PageNumber is not supported.	The PageNumber parameter is set to an invalid value. Specify a valid value and try again.
400	InvalidPageSize.ValueNotSupported	The specified value of PageSize is invalid.	The PageSize parameter is set to an invalid. Specify a valid value and try again.
400	InvalidDomainStatus.ValueNotSupported	The specified value of DomainStatus is invalid.	The DomainStatus parameter is set to an invalid value. Specify a valid value and try again.
400	InvalidDomainName.Malformed	The specified DomainName is invalid.	The specified domain name is invalid.
400	InvalidDomainSearchType.ValueNotSupported	The specified value of DomainSearchType is invalid.	The DomainSearchType parameter is set to an invalid value. Specify a valid value and try again.

For a list of error codes, visit the Service error codes.