DescribeDcdnUserDomains - Edge Security Acceleration - Alibaba Cloud Documentation Center

Queries the accelerated domain names that belong to your Alibaba Cloud account. You can filter domains by name or by status. Fuzzy match is supported when you filter domains by name.

Operation description

Note You can call this operation up to 80 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 entries to return on each page. Default value: 20. Valid values: 1 to 500.	20
PageNumber	integer	No	The number of returned pages. Valid values: 1 to 100000.	1
DomainName	string	No	The accelerated domain names. If you do not set this parameter, configurations of all domain names that match the conditions are returned.	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 (default): exact match Note If you specify the domain names to query but do not set the DomainSearchType parameter, the exact match mode is used.	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 domain names. false: does not display detailed information.	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+0.	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+0. Note The end time must be later than the start time.	2018-05-10T14:00:00Z
Coverage	string	No	The acceleration region. By default, all acceleration regions are queried. domestic: Chinese mainland overseas: outside the Chinese mainland global: global	domestic
Tag	array<object>	No	The list of tags.
	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
WebSiteType	string	No	The business type of the domain. Separate multiple values with commas (,). Default value: dynamic. To query common domains, keep the default value. To query domains of the computing business type, enter computing_routine or computing_image.	computing_routine

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 entries returned per page.	12
TotalCount	long	The total number of entries returned.	12
Domains	array<object>	The information about the queried domains.
PageData	object
GmtCreated	string	The time when the domain was added to DCDN.	2015-10-28T11:05:50Z
Description	string	The reason why the domain failed the review.	audit failed
SSLProtocol	string	Indicates whether HTTPS was enabled. on: enabled. off: disabled.	on
ResourceGroupId	string	The ID of the resource group.	rg-acfmv6jutt**
Sandbox	string	The sandbox status.	normal
DomainStatus	string	The domain status. online: The domain is active. offline: The domain is suspended. configuring: The domain is being configured. configure_failed: The domain failed to be configured. checking: The domain is under review. check_failed: The domain failed the review.	online
Cname	string	The CNAME of the domain.	test.aliyun.com.w.alikunlun.com
GmtModified	string	The time when the domain was modified.	2015-10-28T09:31:59Z
DomainName	string	The domain name.	www.example.com
DomainId	long	The domain ID.	11223344
Sources	array<object>	The information about the origin servers.
Source	object
Type	string	The type of the origin server.	oss
Weight	string	The weight of the origin server.	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: accelerates response to API calls. webservicescene: accelerates content delivery for websites. staticscene: accelerates the delivery of videos, images, and text. **If you leave this parameter empty, no scenarios are supported.	apiscene
FunctionType	string	The computing service type. Valid values: routine image cloudFunction	routine

Examples

Sample success responses

JSONformat

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

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

Change history

Change time	Summary of changes	Operation
2024-05-11	The Error code has changed	View Change Details
2023-08-29	The Error code has changed. The request parameters of the API has changed. The response structure of the API has changed	View Change Details
2023-08-02	The Error code has changed. The response structure of the API has changed	View Change Details