Help Center/ Cloud Eye/ API Reference/ API V2/ One-Click Monitoring/ Querying Services and Resources That Support One-Click Monitoring

Updated on 2025-10-30 GMT+08:00

View PDF

Querying Services and Resources That Support One-Click Monitoring

Function

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

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.

If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
ces:alarms:listOneClickAlarms	List	-	g:EnterpriseProjectId	ces:oneClickAlarms:list	-

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID. It is used to specify the project that an asset belongs to. You can query the assets of a project by project ID. You can obtain the project ID from the API or console. For details, see Obtaining a Project ID. Constraints N/A Range 1 to 64 characters Default Value N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
Content-Type	No	String	Definition MIME type of the request body. Constraints: None Value range: The value can contain 1 to 64 characters. Default value: The default type is application/json; charset=UTF-8.
X-Auth-Token	No	String	Definition User token. Constraints: None Value range: The value can contain 1 to 16,384 characters. Default value: None

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 that support one-click monitoring.

**Table 4** one_click_alarms
Parameter	Type	Description
one_click_alarm_id	String	Definition One-click monitoring rule ID. Constraints N/A Range The value allows only letters and digits and can contain 1 to 64 characters. Default Value N/A
namespace	String	Definition Namespace of a service. For details about the namespace of each service, see Service Namespaces. Constraints N/A Range The value is in the service.item format. The values of service and item must be a string, starting with a letter and containing only digits (0–9), letters (case-insensitive), and underscores (_). The value must contain 3 to 32 characters. Default Value N/A
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 alarm reporting. true: enabled; false: disabled.

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Status codes customized by each cloud service when a request error occurs.
error_msg	String	Request error message.
request_id	String	Request ID.

Status code: 401

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Status codes customized by each cloud service when a request error occurs.
error_msg	String	Request error message.
request_id	String	Request ID.

Status code: 403

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Status codes customized by each cloud service when a request error occurs.
error_msg	String	Request error message.
request_id	String	Request ID.

Status code: 500

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Status codes customized by each cloud service when a request error occurs.
error_msg	String	Request error message.
request_id	String	Request ID.

Example Requests

None

Example Responses

Status code: 200

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