Docs

Web Application Firewall

Rate limiting

BatchCopyCCRule

Batch copy rate limiting rules to target domains or domain groups based on the rule ID.

Important note

Total service API call limit: 1000 QPS

Single account call limit: 50 QPS

HTTP request

Method: POST

URL: https://waf.volcengineapi.com/?Action=BatchCopyCCRule&Version=2023-12-25

Request parameters

The following table lists only the request parameters specific to this API and some common parameters. For more information, see Common parameters.

Query

Action String required Sample value: BatchCopyCCRule

API name. The name of the current API is BatchCopyCCRule.

Version String required Sample value: 2023-12-25

API version. The current API version is 2023-12-25.

Body

ProjectName String Optional Sample value: default

Project name, used to associate the current resource with the corresponding project. Only projects for which the current identity has permissions can be associated. To obtain the project name, refer to the ListProjectResources API (to get the project resource list), or call the CreateProject API to create a new project. The default value is default.

DstHostGroupIDs Integer[] Optional Sample value: [7061]

List of target domain group IDs to which rate limiting rules are copied. Each array element is a domain group ID. Either this parameter or the DstHosts parameter can be used to specify the target object for rule copying.

DstHosts String[] Optional Sample value: -

List of target domains to which rate limiting rules are copied. Each array element is a domain string. Either this parameter or the DstHostGroupIDs parameter can be used to specify the target object for rule copying.

DstRulePriorityAdjustType Integer required Sample value: 1

Insertion method for the rule after copying. Supported values are as follows.

1: Insert with the lowest priority;

2: Insert with the highest priority.

OverwriteSameName Boolean Optional Sample value: true

Whether to overwrite rate limiting rules with the same name under the target domain. The default value is false.

If set to true, rules with the same name will be overwritten.

If set to false, rules with the same name will be skipped.

SrcRuleID Integer required Sample value: 54253

Specify the unique ID of the rate limiting rule to be copied. The API will locate the corresponding rule based on this ID and perform the batch copy operation.

Response parameters

FailedHosts Object[] Sample value: -

List of domains for which copying rate limiting rules failed. Each element contains the domain and the reason for failure.

Host String Sample value: example.volcwaf.com

Domain for which copying rate limiting rules failed.

Reason Integer Sample value: 1

Reason code for failure to copy rate limiting rules to the target domain, including:

0: Unknown error;

1: Internal error;

2: Domain name does not exist;

3: The number of CC rules has reached the limit;

4: CC rule priority conflict;

5: CC rule conflict;

6: The number of advanced condition groups under the path has reached the limit.

SkippedHosts String[] Sample value: ["example.volc001.com"]

List of domains skipped during batch copying of rate limiting rules. Each array element is a domain string.

SuccessHosts String[] Sample value: ["example.volc002.com"]

When batch copying CCv3 rules, the list of target domains where rules were successfully copied. Each array element is a domain string.

Error codes

You can visit Common error codes for more error code information.

Sample

Request

POST https://open.volcengineapi.com/?Action=BatchCopyCCRule&Version=2023-12-25&ProjectName=default
X-Date: 20230711T035055Z
Authorization: HMAC-SHA256 Credential=AKLTNGU0OGEyMT***/20230711/cn-beijing/waf/request, SignedHeaders=content-type;x-content-sha256;x-date, Signature=da4fac562d00f41ad8***

{
  "DstHostGroupIDs": [
    7061
  ],
  "DstRulePriorityAdjustType": 1,
  "OverwriteSameName": true,
  "SrcRuleID": 54253
}

Response

{
    "ResponseMetadata": {
        "RequestId": "20231009200242CE25C146B591DDCE****",
        "Action": "BatchCopyCCRule",
        "Version": "2023-12-25",
        "Service": "waf",
        "Region": "cn-beijing"
    },
    "Result": null
}

Last updated: 2026.05.26 13:02:19