DescribeDcdnWafDomainDetail - Edge Security Acceleration

Operation description

Note

The call frequency for a single user is 20 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:DescribeDcdnWafDomainDetail

get

*WafDomain

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

None

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	Yes	The accelerated domain name. Exact match is required. Only a single domain name can be queried.	example.com

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	BEA5625F-8FCF-48F4-851B-CA63946DA630
Domain	object	The accelerated domain name.
DomainName	string	The accelerated domain name.	example.com
DefenseScenes	array<object>	The type of the mitigation setting.
	object
DefenseScene	string	The type of the mitigation setting. The following scenarios are supported: waf_group: Basic web protection. custom_acl: Custom mitigation policies. whitelist: Whitelist.	waf_group
PolicyId	integer	The ID of the mitigation policy. If multiple IDs exist, only one is displayed.	10000002
PolicyIds	string	The IDs of the mitigation policies. Multiple IDs are separated by commas (,).	10000001,10000004

Examples

Success response

JSON format

{
  "RequestId": "BEA5625F-8FCF-48F4-851B-CA63946DA630",
  "Domain": {
    "DomainName": "example.com",
    "DefenseScenes": [
      {
        "DefenseScene": "waf_group",
        "PolicyId": 10000002,
        "PolicyIds": "10000001,10000004"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter	The specified parameter is invalid.	A parameter is set to an invalid value.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.