批量启停告警规则 - BatchEnableAlarmRules
功能介绍
批量启停告警规则
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，需具备如下身份策略权限。
授权项
访问级别
资源类型（*为必须）
条件键
别名
依赖的授权项
ces:alarms:putAction
Write
alarm *
-
g:ResourceTag/<tag-key>
-
g:EnterpriseProjectId
- ces:alarms:put
-
-
URI
POST /v2/{project_id}/alarms/action
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目ID。用于明确项目归属，配置后可通过该ID查询项目下资产，可以通过调用API获取，也可以从控制台获取。获取方式请参见“获取项目ID”。 约束限制: 不涉及。 取值范围: 字符串的长度必须在 1 到 64个字符之间。 默认取值: 不涉及。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
Content-Type |
否 |
String |
参数解释: 发送的实体的MIME类型。 约束限制: 不涉及。 取值范围: 最小字符数量为1，最大为64。 默认取值: 默认使用application/json; charset=UTF-8。 |
|
X-Auth-Token |
否 |
String |
参数解释: 用户Token。 约束限制: 不涉及。 取值范围: 最小字符数量为1，最大为16384。 默认取值: 不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
alarm_ids |
是 |
Array of strings |
参数解释： 需要批量启停的告警规则的ID列表。 约束限制： 告警规则的ID的数量最多为100个，最少1个。 |
|
alarm_enabled |
是 |
Boolean |
参数解释： 是否开启告警规则。 约束限制： 不涉及。 取值范围： 布尔值。
默认取值： true |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
alarm_ids |
Array of strings |
参数解释： 成功启停的告警规则ID列表。 |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
请求异常内部业务状态码 |
|
error_msg |
String |
请求异常信息 |
|
request_id |
String |
请求ID |
状态码：500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
请求异常内部业务状态码 |
|
error_msg |
String |
请求异常信息 |
|
request_id |
String |
请求ID |
请求示例
批量启停告警规则
{
"alarm_ids" : [ "al12345678901234567890" ],
"alarm_enabled" : true
}
响应示例
状态码：200
启停告警规则成功
{
"alarm_ids" : [ "alCzk8o9dtSQHtiDgb44Eepw" ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
启停告警规则成功 |
|
400 |
参数校验失败 |
|
500 |
系统内部错误 |
错误码
请参见错误码。
