Function

This API is used to query the exception rule list of a cluster.

Calling Method

For details, see Calling APIs.

URI

GET /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

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
offset	No	Integer	Definition Page offset, which starts from 0 (page number minus 1). Constraints N/A Range Greater than or equal to 0 Default Value 0
limit	No	Integer	Definition Size of a single page. Constraints N/A Range N/A Default Value 10
rule_name	No	String	Definition Size of a single page. Constraints Exception rule name. Range N/A Default Value N/A
queue_name	No	String	Definition Resource pool name. Constraints N/A Range N/A Default Value N/A

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** 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 4** 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

Query the exception rule list.

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

Example Responses