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 |
Specifies the tenant ID. Minimum: 1 Maximum: 64 Regex Pattern: ^[a-zA-Z0-9-]{1,64}$ |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
Content-Type |
Yes |
String |
Specifies the MIME type of the request body. The default type is application/json; charset=UTF-8. Default: application/json; charset=UTF-8 Minimum: 1 Maximum: 64 |
X-Auth-Token |
Yes |
String |
Specifies the user token. Minimum: 1 Maximum: 16384 |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
one_click_alarms |
Array of one_click_alarms objects |
Specifies services and resources that support one-click monitoring. Array Length: 1 - 1000 |
Parameter |
Type |
Description |
---|---|---|
one_click_alarm_id |
String |
Specifies the one-click monitoring ID for a service. |
namespace |
String |
Specifies the metric namespace. |
description |
String |
Provides supplementary information about one-click monitoring. The description can contain 0 to 256 characters and is left blank by default. |
enabled |
Boolean |
Specifies whether to enable one-click monitoring. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Specifies the status codes customized by each cloud service when a request error occurs. Minimum: 0 Maximum: 256 |
error_msg |
String |
Specifies the request error message. Minimum: 0 Maximum: 256 |
request_id |
String |
Specifies the request ID. Minimum: 0 Maximum: 256 |
Status code: 401
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Specifies the status codes customized by each cloud service when a request error occurs. Minimum: 0 Maximum: 256 |
error_msg |
String |
Specifies the request error message. Minimum: 0 Maximum: 256 |
request_id |
String |
Specifies the request ID. Minimum: 0 Maximum: 256 |
Status code: 403
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Specifies the status codes customized by each cloud service when a request error occurs. Minimum: 0 Maximum: 256 |
error_msg |
String |
Specifies the request error message. Minimum: 0 Maximum: 256 |
request_id |
String |
Specifies the request ID. Minimum: 0 Maximum: 256 |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Specifies the status codes customized by each cloud service when a request error occurs. Minimum: 0 Maximum: 256 |
error_msg |
String |
Specifies the request error message. Minimum: 0 Maximum: 256 |
request_id |
String |
Specifies the request ID. Minimum: 0 Maximum: 256 |
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 |
Failed to verify parameters. |
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