查询一键告警列表 - ListOneClickAlarms

功能介绍

查询一键告警列表

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

如果使用角色与策略授权，具体权限要求请参见权限和授权项。
如果使用身份策略授权，需具备如下身份策略权限。
授权项
访问级别
资源类型（*为必须）
条件键
别名
依赖的授权项
ces:alarms:listOneClickAlarms
List
-
g:EnterpriseProjectId
ces:oneClickAlarms:list
-

授权项	访问级别	资源类型（*为必须）	条件键	别名	依赖的授权项
ces:alarms:listOneClickAlarms	List	-	g:EnterpriseProjectId	ces:oneClickAlarms:list	-

URI

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

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	参数解释: 项目ID。用于明确项目归属，配置后可通过该ID查询项目下资产，可以通过调用API获取，也可以从控制台获取。获取方式请参见获取项目ID。约束限制: 不涉及。取值范围: 字符串的长度必须在 1 到 64个字符之间。默认取值: 不涉及。

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
Content-Type	否	String	参数解释: 发送的实体的MIME类型。约束限制: 不涉及。取值范围: 最小字符数量为1，最大为64。默认取值: 默认使用application/json; charset=UTF-8。
X-Auth-Token	否	String	参数解释: 用户Token。约束限制: 不涉及。取值范围: 最小字符数量为1，最大为16384。默认取值: 不涉及。

响应参数

状态码：200

表3 响应Body参数
参数	参数类型	描述
one_click_alarms	Array of one_click_alarms objects	一键告警列表

表4 one_click_alarms
参数	参数类型	描述
one_click_alarm_id	String	参数解释：一键告警ID。约束限制：不涉及。取值范围：只能为字母或者数字，字符长度为[1,64] 默认取值：不涉及。
namespace	String	参数解释：查询服务的命名空间，各服务命名空间请参阅支持监控的服务列表。约束限制：不涉及。取值范围：格式为service.item；service和item必须是字符串，必须以字母开头，只能包含0-9/a-z/A-Z/_。字符串的长度必须在 3 到 32个字符之间。默认取值：不涉及。
description	String	参数解释一键告警描述约束限制不涉及取值范围字符长度在0到256之间默认取值空字符串
enabled	Boolean	参数解释是否启用一键告警约束限制不涉及取值范围 true:开启 false：关闭默认取值 true

状态码：400

表5 响应Body参数
参数	参数类型	描述
error_code	String	请求异常内部业务状态码
error_msg	String	请求异常信息
request_id	String	请求ID

状态码：401

表6 响应Body参数
参数	参数类型	描述
error_code	String	请求异常内部业务状态码
error_msg	String	请求异常信息
request_id	String	请求ID

状态码：403

表7 响应Body参数
参数	参数类型	描述
error_code	String	请求异常内部业务状态码
error_msg	String	请求异常信息
request_id	String	请求ID

状态码：500

表8 响应Body参数
参数	参数类型	描述
error_code	String	请求异常内部业务状态码
error_msg	String	请求异常信息
request_id	String	请求ID

请求示例

无

响应示例

状态码：200

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