doc-exports/docs/ces/api-ref/DeleteAlarmRuleResources.html

Deleting Resources from an Alarm Rule

Function

This API is used to batch delete resources to an alarm rule. This API does not support alarm rules with Monitoring Scope set to Resource groups. To modify resources in such alarm rules, use the resource group management APIs.

URI

POST /v2/{project_id}/alarms/{alarm_id}/resources/batch-delete

Table 1 Path parameters

Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain the project ID, see Obtaining a Project ID. Minimum: 1 Maximum: 64 Regular expression matching: ^[a-zA-Z0-9-]{1,64}$
alarm_id	Yes	String	Alarm rule ID. Regular expression matching: al([a-z]|[A-Z]|[0-9]){22}$

Request Parameters

Table 2 Request header parameters

Parameter	Mandatory	Type	Description
Content-Type	No	String	MIME type of the request body. The default value is application/json; charset=UTF-8. Default: application/json; charset=UTF-8 Minimum: 1 Maximum: 64
X-Auth-Token	No	String	User token. It is a response to the API for obtaining a user token. This API is the only one that does not require authentication. After a response is returned, the value of X-Subject-Token in the response header is the token. Minimum: 1 Maximum: 16384

Table 3 Request body parameters

Parameter	Mandatory	Type	Description
resources	Yes	Array of arrays of Dimension objects	Resource information. Array length: 0 to 1000

Table 4 Dimension

Parameter	Mandatory	Type	Description
name	Yes	String	Dimension of a resource. For example, the dimension of an ECS can be instance_id. A maximum of four dimensions are supported. For the metric dimension of each resource, see Service Metric Dimensions. Regular expression matching: ^([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_|-){1,32}$
value	No	String	Resource dimension value, that is, the instance ID, for example, 4270ff17-aba3-4138-89fa-820594c39755. Regular expression matching: ^((([a-z]|[A-Z]|[0-9]){1}([a-z]|[A-Z]|[0-9]|_|-|\.)*)|\*){1,256}$ NOTE: To delete a resource, you need to specify the value. If no value is specified, the API skips the deletion without returning an error.

Response Parameters

Status code: 400

Table 5 Response body parameters

Parameter	Type	Description
error_code	String	Status code customized by each cloud service when a request error occurs. Minimum: 0 Maximum: 256
error_msg	String	Request error message. Minimum: 0 Maximum: 256
request_id	String	Request ID. Minimum: 0 Maximum: 256

Status code: 404

Table 6 Response body parameters

Parameter	Type	Description
error_code	String	Status code customized by each cloud service when a request error occurs. Minimum: 0 Maximum: 256
error_msg	String	Request error message. Minimum: 0 Maximum: 256
request_id	String	Request ID. Minimum: 0 Maximum: 256

Status code: 500

Table 7 Response body parameters

Parameter	Type	Description
error_code	String	Status code customized by each cloud service when a request error occurs. Minimum: 0 Maximum: 256
error_msg	String	Request error message. Minimum: 0 Maximum: 256
request_id	String	Request ID. Minimum: 0 Maximum: 256

Example Requests

Deleting resources from an alarm rule

{
  "resources" : [ [ {
    "name" : "rds_cluster_id",
    "value" : "rds000000000001"
  } ] ]
}

Example Responses

None

Status Codes

Status Code	Description
200	Resources deleted.
400	Parameter verification failed.
404	Resources not found.
500	Failed to complete the request because of an internal server error.

Error Codes

See Error Codes.

Parent topic: Resources in an Alarm Rule