DescribeDcdnUserDomainsByFunc - Edge Security Acceleration

Call the DescribeDcdnUserDomainsByFunc operation to query all DCDN domain names that are associated with your account and have a specific feature configured. The feature is specified by FuncId.

Operation description

Note

The call frequency for a single user is 100 calls per second.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dcdn:DescribeDcdnUserDomainsByFunc

get

Domain

acs:dcdn:*:{#accountId}:domain/{#DomainName}

None

Request parameters

Parameter	Type	Required	Description	Example
FuncId	integer	Yes	The ID of the feature. To find the ID, search for the feature by name in the Feature parameters for domain name configurations document. For example, the ID of the back-to-origin HOST configuration feature (set_req_host_header) is 18.	7
FuncFilter	string	No	Specifies whether the feature specified by FuncId is enabled. config: enabled. unconfig: not enabled.	config
DomainName	string	No	The accelerated domain name.	example.com
PageNumber	integer	No	The number of the page to return. The default value is 1. Valid values: 1 to 100000.	1
PageSize	integer	No	The number of domain names to return on each page. The default value is 20. Valid values: 1 to 500.	20
ResourceGroupId	string	No	The ID of the resource group.	rg-acfmyuji4b6r4**
MatchType	string	No	The query type. The default value is exact_match. Valid values: fuzzy_match: fuzzy query. exact_match: exact match.	exact_match

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	AA75AADB-5E25-4970-B480-EAA1F5658483
PageNumber	integer	The page number.	1
PageSize	integer	The number of domain names returned on the current page.	5
TotalCount	integer	The total number of domain names.	16
Domains	object
PageData	array<object>	An array of PageData objects that contain the status information of the accelerated domain names.
	object
GmtCreated	string	The time when the accelerated domain name was created.	2015-10-28T09:32:51Z
SslProtocol	string	Indicates whether HTTPS is enabled. Valid values: on: enabled. off: disabled.	on
Description	string	The reason why the review failed.	audit failed
ResourceGroupId	string	The ID of the resource group.	rg-acfmyuji4b6r4**
Sandbox	string	The sandbox.	normal
DomainStatus	string	The status of the accelerated domain name. Valid values: online: enabled. offline: disabled. configuring: configuring. configure_failed: configuration failed. checking: under review. check_failed: review failed.	configure_failed
Cname	string	The CNAME that is assigned to the accelerated domain name.	example.com.w.alikunlun.net
GmtModified	string	The time when the accelerated domain name was last modified.	2015-10-28T11:05:50Z
DomainName	string	The accelerated domain name.	example.com
Sources	object
Source	array<object>	The information about the origin server.
	object
Type	string	The type of the origin server.	oss
Weight	string	The weight of the origin server for back-to-origin routing.	20
Priority	string	The priority.	20
Port	integer	The port of the origin server.	80
Content	string	The address of the origin server.	image.developer.aliyundoc.com

Examples

Success response

JSON format

{
  "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 code	Error code	Error message	Description
400	InvalidPageNumber.ValueNotSupported	The specified value of PageNumber is not supported.	The PageNumber parameter is set to an invalid value. Specify a valid value and try again.
400	InvalidPageSize.ValueNotSupported	The specified value of PageSize is invalid.	The PageSize parameter is set to an invalid. Specify a valid value and try again.
400	InvalidDomainStatus.ValueNotSupported	The specified value of DomainStatus is invalid.	The DomainStatus parameter is set to an invalid value. Specify a valid value and try again.
400	InvalidDomainName.Malformed	The specified DomainName is invalid.	The specified domain name is invalid.
400	InvalidDomainSearchType.ValueNotSupported	The specified value of DomainSearchType is invalid.	The DomainSearchType parameter is set to an invalid value. Specify a valid value and try again.
400	InvalidChangeStartTime.Malformed	The specified ChangeStartTime is invalid.	The update start time is invalid.
400	InvalidChangeEndTime.Malformed	The specified ChangeEndTime is invalid.	The update end time is invalid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.