All Products
Search
Document Center

CDN:DescribeCdnUserDomainsByFunc

Last Updated:Mar 28, 2024

Queries accelerated domain names that have specified features configured and the status of the domain names.

Operation description

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

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
cdn:DescribeCdnUserDomainsByFuncREAD
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
FuncIdintegerYes

The ID of the feature.

For example, the ID of the origin host feature (set_req_host_header) is 18.

7
PageNumberintegerNo

The number of the page to return. Default value: 1.

Valid values: 1 to 100000.

10
PageSizeintegerNo

The number of domain names to return on each page. Default value: 20.

Valid values: 1 to 50.

20
ResourceGroupIdstringNo

The ID of the resource group.

rg-xxxxx

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

AA75AADB-5E25-4970-B480-EAA1F5658483
PageNumberlong

The page number of the returned page.

1
PageSizelong

The number of entries returned per page.

5
TotalCountlong

The total number of entries returned.

16
Domainsobject []

The configurations of the accelerated domain name.

GmtCreatedstring

The time when the accelerated domain name was added to Alibaba Cloud CDN.

2015-10-28T11:05:52Z
SslProtocolstring

Indicates whether HTTPS is enabled. Valid values:

  • on
  • off
on
Descriptionstring

The description of the status.

audit failed
ResourceGroupIdstring

The ID of the resource group.

rg-xxxxx
DomainStatusstring

The status of the accelerated domain name. Valid values:

  • online: The domain name is enabled.
  • offline: The domain is disabled.
  • configuring: The endpoint group is being configured.
  • configure_failed: The domain failed to be configured.
  • checking: The domain name is under review.
  • check_failed: The domain name failed the review.
  • stopping: The domain name is be disabled.
  • deleting: being deleted
configure_failed
Cnamestring

The CNAME assigned to the accelerated domain name.

example.com.w.alikunlun.com
GmtModifiedstring

The last time when the accelerated domain was modified.

2015-10-29T10:15:31Z
CdnTypestring

The type of workload accelerated by Alibaba Cloud CDN. Valid values:

  • web: image and small file distribution
  • download: large file distribution
  • video: on-demand video and audio streaming
  • liveStream: live streaming
web
DomainNamestring

The accelerated domain name.

example.com
Sourcesobject []

The information about the origin server.

Typestring

The type of the origin server.

ipaddr
Weightstring

The weight of the origin server if multiple origin servers have been specified.

10
Prioritystring

The priority of the configuration item.

20
Portinteger

The port of the origin server.

80
Contentstring

The address of the origin server.

1.1.1.1

Examples

Sample success responses

JSONformat

{
  "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 codeError codeError messageDescription
400InvalidPageNumber.ValueNotSupportedThe specified value of PageNumber is not supported.-
400InvalidPageSize.ValueNotSupportedThe specified value of PageSize is invalid.-
400InvalidDomainStatus.ValueNotSupportedThe specified value of DomainStatus is invalid.-
400InvalidDomainName.MalformedThe specified DomainName is invalid.The specified domain name is invalid.
400InvalidDomainSearchType.ValueNotSupportedThe specified value of DomainSearchType is invalid.-
400InvalidChangeStartTime.MalformedThe specified ChangeStartTime is invalid.-
400InvalidChangeEndTime.MalformedThe specified ChangeEndTime is invalid.-
400InvalidCdnType.MalformedThe specified CdnType is invalid.-

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

Change history

Change timeSummary of changesOperation
No change history