Help Center/ Content Delivery Network/ API Reference/ API/ Domain Name Configuration/ Updating the Status and Priority of Rules
Updated on 2025-09-16 GMT+08:00

Updating the Status and Priority of Rules

Function

This API is used to update the status and priority of rules in batches.

Calling Method

For details, see Calling APIs.

URI

POST /v1.0/cdn/configuration/domains/{domain_name}/rules/batch-update

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

domain_name

Yes

String

Definition

Acceleration domain name.

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

rules

Yes

Array of UpdateRuleStatusRequest objects

Definition

Rule list.

Constraints

N/A

Table 3 UpdateRuleStatusRequest

Parameter

Mandatory

Type

Description

rule_id

Yes

String

Definition

Rule ID, which can be obtained by calling the API for listing rules in the rules engine.

Constraints

N/A

Range

N/A

Default Value

N/A

status

No

String

Definition

Whether the rule is enabled.

Constraints

N/A

Range

  • on: enabled.

  • off: disabled.

Default Value

N/A

priority

No

Integer

Definition

Rule priority. A larger value indicates a higher priority.

Constraints

The priority of a rule must be unique.

Range

1 to 100.

Default Value

N/A

Response Parameters

Status code: 204

Request succeeded.

None

Example Requests

POST /v1.0/cdn/configuration/domains/{domain_name}/rules/batch-update

{
  "rules" : [ {
    "rule_id" : "example***********************id",
    "name" : "example",
    "status" : "on",
    "priority" : 1,
    "conditions" : {
      "match" : {
        "logic" : "and",
        "criteria" : [ {
          "match_target_type" : "scheme",
          "match_target_name" : "example",
          "match_type" : "contains",
          "match_pattern" : [ "HTTP" ],
          "negate" : false,
          "case_sensitive" : false
        } ]
      }
    }
  } ]
}

Example Responses

None

SDK Sample Code

The SDK sample code is as follows.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.GlobalCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.cdn.v2.region.CdnRegion;
import com.huaweicloud.sdk.cdn.v2.*;
import com.huaweicloud.sdk.cdn.v2.model.*;

import java.util.List;
import java.util.ArrayList;

public class BatchUpdateRuleStatusSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");

        ICredential auth = new GlobalCredentials()
                .withAk(ak)
                .withSk(sk);

        CdnClient client = CdnClient.newBuilder()
                .withCredential(auth)
                .withRegion(CdnRegion.valueOf("<YOUR REGION>"))
                .build();
        BatchUpdateRuleStatusRequest request = new BatchUpdateRuleStatusRequest();
        request.withDomainName("{domain_name}");
        BatchUpdateRulesRequest body = new BatchUpdateRulesRequest();
        List<UpdateRuleStatusRequest> listbodyRules = new ArrayList<>();
        listbodyRules.add(
            new UpdateRuleStatusRequest()
                .withRuleId("example***********************id")
                .withStatus("on")
                .withPriority(1)
        );
        body.withRules(listbodyRules);
        request.withBody(body);
        try {
            BatchUpdateRuleStatusResponse response = client.batchUpdateRuleStatus(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import GlobalCredentials
from huaweicloudsdkcdn.v2.region.cdn_region import CdnRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkcdn.v2 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]

    credentials = GlobalCredentials(ak, sk)

    client = CdnClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(CdnRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = BatchUpdateRuleStatusRequest()
        request.domain_name = "{domain_name}"
        listRulesbody = [
            UpdateRuleStatusRequest(
                rule_id="example***********************id",
                status="on",
                priority=1
            )
        ]
        request.body = BatchUpdateRulesRequest(
            rules=listRulesbody
        )
        response = client.batch_update_rule_status(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/global"
    cdn "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cdn/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cdn/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cdn/v2/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")

    auth := global.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := cdn.NewCdnClient(
        cdn.CdnClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.BatchUpdateRuleStatusRequest{}
	request.DomainName = "{domain_name}"
	statusRules:= "on"
	priorityRules:= int32(1)
	var listRulesbody = []model.UpdateRuleStatusRequest{
        {
            RuleId: "example***********************id",
            Status: &statusRules,
            Priority: &priorityRules,
        },
    }
	request.Body = &model.BatchUpdateRulesRequest{
		Rules: listRulesbody,
	}
	response, err := client.BatchUpdateRuleStatus(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

204

Request succeeded.

Error Codes

See Error Codes.