All Products
Search
Document Center

Dynamic Content Delivery Network:DescribeDcdnUserDomainsByFunc

Last Updated:Apr 11, 2024

Queries all accelerated domain names with specified features configured that belong to your Alibaba Cloud account based on the FuncId parameter.

Operation description

Note You can call this operation up to 100 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:DescribeDcdnUserDomainsByFuncRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
FuncIdintegerYes

The ID of the feature. For more information about how to query feature IDs, see Parameters for configuring features for domain names. For example, the ID of the origin host feature (set_req_host_header) is 18.

7
FuncFilterstringNo

Specifies whether the feature that is specified by the FuncId parameter is enabled.

  • config: enabled
  • unconfig: not enabled
config
DomainNamestringNo

The accelerated domain name whose ICP filing status you want to update.

example.com
PageNumberintegerNo

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

1
PageSizeintegerNo

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

20
ResourceGroupIdstringNo

The ID of the resource group.

rg-acfmyuji4b6r4**
MatchTypestringNo

The type of the search. Default value: exact_match. Valid values:

  • fuzzy_match: fuzzy search.
  • exact_match: exact search.
exact_match

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

AA75AADB-5E25-4970-B480-EAA1F5658483
PageNumberlong

The page number of the page returned.

1
PageSizelong

The number of entries returned per page.

5
TotalCountlong

The total number of domain names returned.

16
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 Dynamic Content Delivery Network (DCDN).

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

Indicates whether HTTPS is enabled. Valid values:

  • on: HTTPS is enabled.
  • off: HTTPS is disabled.
on
Descriptionstring

The reason why the accelerated domain name failed the review.

audit failed
ResourceGroupIdstring

The ID of the resource group.

rg-acfmyuji4b6r4**
Sandboxstring

Indicates whether the accelerated domain name was in a sandbox.

normal
DomainStatusstring

The status of the accelerated domain name. Valid values:

  • online
  • offline
  • configuring
  • configure_failed
  • checking
  • check_failed
configure_failed
Cnamestring

The CNAME assigned to the accelerated domain name.

example.com.w.alikunlun.net
GmtModifiedstring

The time when the accelerated domain name was modified.

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

The accelerated domain name.

example.com
Sourcesobject []

The information about the origin servers.

Typestring

The type of the origin server.

oss
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 origin server address.

image.developer.aliyundoc.com

Examples

Sample success responses

JSONformat

{
  "RequestId": "AA75AADB-5E25-4970-B480-EAA1F5658483",
  "PageNumber": 1,
  "PageSize": 5,
  "TotalCount": 16,
  "Domains": {
    "PageData": [
      {
        "GmtCreated": "2015-10-28T09:32:51Z",
        "SslProtocol": "on",
        "Description": "audit failed",
        "ResourceGroupId": "rg-acfmyuji4b6r4**",
        "Sandbox": "normal",
        "DomainStatus": "configure_failed",
        "Cname": "example.com.w.alikunlun.net",
        "GmtModified": "2015-10-28T11:05:50Z",
        "DomainName": "example.com",
        "Sources": {
          "Source": [
            {
              "Type": "oss",
              "Weight": "20",
              "Priority": "20",
              "Port": 80,
              "Content": "image.developer.aliyundoc.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.
400InvalidChangeStartTime.MalformedThe specified ChangeStartTime is invalid.The update start time is invalid.
400InvalidChangeEndTime.MalformedThe specified ChangeEndTime is invalid.The update end time is invalid.

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

Change history

Change timeSummary of changesOperation
2023-10-16The Error code has changed. The request parameters of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: MatchType
2023-03-02The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400