Updated on 2026-06-22 GMT+08:00

Adding an Exception Rule

Function

This API is used to add an exception rule.

Calling Method

For details, see Calling APIs.

URI

POST /v1/{project_id}/clusters/{cluster_id}/workload/rules

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID. To obtain the value, see Obtaining a Project ID.

Constraints

N/A

Range

N/A

Default Value

N/A

cluster_id

Yes

String

Definition

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

Constraints

The value must be a valid DWS cluster ID.

Range

It is a 36-digit UUID.

Default Value

N/A

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

rule_name

No

String

Definition

Exception rule name.

Constraints

It cannot be left blank.

Range

N/A

Default Value

N/A

except_rules

No

Array of ExceptRule objects

Definition

Exception rule configuration items.

Constraints

It cannot be left blank.

Range

N/A

Default Value

N/A

Table 3 ExceptRule

Parameter

Mandatory

Type

Description

rule_key

No

String

Definition

Rule item name.

Constraints

N/A

Range

N/A

Default Value

N/A

rule_value

No

String

Definition

Rule item value.

Constraints

N/A

Range

N/A

Default Value

N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

workload_res_code

Integer

Definition

Error code.

Range

N/A

workload_res_str

String

Definition

Error details.

Range

N/A

items

Array of ExceptRuleBo objects

Definition

Exception rule list.

Range

N/A

count

Integer

Definition

Total number of exception rules.

Range

Greater than or equal to 0

Table 5 ExceptRuleBo

Parameter

Type

Description

name

String

Definition

Rule name.

Range

N/A

action

String

Definition

Action that triggers an exception rule.

Range

N/A

queues

Array of strings

Definition

Names of resource pools bound to an exception rule.

Range

N/A

except_rules

Map<String,String>

Definition

Exception rule configuration items.

Range

N/A

Example Requests

Create an exception rule.

POST https://{Endpoint}/v1/89cd04f168b84af6be287f71730fdb4b/clusters/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90/workload/rules

{
  "rule_name" : "rule910_1",
  "except_rules" : [ {
    "rule_key" : "blocktime",
    "rule_value" : "600"
  }, {
    "rule_key" : "elapsedtime",
    "rule_value" : "300"
  }, {
    "rule_key" : "action",
    "rule_value" : "abort"
  } ]
}

Example Responses

Status code: 200

Operation succeeded.

{
  "workload_res_code" : 0,
  "workload_res_str" : null,
  "items" : [ {
    "name" : "default_cpu_percent",
    "action" : "abort",
    "queues" : [ ],
    "except_rules" : {
      "action" : "abort",
      "cpuavgpercent" : "50",
      "elapsedtime" : "900"
    }
  } ],
  "count" : 3
}

SDK Sample Code

The SDK sample code is as follows.

Create an exception rule.

 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
59
60
61
62
63
64
65
66
67
68
69
70
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
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.dws.v2.region.DwsRegion;
import com.huaweicloud.sdk.dws.v2.*;
import com.huaweicloud.sdk.dws.v2.model.*;

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

public class AddWorkloadRuleSolution {

    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");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        DwsClient client = DwsClient.newBuilder()
                .withCredential(auth)
                .withRegion(DwsRegion.valueOf("<YOUR REGION>"))
                .build();
        AddWorkloadRuleRequest request = new AddWorkloadRuleRequest();
        request.withClusterId("{cluster_id}");
        AddExceptRuleReq body = new AddExceptRuleReq();
        List<ExceptRule> listbodyExceptRules = new ArrayList<>();
        listbodyExceptRules.add(
            new ExceptRule()
                .withRuleKey("blocktime")
                .withRuleValue("600")
        );
        listbodyExceptRules.add(
            new ExceptRule()
                .withRuleKey("elapsedtime")
                .withRuleValue("300")
        );
        listbodyExceptRules.add(
            new ExceptRule()
                .withRuleKey("action")
                .withRuleValue("abort")
        );
        body.withExceptRules(listbodyExceptRules);
        body.withRuleName("rule910_1");
        request.withBody(body);
        try {
            AddWorkloadRuleResponse response = client.addWorkloadRule(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());
        }
    }
}

Create an exception rule.

 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
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkdws.v2.region.dws_region import DwsRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkdws.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"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

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

    try:
        request = AddWorkloadRuleRequest()
        request.cluster_id = "{cluster_id}"
        listExceptRulesbody = [
            ExceptRule(
                rule_key="blocktime",
                rule_value="600"
            ),
            ExceptRule(
                rule_key="elapsedtime",
                rule_value="300"
            ),
            ExceptRule(
                rule_key="action",
                rule_value="abort"
            )
        ]
        request.body = AddExceptRuleReq(
            except_rules=listExceptRulesbody,
            rule_name="rule910_1"
        )
        response = client.add_workload_rule(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Create an exception rule.

 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
59
60
61
62
63
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    dws "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dws/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dws/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dws/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")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := dws.NewDwsClient(
        dws.DwsClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.AddWorkloadRuleRequest{}
	request.ClusterId = "{cluster_id}"
	ruleKeyExceptRules:= "blocktime"
	ruleValueExceptRules:= "600"
	ruleKeyExceptRules1:= "elapsedtime"
	ruleValueExceptRules1:= "300"
	ruleKeyExceptRules2:= "action"
	ruleValueExceptRules2:= "abort"
	var listExceptRulesbody = []model.ExceptRule{
        {
            RuleKey: &ruleKeyExceptRules,
            RuleValue: &ruleValueExceptRules,
        },
        {
            RuleKey: &ruleKeyExceptRules1,
            RuleValue: &ruleValueExceptRules1,
        },
        {
            RuleKey: &ruleKeyExceptRules2,
            RuleValue: &ruleValueExceptRules2,
        },
    }
	ruleNameAddExceptRuleReq:= "rule910_1"
	request.Body = &model.AddExceptRuleReq{
		ExceptRules: &listExceptRulesbody,
		RuleName: &ruleNameAddExceptRuleReq,
	}
	response, err := client.AddWorkloadRule(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

200

Operation succeeded.

400

Request error.

401

Authentication failed.

403

You do not have required permissions.

404

No resources found.

500

Internal server error.

503

Service unavailable.