BatchSetDcdnWafDomainConfigs

Updated at:

Configures the protection status of domain names in batches.

Operation description

Note
  • Rate limit per user: 20 calls per second.

  • Request method: POST.

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:BatchSetDcdnWafDomainConfigs

create

*Domain

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

None None

Request parameters

Parameter

Type

Required

Description

Example

DomainNames

string

Yes

The domain names for which you want to modify the protection status. You can specify up to 50 domain names. Separate multiple domain names with commas (,).

example.com,example2.com

DefenseStatus

string

No

The protection status of the domain name. Valid values: on, off, and empty.

  • When you add a domain name, set the value to on. In this case, the ClientIpTag parameter takes effect. If you select the default header, leave ClientIpTag empty. If you select a custom header, set ClientIpTag to the corresponding value.

  • When you remove a domain name, set the value to off. In this case, the ClientIpTag parameter does not take effect.

  • When you only modify the ClientIpTag parameter, leave DefenseStatus empty.

on

ClientIpTag

string

No

The specified header used to obtain the IP address. If you select the default header, leave this parameter empty. If you select a custom header, set this parameter to the custom value. Separate multiple values with commas (,). You can specify up to 5 values.

X-Forwarded-For

Response elements

Element

Type

Description

Example

object

RequestId

string

The request ID.

CB1A380B-09F0-41BB-3C82-72F8FD6DA2FE

Examples

Success response

JSON format

{
  "RequestId": "CB1A380B-09F0-41BB-3C82-72F8FD6DA2FE"
}

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.
500 InternalError An internal error occurred; please try again later. An internal error occurred. Try again later. If the error persists, submit a ticket.
403 DomainInProtectedMode The domain is in protection mode. To request permission, contact Customer Service. The specified domain name is in the protected mode. If you must perform this operation, contact customer service.
403 %s.NotSupport The specified resource type %s is not supported. The specified resource type is not supported. To use this type of resource, contact us.
403 %s.OverQuota The quantity of %s exceeds the quota. The number of resources exceeds the quota. If you want to apply for more resources, contact us.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.