Reviewed-by: Pruthi, Vineet <vineet.pruthi@t-systems.com> Co-authored-by: luhuayi <luhuayi@huawei.com> Co-committed-by: luhuayi <luhuayi@huawei.com>
15 KiB
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
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
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 |
Response Parameters
Status code: 200
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 |
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
}
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. |