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

Querying Services and Resources in One-Click Monitoring

Function

This API is used to query services and resources in one-click monitoring.

URI

GET /v2/{project_id}/one-click-alarms

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}$

Request Parameters

Table 2 Request header parameters

Parameter	Mandatory	Type	Description
Content-Type	Yes	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	Yes	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

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter	Type	Description
one_click_alarms	Array of one_click_alarms objects	Services and resources in one-click monitoring. Array length: 1 to 1000

Table 4 one_click_alarms

Parameter	Type	Description
one_click_alarm_id	String	One-click monitoring ID. Minimum: 1 Maximum: 64 Regular expression matching: ^([a-z]|[A-Z]|[0-9]){1,64}$
namespace	String	Namespace of a service. For details about the namespace of each service, see Service Namespaces. The namespace must be in the service.item format and contain 3 to 32 characters. The values of service and item must start with a letter and can only contain letters, digits, and underscores (_). Minimum: 3 Maximum: 32
description	String	Supplementary information about one-click monitoring. The description can contain 0 to 256 characters and is left blank by default.
enabled	Boolean	Whether to enable one-click monitoring.

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: 401

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: 403

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

Status code: 500

Table 8 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

Query services and resources that support one-click monitoring.

GET /v2/{project_id}/one-click-alarms

Example Responses

Status code: 200

OK

{
  "one_click_alarms" : [ {
    "one_click_alarm_id" : "o1234567890123456789012",
    "namespace" : "SYS.ECS",
    "description" : "hello world",
    "enabled" : true
  } ]
}

Status Codes

Status Code	Description
200	OK
400	Parameter verification failed.
401	Authentication failed.
403	Authentication failed.
500	Failed to complete the request because of an internal server error.

Error Codes

See Error Codes.

Parent topic: One-Click Monitoring