All Products
Search
Document Center

CDN:BatchSetCdnDomainConfig

Last Updated:Sep 11, 2026

Configures multiple accelerated domain names in a batch by calling BatchSetCdnDomainConfig.

Operation description

  • The maximum number of times that each user can call this operation per second: 3.

  • After you call BatchSetCdnDomainConfig to configure features for domain names, a unique ConfigId is generated. You can use the ConfigId to update or delete configurations. For more information, see Usage and query of ConfigId.

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

cdn:BatchSetCdnDomainConfig

update

*Domain

acs:cdn:*:{#accountId}:domain/{#DomainNames}

None
  • ram:CreateServiceLinkedRole

Request parameters

Parameter

Type

Required

Description

Example

DomainNames

string

Yes

The accelerated domain names. Separate multiple domain names with commas (,). Note the following configuration limits:

  • The product of the number of domain names and the number of features specified by Functions must be less than or equal to 20. For example:
    • If the number of features specified by Functions is 20, you can specify only one domain name at a time.

    • If the number of features specified by Functions is 1, you can specify up to 20 domain names at a time.

www.example.com

Functions

string

Yes

The list of feature configurations that you want to set. Note the following configuration limits:

  • The product of the number of domain names and the number of features specified by Functions must be less than or equal to 20. For example:
    • If the number of features specified by Functions is 20, you can specify only one domain name at a time.

    • If the number of features specified by Functions is 1, you can specify up to 20 domain names at a time.

The format is as follows:

  • functionName (feature name, required): For configurable features, see Feature list. Separate multiple parameters with commas (,).

  • argName (parameter name, required): The configuration items of functionName. You can configure multiple configuration items.

  • argValue (parameter value, required): The values of the configuration items of functionName.

  • parentid (rule condition ID, optional): By configuring the condition (rule engine) function in Domain name configuration feature parameters, you can create rule conditions. Rule conditions can match and filter user requests by identifying various parameters carried in user requests. After each rule condition is created, a corresponding configid is generated. The configid can be referenced as the ParentId parameter by other feature functions. This way, rule conditions can be combined with feature configurations to form more flexible configurations.

If parentId is set to -1, the existing rule conditions in the configuration are deleted.

   "functionArgs": [{
     "argName": "Feature parameter A", 
     "argValue": "Value of feature parameter A"
    }, 
  {
    "argName": "Feature parameter B", 
    "argValue": "Value of feature parameter B"
     }], 
 "functionName": "Feature name",
 "parentId": Optional. The configid of the referenced rule condition.
}]

Example configuration without using parentId: When using the origin_request_header function to add a back-to-origin HTTP request header with a reference to the rule condition configid=222728944812032, the request parameters are as follows:

        "functionArgs": [{
            "argName": "header_operation_type",
            "argValue": "add"
        }, {
            "argName": "header_name",
            "argValue": "Accept-Encoding"
        }, {
            "argName": "header_value",
            "argValue": "gzip"
        }, {
            "argName": "duplicate",
            "argValue": "off"
        }],
        "functionName": "origin_request_header"
}]

Example configuration using parentId: When using the origin_request_header function to add a back-to-origin HTTP request header with a reference to the rule condition configid=222728944812032, the request parameters are as follows:

        "functionArgs": [{
            "argName": "header_operation_type",
            "argValue": "add"
        }, {
            "argName": "header_name",
            "argValue": "Accept-Encoding"
        }, {
            "argName": "header_value",
            "argValue": "gzip"
        }, {
            "argName": "duplicate",
            "argValue": "off"
        }],
        "functionName": "origin_request_header",
        "parentId": 222728944812032
}]

Example configuration for removing the parentId reference from a feature configuration that already uses parentId: The origin_request_header function has already referenced the rule condition configid=222728944812032 when adding a back-to-origin HTTP request header. To remove the reference to the rule condition, the request parameters are as follows:

        "functionArgs": [{
            "argName": "header_operation_type",
            "argValue": "add"
        }, {
            "argName": "header_name",
            "argValue": "Accept-Encoding"
        }, {
            "argName": "header_value",
            "argValue": "gzip"
        }, {
            "argName": "duplicate",
            "argValue": "off"
        }],
        "functionName": "origin_request_header",
        "parentId": -1
}]

[{"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 domain name configuration list.

object

ConfigId

integer

The configuration ID. If the value 0 is returned, the configuration was not applied. 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. The configuration format is invalid.
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. 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.