查询一键告警列表
功能介绍
查询一键告警列表
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
GET /v2/{project_id}/one-click-alarms
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
租户ID 最小长度：1 最大长度：64 正则匹配：^[a-zA-Z0-9-]{1,64}$ |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
Content-Type |
是 |
String |
发送的实体的MIME类型。默认使用application/json; charset=UTF-8。 缺省值：application/json; charset=UTF-8 最小长度：1 最大长度：64 |
|
X-Auth-Token |
是 |
String |
用户Token 最小长度：1 最大长度：16384 |
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
one_click_alarms |
Array of one_click_alarms objects |
一键告警列表 数组长度：1 - 1000 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
one_click_alarm_id |
String |
一键告警ID |
|
namespace |
String |
指标命名空间 |
|
description |
String |
一键告警描述，长度范围[0,256]，该字段默认值为空字符串 |
|
enabled |
Boolean |
开关 |
状态码： 400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
请求异常内部业务状态码 最小长度：0 最大长度：256 |
|
error_msg |
String |
请求异常信息 最小长度：0 最大长度：256 |
|
request_id |
String |
请求ID 最小长度：0 最大长度：256 |
状态码： 401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
请求异常内部业务状态码 最小长度：0 最大长度：256 |
|
error_msg |
String |
请求异常信息 最小长度：0 最大长度：256 |
|
request_id |
String |
请求ID 最小长度：0 最大长度：256 |
状态码： 403
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
请求异常内部业务状态码 最小长度：0 最大长度：256 |
|
error_msg |
String |
请求异常信息 最小长度：0 最大长度：256 |
|
request_id |
String |
请求ID 最小长度：0 最大长度：256 |
状态码： 500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
请求异常内部业务状态码 最小长度：0 最大长度：256 |
|
error_msg |
String |
请求异常信息 最小长度：0 最大长度：256 |
|
request_id |
String |
请求ID 最小长度：0 最大长度：256 |
请求示例
无
响应示例
状态码： 200
OK
{
"one_click_alarms" : [ {
"one_click_alarm_id" : "o1234567890123456789012",
"namespace" : "SYS.ECS",
"description" : "hello world",
"enabled" : true
} ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
|
400 |
参数校验失败 |
|
401 |
未认证 |
|
403 |
认证鉴权失败 |
|
500 |
系统内部错误 |
错误码
请参见错误码。
