All Products
Search
Document Center

CDN:DescribeUserDomains

最終更新日:Aug 06, 2024

Queries all accelerated domain names in your Alibaba Cloud account and the status of the accelerated domain names. You can filter domain names by name or status. Fuzzy match is supported.

Operation description

  • You can call this operation up to 100 times per second per account.
  • You can specify up to 50 domain names in each request. Separate multiple domain names with commas (,).

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:DescribeUserDomainsget
  • Domain
    acs:cdn:*:{#accountId}:domain/*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
PageSizeintegerNo

The number of entries to return on each page. Valid values: 1 to 500. Default value: 20. Maximum value: 500.

5
PageNumberintegerNo

The page number. Valid values: 1 to 100000.

1
DomainNamestringNo

The accelerated domain. If you do not set this parameter, all domain names that match the conditions are returned.

example.com
DomainStatusstringNo

The status of the domain name. Valid values:

  • online
  • offline
  • configuring
  • configure_failed
  • checking
  • check_failed
  • stopping
  • deleting

If you do not set this parameter, domain names in all states are queried.

configure_failed
DomainSearchTypestringNo

The search mode. 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
CdnTypestringNo

The type of workload accelerated by Alibaba Cloud CDN. Separate types with commas (,). Valid values:

  • web: images and small files
  • download: large files
  • video: on-demand video and audio streaming

If you do not set this parameter, all service types are queried.

download,web,video
CheckDomainShowbooleanNo

Specifies whether to display domain names that are under review, failed the review, or failed to be configured. Valid values:

  • true
  • false
false
ResourceGroupIdstringNo

The ID of the resource group. By default, all IDs are queried.

abcd1234abcd1234
ChangeStartTimestringNo

The beginning of the time range to query. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.

2019-10-10T12:14:55Z
ChangeEndTimestringNo

The end of the time range to query. Specify the time 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.
2019-10-10T12:14:58Z
CoveragestringNo

The acceleration region. By default, all acceleration regions are queried. Valid values:

  • domestic: Chinese mainland
  • global: global
  • overseas: outside the Chinese mainland
domestic
SourcestringNo

The information about the origin server.

example.source.com
Tagarray<object>No

The list of tags. Maximum number of elements in the list: 20

objectNo

The details about the tags.

KeystringNo

The key of a tag.

By default, all tag keys are queried.

key
ValuestringNo

The value of the tag.

By default, all tag values are queried.

value

Response parameters

ParameterTypeDescriptionExample
object

The description of returned data.

RequestIdstring

The ID of the request.

BDA62CE4-3477-439A-B52E-D2D7C829D7C1
PageNumberlong

The page number of the returned page.

1
PageSizelong

The number of entries returned per page.

20
TotalCountlong

The total number of entries returned.

2
Domainsarray<object>

The list of the accelerated domain names returned.

object

The information about the accelerated domain name.

SslProtocolstring

Indicates whether HTTPS is enabled. Valid values:

  • on
  • off
on
Sandboxstring

Indicates whether the accelerated domain name is in a sandbox.

true
GmtModifiedstring

The time when the accelerated domain name was modified.

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

The accelerated domain.

example.com
DomainIdlong

The ID of the accelerated domain name.

11223344
GmtCreatedstring

The time when the accelerated domain name was added.

2015-10-28T09:32:51Z
Descriptionstring

The information about Internet Content Provider (ICP) filing.

filing description
Coveragestring

The acceleration region. Valid values:

  • domestic: Chinese mainland
  • global: global
  • overseas: outside the Chinese mainland
domestic
ResourceGroupIdstring

The ID of the resource group.

abcd1234abcd1234
Cnamestring

The CNAME assigned to the accelerated domain name.

example.com.w.alikunlun.net
DomainStatusstring

The status of the accelerated domain name. Valid values:

  • online
  • offline
  • configuring
  • configure_failed
  • checking
  • check_failed
  • stopping
  • deleting
configure_failed
CdnTypestring

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

  • web: images and small files
  • download: large files
  • video: on-demand video and audio streaming
download
Sourcesarray<object>

The information about the origin server.

object

The details about the origin server.

Typestring

The type of the origin server.

oss
Weightstring

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

15
Prioritystring

The priority.

20
Portinteger

The port of the origin server.

80
Contentstring

The address of the origin server.

***.oss-cn-hangzhou.aliyuncs.com

Examples

Sample success responses

JSONformat

{
  "RequestId": "BDA62CE4-3477-439A-B52E-D2D7C829D7C1",
  "PageNumber": 1,
  "PageSize": 20,
  "TotalCount": 2,
  "Domains": {
    "PageData": [
      {
        "SslProtocol": "on",
        "Sandbox": "true",
        "GmtModified": "2015-10-28T11:05:52Z",
        "DomainName": "example.com",
        "DomainId": 11223344,
        "GmtCreated": "2015-10-28T09:32:51Z",
        "Description": "filing description",
        "Coverage": "domestic",
        "ResourceGroupId": "abcd1234abcd1234",
        "Cname": "example.com.w.alikunlun.net",
        "DomainStatus": "configure_failed",
        "CdnType": "download",
        "Sources": {
          "Source": [
            {
              "Type": "oss",
              "Weight": "15",
              "Priority": "20",
              "Port": 80,
              "Content": "***.oss-cn-hangzhou.aliyuncs.com"
            }
          ]
        }
      }
    ]
  }
}

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
2024-05-11The Error code has changedView Change Details
2023-08-19The Error code has changed. The response structure of the API has changedView Change Details
2023-06-27The Error code has changed. The response structure of the API has changedView Change Details