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.
URI
GET /v2/{project_id}/one-click-alarms
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Definition Tenant ID. Constraints: None Value range: Project ID, 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 by calling an API or on the console. For details, see Obtaining a Project ID. The value must contain of 1 to 64 characters. Default value: None |
Request 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. Default value: 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
Parameter |
Type |
Description |
---|---|---|
one_click_alarms |
Array of one_click_alarms objects |
Services and resources that support one-click monitoring. |
Parameter |
Type |
Description |
---|---|---|
one_click_alarm_id |
String |
One-click monitoring ID for a service. |
namespace |
String |
Namespace of a service. For details about the namespace of each service, see Namespace. |
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
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
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
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
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
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 |
Not authenticated. |
403 |
Authentication failed. |
500 |
Internal system error. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot