DescribeDcdnUserDomains - Edge Security Acceleration - Alibaba Cloud Documentation Center

Call DescribeDcdnUserDomains to query all DCDN domain names under your account. This operation supports filtering by fuzzy match and domain status.

Operation description

Note

A single user can call this operation up to 80 times 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:DescribeDcdnUserDomains

list

*Domain

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

None

Request parameters

Parameter	Type	Required	Description	Example
PageSize	integer	No	The number of entries to return on each page. Default value: 20. Valid values: 1 to 500.	20
PageNumber	integer	No	The page number. Valid values: 1 to 100000.	1
DomainName	string	No	The accelerated domain name. If you do not specify this parameter, all accelerated domain names under your account are returned.	example.com
DomainStatus	string	No	The status of the 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.	online
DomainSearchType	string	No	The search method for the domain name. Valid values: fuzzy_match: fuzzy match. pre_match: prefix match. suf_match: suffix match. full_match (default): exact match. Note If you specify a domain name but do not set this parameter, the system performs an exact match by default.	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: displays the domain names. false: does not display the domain names.	false
ResourceGroupId	string	No	The ID of the resource group.	rg-acfmv6jutt**
ChangeStartTime	string	No	The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.	2018-05-10T12:00:00Z
ChangeEndTime	string	No	The end of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. Note The end time must be later than the start time.	2018-05-10T14:00:00Z
Coverage	string	No	The acceleration region. Default value: all. Valid values: domestic: the Chinese mainland. overseas: global (excluding the Chinese mainland). global: global.	domestic
Tag	array<object>	No	The list of tags.
	object	No	The tag.
Key	string	No	The key of tag N. Valid values of N: 1 to 20. You can call the TagDcdnResources operation to tag a domain name.	1
Value	string	No	The value of tag N. Valid values of N: 1 to 20.	1
WebSiteType	string	No	The business type. You can specify multiple types and separate them with commas (,). The default value is dynamic, which returns standard DCDN domain names. To query domain names for the computing service, set this parameter to computing_routine or computing_image.	computing_routine

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 entries returned per page.	12
TotalCount	integer	The total number of entries returned.	12
Domains	object
PageData	array<object>	An array of objects. Each object contains information about an accelerated domain name.
	object
GmtCreated	string	The time when the accelerated domain name was created.	2015-10-28T11:05:50Z
Description	string	The description of the domain name.	audit failed
SSLProtocol	string	Indicates whether the HTTPS protocol is enabled. Valid values: on: enabled. off: disabled.	on
ResourceGroupId	string	The ID of the resource group.	rg-acfmv6jutt**
Sandbox	string	Indicates whether the domain name is in a sandbox environment.	normal
DomainStatus	string	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.	online
Cname	string	The canonical name (CNAME) assigned to the accelerated domain name.	test.aliyun.com.w.alikunlun.com
GmtModified	string	The time when the accelerated domain name was last modified.	2015-10-28T09:31:59Z
DomainName	string	The accelerated domain name.	www.example.com
DomainId	integer	The ID of the accelerated domain name.	11223344
Sources	object
Source	array<object>	The information about the origin server.
	object
Type	string	The type of the origin server.	oss
Weight	string	The weight of the origin server. This parameter is used for load balancing.	20
Priority	string	The priority of the origin server.	20
Port	integer	The port of the origin server.	80
Content	string	The address of the origin server.	example.com
Scene	string	The acceleration scenario. Valid values: apiscene: API acceleration. webservicescene: website acceleration. staticscene: acceleration for video, image, and text content. (empty): No scenario is specified.	apiscene
FunctionType	string	The type of the computing service. Valid values: routine: program. image: image. cloudFunction: function.	routine

Examples

Success response

JSON format

{
  "RequestId": "AA75AADB-5E25-4970-B480-EAA1F5658483",
  "PageNumber": 1,
  "PageSize": 12,
  "TotalCount": 12,
  "Domains": {
    "PageData": [
      {
        "GmtCreated": "2015-10-28T11:05:50Z",
        "Description": "audit failed",
        "SSLProtocol": "on",
        "ResourceGroupId": "rg-acfmv6jutt**",
        "Sandbox": "normal",
        "DomainStatus": "online",
        "Cname": "test.aliyun.com.w.alikunlun.com",
        "GmtModified": "2015-10-28T09:31:59Z",
        "DomainName": "www.example.com",
        "DomainId": 11223344,
        "Sources": {
          "Source": [
            {
              "Type": "oss",
              "Weight": "20",
              "Priority": "20",
              "Port": 80,
              "Content": "example.com"
            }
          ]
        },
        "Scene": "apiscene",
        "FunctionType": "routine"
      }
    ]
  }
}

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.
400	InvalidChangeStartTime.Malformed	The specified ChangeStartTime is invalid.	The update start time is invalid.
400	InvalidChangeEndTime.Malformed	The specified ChangeEndTime is invalid.	The update end time is invalid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.