Query accelerated domain names by feature with DescribeCdnUserDomainsByFunc - CDN - Alibaba Cloud - CDN

Queries accelerated domain names that have a specific feature configured, along with their current status.

Note

The maximum number of times each user can call this operation per second is 100.

Debugging

Run this operation directly in OpenAPI Explorer. OpenAPI Explorer calculates request signatures automatically and generates SDK code samples.

Authorization information

To grant a RAM user or RAM role permission to call this operation, include the following entry in the RAM policy.

Operation	Access level	Resource type	Condition key	Associated operation
cdn:DescribeCdnUserDomainsByFunc	get	All Resources``	none	none

Request parameters

Parameter	Type	Required	Description	Example
FuncId	integer	Yes	The ID of the feature to filter by. For example, the origin host feature (`set_req_host_header`) has the ID `18`.	7
PageNumber	integer	No	The page number. Valid values: 1 to 100000. Default value: 1.	10
PageSize	integer	No	The number of entries per page. Valid values: 1 to 50. Default value: 20.	20
ResourceGroupId	string	No	The ID of the resource group.	rg-xxxxx

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	AA75AADB-5E25-4970-B480-EAA1F5658483
PageNumber	long	The page number of the returned page.	1
PageSize	long	The number of entries per page.	5
TotalCount	long	The total number of entries returned.	16
Domains	array\<object\>	The list of accelerated domain names and their configurations.
PageData	object
DomainName	string	The accelerated domain name.	example.com
DomainStatus	string	The status of the accelerated domain name. Valid values:<br>- online: The domain name is enabled.<br>- offline: The domain name is disabled.<br>- configuring: The endpoint group is being configured.<br>- configure_failed: The domain name failed to be configured.<br>- checking: The domain name is under review.<br>- check_failed: The domain name failed the review.<br>- stopping: The domain name is being disabled.<br>- deleting: The domain name is being deleted.	configure_failed
CdnType	string	The type of workload accelerated by Alibaba Cloud CDN. Valid values:<br>- web: image and small file distribution<br>- download: large file distribution<br>- video: on-demand video and audio streaming<br>- liveStream: live streaming	web
Cname	string	The CNAME assigned to the accelerated domain name.	example.com.w.alikunlun.com
SslProtocol	string	Indicates whether HTTPS is enabled. Valid values:<br>- on<br>- off	on
Description	string	The description of the current status.	audit failed
ResourceGroupId	string	The ID of the resource group.	rg-xxxxx
GmtCreated	string	The time when the accelerated domain name was added to Alibaba Cloud CDN.	2015-10-28T11:05:52Z
GmtModified	string	The time when the accelerated domain name was last modified.	2015-10-29T10:15:31Z
Sources	array\<object\>	The information about the origin server.
Source	object
Type	string	The type of the origin server.	ipaddr
Content	string	The address of the origin server.	1.1.1.1
Port	integer	The port of the origin server.	80
Weight	string	The weight of the origin server. This parameter applies when multiple origin servers are configured.	10
Priority	string	The priority of the origin server configuration.	20

Examples

Sample success responses

JSON format

{
  "RequestId": "AA75AADB-5E25-4970-B480-EAA1F5658483",
  "PageNumber": 1,
  "PageSize": 5,
  "TotalCount": 16,
  "Domains": {
    "PageData": [
      {
        "GmtCreated": "2015-10-28T11:05:52Z",
        "SslProtocol": "on",
        "Description": "audit failed",
        "ResourceGroupId": "rg-xxxxx",
        "DomainStatus": "configure_failed",
        "Cname": "example.com.w.alikunlun.com",
        "GmtModified": "2015-10-29T10:15:31Z",
        "CdnType": "web",
        "DomainName": "example.com",
        "Sources": {
          "Source": [
            {
              "Type": "ipaddr",
              "Weight": "10",
              "Priority": "20",
              "Port": 80,
              "Content": "1.1.1.1"
            }
          ]
        }
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidPageNumber.ValueNotSupported	The specified value of PageNumber is not supported.	-
400	InvalidPageSize.ValueNotSupported	The specified value of PageSize is invalid.	-
400	InvalidDomainStatus.ValueNotSupported	The specified value of DomainStatus is invalid.	-
400	InvalidDomainName.Malformed	The specified DomainName is invalid.	The specified domain name is invalid.
400	InvalidDomainSearchType.ValueNotSupported	The specified value of DomainSearchType is invalid.	-
400	InvalidChangeStartTime.Malformed	The specified ChangeStartTime is invalid.	-
400	InvalidChangeEndTime.Malformed	The specified ChangeEndTime is invalid.	-
400	InvalidCdnType.Malformed	The specified CdnType is invalid.	-

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

Change history

Change time	Summary of changes	Operation
2024-12-18	API Description Update. The Error code has changed	View Change Details