All Products
Search
Document Center

Dynamic Content Delivery Network:DescribeDcdnIpaUserDomains

Last Updated:Apr 11, 2024

The information about all IPA-accelerated domain names within your Alibaba Cloud account is queried.

Operation description

Note You can call this operation up to 30 times per second per account.

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
dcdn:DescribeDcdnIpaUserDomainsRead
  • IpaDomain
    acs:dcdn:*:{#accountId}:domain/*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
PageSizeintegerNo

The number of domain names to return on each page. Default value: 20. Maximum value: 500. Valid values: an integer between 1 and 500.

5
PageNumberintegerNo

The page number of the returned page. Valid values: 1 to 100000. Default value: 1.

1
DomainNamestringNo

The domain name that is used as a keyword to filter domain names. Fuzzy match is supported.

example.com
DomainStatusstringNo

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
DomainSearchTypestringNo

The search method. Default value: full_match. Valid values:

  • fuzzy_match: fuzzy match
  • pre_match: prefix match
  • suf_match: suffix match
  • full_match: exact match
fuzzy_match
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.

ResourceGroupId
FuncIdstringNo

The ID of the feature. For example, a value of 7 specifies the feature of configuring an expiration rule for a specific directory. For more information about feature IDs, see Parameters for configuring features for domain names.

7
FuncFilterstringNo

The status of the feature.

  • config: The feature is enabled.
  • unconfig: The feature is not enabled.
config
Tagobject []No

The tags of the command.

KeystringNo

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
ValuestringNo

The tag value. Valid values of N: 1 to 20.

1

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 domain names returned per page.

20
TotalCountlong

The total number of domain names returned.

1
Domainsobject []

The array that consists of multiple PageData parameters. The details about each accelerated domain name are included in a separate PageData parameter.

GmtCreatedstring

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

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

The reason why the accelerated domain name failed the review.

audit failed
SSLProtocolstring

The status of HTTPS.

  • on
  • off
on
ResourceGroupIdstring

The ID of the resource group.

abcd1234abcd****
Sandboxstring

Indicates whether the accelerated domain name was in a sandbox.

normal
DomainStatusstring

The status of the accelerated domain name. Valid values:

  • online: enabled
  • offline: disabled
  • configuring: configuring
  • configure_failed: configuration failed
  • checking: reviewing
  • check_failed: review failed
online
Cnamestring

The CNAME assigned to the accelerated domain name.

example.com.*.com
GmtModifiedstring

The time when the accelerated domain name was modified.

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

The accelerated domain name.

example.com
Sourcesobject []

The information about the origin server.

Typestring

The type of the origin server.

OSS Domain
Weightstring

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

20
Prioritystring

The priority.

20
Portinteger

The port of the origin server.

80
Contentstring

The address of the origin server.

*.aliyuncs.com

Examples

Sample success responses

JSONformat

{
  "RequestId": "AA75AADB-5E25-4970-B480-EAA1F5658483",
  "PageNumber": 1,
  "PageSize": 20,
  "TotalCount": 1,
  "Domains": {
    "PageData": [
      {
        "GmtCreated": "2015-10-28T09:32:51Z",
        "Description": "audit failed",
        "SSLProtocol": "on",
        "ResourceGroupId": "abcd1234abcd****",
        "Sandbox": "normal",
        "DomainStatus": "online",
        "Cname": "example.com.*.com",
        "GmtModified": "2015-10-28T11:05:52Z",
        "DomainName": "example.com",
        "Sources": {
          "Source": [
            {
              "Type": "OSS Domain\n",
              "Weight": "20",
              "Priority": "20",
              "Port": 80,
              "Content": "*.aliyuncs.com"
            }
          ]
        }
      }
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidPageNumber.ValueNotSupportedThe specified value of PageNumber is not supported.The PageNumber parameter is set to an invalid value. Specify a valid value and try again.
400InvalidPageSize.ValueNotSupportedThe specified value of PageSize is invalid.The PageSize parameter is set to an invalid. Specify a valid value and try again.
400InvalidDomainStatus.ValueNotSupportedThe specified value of DomainStatus is invalid.The DomainStatus parameter is set to an invalid value. Specify a valid value and try again.
400InvalidDomainName.MalformedThe specified DomainName is invalid.The specified domain name is invalid.
400InvalidDomainSearchType.ValueNotSupportedThe specified value of DomainSearchType is invalid.The DomainSearchType parameter is set to an invalid value. Specify a valid value and try again.

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