DescribeDcdnIpaUserDomains - Edge Security Acceleration - Alibaba Cloud Documentation Center

Call the DescribeDcdnIpaUserDomains operation to query all IP Application Accelerator (IPA) domain names that belong to your account. You can perform a fuzzy search or filter the domain names by status.

Operation description

Note

The call frequency limit for a single user is 30 calls per second.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dcdn:DescribeDcdnIpaUserDomains

get

*IpaDomain

acs:dcdn:*:{#accountId}:domain/*

None

Request parameters

Parameter	Type	Required	Description	Example
PageSize	integer	No	The number of domain names to return on each page. The default value is 20. The maximum value is 500. Valid values: 1 to 500.	5
PageNumber	integer	No	The page number. Valid values: 1 to 100000. The default value is 1.	1
DomainName	string	No	Filter results by domain name.	example.com
DomainStatus	string	No	Filter results by domain name status. Valid values: online: Enabled. offline: Disabled. configuring: Configuring. configure_failed: Configuration failed. checking: Under review. check_failed: Review failed.	online
DomainSearchType	string	No	The search method for the domain name. Valid values: full_match (default): Exact match. fuzzy_match: Fuzzy match. pre_match: Prefix match. suf_match: Suffix match.	fuzzy_match
CheckDomainShow	boolean	No	Specifies whether to display domain names that are under review, failed the review, or have failed configurations. Valid values: true: Display. false: Do not display.	false
ResourceGroupId	string	No	The ID of the resource group.	rg-acfmyuji4b6r4**
FuncId	string	No	The ID of the feature. For example, a value of 7 specifies the path-based expiration feature. For more information about feature IDs, see Features of DCDN domain names.	7
FuncFilter	string	No	The filter for the feature. config: The feature is enabled. unconfig: The feature is not enabled.	config
Tag	array<object>	No	The list of tags.
	object	No	The details of the tag.
Key	string	No	The key of tag N. N is an integer from 1 to 20. You can call the TagDcdnResources operation to add tags to a domain name.	1
Value	string	No	The value of tag N. N is an integer from 1 to 20.	1

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	AA75AADB-5E25-4970-B480-EAA1F5658483
PageNumber	integer	The page number of the returned page.	1
PageSize	integer	The number of domain names returned per page.	20
TotalCount	integer	The total number of entries returned.	1
Domains	object
PageData	array<object>	The list of domain names and their status information.
	object
GmtCreated	string	The time when the accelerated domain name was created.	2015-10-28T09:32:51Z
Description	string	The reason why the review failed.	audit failed
SSLProtocol	string	Indicates whether HTTPS is enabled. on: Enabled. off: Disabled.	on
ResourceGroupId	string	The ID of the resource group.	abcd1234abcd****
Sandbox	string	The sandbox.	normal
DomainStatus	string	The status of the accelerated domain name. Valid values: online: Enabled. offline: Disabled. configuring: Configuring. configure_failed: Configuration failed. checking: Under review. 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 last modified.	2015-10-28T11:05:52Z
DomainName	string	The accelerated domain name.	example.com
Sources	object
Source	array<object>	The information about the origin server.
	object
Type	string	The type of the origin server.	OSS domain name
Weight	string	The weight of the origin server for origin fetch.	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

Success response

JSON format

{
  "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 name",
              "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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.