Use BatchSetDcdnDomainConfigs to configure multiple domain names in a batch - Edge Security Acceleration

Use BatchSetDcdnDomainConfigs to configure features for multiple domain names at once.

Operation description

You can include up to 50 domain names in each request.
The rate limit is 30 calls per second per account.

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

update

*domain

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

None

Request parameters

Parameter	Type	Required	Description	Example
DomainNames	string	Yes	The domain names to accelerate. Separate multiple domain names with a comma (,). Note the following limits: You can specify a maximum of 20 domain names. The product of the number of domain names and the number of features in the `Functions` parameter must not exceed 50.	example.com,example.org
Functions	string	Yes	A list of up to 50 features. Use the following format: functionName: The name of the feature. For a list of configurable features, see Feature list. argName: A configuration item for the feature specified by functionName. You can specify multiple configuration items. argValue: The value for the specified argName. parentid: The ID of a rule condition. This parameter is optional. You can create a rule condition by using the `condition` function, a part of the rules engine. A rule condition filters user requests based on specified parameters. Creating a rule condition generates a configid. You can then use this configid as the value of the `parentid` parameter to reference the condition in other functions. This allows you to combine rule conditions with feature configurations for greater flexibility. For more information about configurable functions, see Parameters for domain name configuration features. `[ { "functionArgs": [ { "argName": "Parameter A", "argValue": "Value of Parameter A" }, { "argName": "Parameter B", "argValue": "Value of Parameter B" } ], "functionName": "Feature Name" } ]`	[{"functionArgs":[{"argName":"switch","argValue":"on"},{"argName":"region","argValue":"*"}],"functionName":"ipv6"}]

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	04F0F334-1335-436C-A1D7-6C044FE73368
DomainConfigList	object
DomainConfigModel	array<object>	The domain name configurations.
	object
ConfigId	integer	The configuration ID. If a value of 0 is returned, the configuration failed. You must reconfigure the feature.	123456
DomainName	string	The domain name.	www.example.com
FunctionName	string	The feature name.	set_resp_header

Examples

Success response

JSON format

{
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
  "DomainConfigList": {
    "DomainConfigModel": [
      {
        "ConfigId": 123456,
        "DomainName": "www.example.com",
        "FunctionName": "set_resp_header"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidFunctions.Malformed	The specified Functions is invalid.	The specified configuration is invalid.
400	InvalidArgValue.Malformed	The specified ArgValue is invalid.	The value specified for the ArgValue parameter is invalid.
400	Invalid%s.ValueNotSupported	[%s] is not supported.	The specified value is not supported.
400	Invalid%s.Malformed	The specified ArgValue [%s] is invalid.	The value specified for the ArgValue parameter is invalid.
400	MissingParameter	You must specify ArgValue.	A required parameter is not set.
400	InvalidRule.Malformed	%s	%s
400	InvalidHeaderKey.ValueNotSupported	The specified value of parameter HeaderKey is not supported.	The HeaderKey parameter is set to an invalid value.
400	MissingParameter%s	The specified value of ArgName %s is missing.	A required parameter is not set.
400	InvalidParameter	Domain already exists in high ddos.	The domain name is already protected by Anti-DDoS services.
400	ConfigExceedLimit	Count of config entries exceeds the limit.	The number of features exceeds the limit.
400	EdgeScriptCountExceedLimit	The number of rules exceeds the default limit (1). To increase the limit, submit a ticket.
400	EdgeScripOptionsHasInnerConfig	The extension has a background configuration or a parameter of this configuration is invalid. For more information, submit a ticket.	The extension has a background configuration or a configured parameter is invalid. For more information, submit a ticket.
400	EdgeScriptGrammarNotSupport	A background customization rule exists or a parameter of this configuration is invalid. For more information, submit a ticket.	A background custom rule exists or a configured parameter is invalid. For more information, submit a ticket.
400	EdgeScriptNotSupportJs	JavaScript rules are not supported. For more information, submit a ticket.	JavaScript rules are not supported. For more information, submit a ticket.
400	ServiceInvokeFailed	Failed to invoke service.	An error occurred while invoking internal services.
400	ConfigParentExceedLimit	Config Parent exceed limit.
400	BatchSetBusinessError	some configs error:%s
400	Function.InvalidParentId	The specified parentId does not exist.
400	Domain.DDosQuotaFull	The user’s domain quota for DDos is full.
400	AccountArrears	The user‘s account is in arrears.
400	DDosExpired	The user‘s DDoS protection has expired.
400	Domain.DDosAlreadyExists	This specified domain has been in DDoS.
400	Domain.PortConfiguring	This specified domain's special ports are configuring.
400	Domain.PortAllocateError	Your port resource allocation failed, please try again in 30 minutes.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.