Batch-configures domain names.
Operation description
-
Each user can make up to 3 calls per second.
-
You can configure up to 50 domain names per batch, separated by commas.
-
Calling BatchSetCdnDomainConfig to configure features for domain names generates a unique ConfigId. You can use the ConfigId to update or delete the configuration. For more information, see Query and use a ConfigId.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
cdn:BatchSetCdnDomainConfig |
update |
*Domain
|
None |
|
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| DomainNames |
string |
Yes |
The domain names to configure for acceleration. Separate multiple domain names with a comma (,). Note the following limits:
|
www.example.com |
| Functions |
string |
Yes |
A list of features to configure. You can specify up to 50 features. The format is as follows:
Setting parentId to -1 removes the conditional rule reference from the configuration.
The following example shows a configuration that does not use parentId. The origin_request_header feature adds an origin-fetch HTTP header. The request parameters are as follows:
The following example shows a configuration that uses parentId. The origin_request_header feature adds an origin-fetch HTTP header and references the conditional rule with configid=222728944812032. The request parameters are as follows:
The following example shows how to remove a conditional rule reference using the parentId parameter. The origin_request_header feature already references the conditional rule with configid=222728944812032. To remove the reference, set parentId to -1. The request parameters are as follows:
|
[{"functionArgs": [{"argName": "key","argValue": "Content-Encoding"},{"argName": "value","argValue": "gzip"}],"functionName": "set_resp_header"} ] |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
|||
| RequestId |
string |
The request ID. |
04F0F334-1335-436C-A1D7-6C044FE73368 |
| DomainConfigList |
object |
||
| DomainConfigModel |
array<object> |
The list of domain name configurations. |
|
|
object |
|||
| ConfigId |
integer |
The configuration ID. A value of 0 indicates that the configuration failed. Reconfigure the feature. |
1234567 |
| 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": 1234567,
"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 incorrectly formatted. | |
| 400 | InvalidArgValue.Malformed | The specified ArgValue is invalid. | Specified ArgValue is malformed. |
| 400 | Invalid%s.ValueNotSupported | [%s] is not supported. | |
| 400 | Invalid%s.Malformed | The specified ArgValue [%s] is invalid. | |
| 400 | MissingParameter%s | The specified value of ArgName[%s] is missing. | You must specify this parameter. |
| 400 | InvalidFunctionArgs.Malformed | The specified FunctionArgs is invalid. | The specified feature parameter is invalid. |
| 400 | MissingParameter | The specified ArgValue is missing. | |
| 400 | InvalidHeaderKey.ValueNotSupported | The specified value of parameter HeaderKey is not supported. | The specified HTTP header is invalid. Valid values: Content-Type, Cache-Control, Content-Disposition, Content-Language, Expires, Access-Control-Allow-Origin, Access-Control-Allow-Methods, Access-Control-Allow-Headers, Access-Control-Max-Age, Access-Control-Expose-Headers, and Access-Control-Allow-Credentials. |
| 400 | TooManyDomains | The count of domain is over 50. | |
| 400 | InvalidRule.Malformed | %s | |
| 400 | ConfigurationConflicts | The staging environment has a configuration in effect and cannot modify the production environment configuration. | Failed to modify the parameter settings in the production environment because the parameter settings are different from those in the stating environment. Set parameters in the staging environment before you publish them to the production environment. |
| 400 | InvalidFunction.NotSupported | The domain is not supported to set the function. | This feature is not supported for domain names. |
| 400 | InvalidDomain.BelongToConfigGroup | This Domain activated in configuration group and should modify by config group. | |
| 400 | EntityNotExist.Role | EntityNotExist.Role | |
| 400 | MissingParameterFunctions | The specified value of Functions is missing. | |
| 400 | NoPermission.SLR | The current user does not have permission to create servicelinkedrole. Please contact the Alibaba Cloud account or administrator to authorize AliyunCDNFullAccess or custom policy:Service Name:cdn-ddos.cdn.aliyuncs.com,Role: AliyunServiceRoleForCDNAccessingDDoS,Permission: ram: CreateServiceLinkedRole | You are not authorized to create service-linked roles. Obtain the AliyunCDNFullAccess permission or custom permission policies used to create service-linked roles from your Alibaba Cloud account or the administrator. Obtain custom permissions based on the following information: Service Name: cdn-ddos.cdn.aliyuncs.com, Service-linked Role Name: AliyunServiceRoleForCDNAccessingDDoS, Required Permission: ram:CreateServiceLinkedRole. |
| 400 | ConfigExceedLimit | Count of config entries exceeds the limit. | The upper limit is reached. |
| 400 | EdgeScriptCountExceedLimit | The number of rules exceeds the default limit. | The number of rules exceeds the limit. 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 internal server error occurred. |
| 400 | ConfigParentExceedLimit | Config parent exceed limit. | The referenced advanced conditional rule exceeds the threshold. |
| 400 | Function.InvalidParentId | The specified parentId does not exist. | The specified rule does not exist. |
| 400 | BatchSetBusinessError | some configs error:%s | A configuration error occurred: %s |
| 400 | ConfigDuplicate | Duplicate configuration. This function has already been configured and cannot be added repeatedly. | Duplicate configuration. This function has already been configured and cannot be added repeatedly. |
| 400 | FunctionArgError | The function parameter of the domain configuration is incorrect. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.