Update Alert Tags


更新当前和历史告警的标签内容。

请求格式

POST https://{apigw-address}/alert-service/v2.1/alerts?action=updateTags

请求参数(URI)

名称 位置(Path/Query) 必需/可选 数据类型 描述
orgId Query 必需 String 资产所属的组织 ID。如何获取 orgId 信息>>

请求参数(Body)

名称 必需/可选 数据类型 描述
alertId 必需 String 告警 ID。
tags 必需 Map 需要修改的标签。标签的作用与表示方法>>
isPatchUpdate 必需 Boolean

是否全量更新。

  • 当其值为 true 时,只更新参数中指定字段的值。
  • 当其值为 false 时,更新所有字段的值,即未指定值的字段将被置空。

响应参数

名称 数据类型 描述
data Integer 更新的条数。

示例

请求示例

url: https://{apigw-address}/alert-service/v2.1/alerts?action=updateTags&orgId=yourOrgId
method: POST
{
    "alertId":"20201109a7451eac2ef7b562bd673198e55d0019",
    "isPatchUpdate":true,
    "tags":{
        "tag2":"ok"
    }
}

返回示例

{
    "code":0,
    "msg":"OK",
    "requestId":"4c69be41-c8b8-4e48-9a79-16af759c35e7",
    "data":1
}

Java SDK 调用示例

public void testUpdateAlertRecordTags(){

  UpdateAlertTagsRequest request = new UpdateAlertTagsRequest();
  request.setOrgId(orgId);
  request.setAlertId("20201109a7451eac2ef7b562bd673198e55d0019");
  Map<String,String> map = new HashMap<>();
  map.put("tag2","ok");
  request.setTags(map);
  request.setIsPatchUpdate(true);
  try {
      UpdateAlertTagsResponse response = Poseidon.config(PConfig.init().appKey(appKey).appSecret(appSecret).debug())
              .url(url)
              .getResponse(request, UpdateAlertTagsRequest.class);
      System.out.println(response);
  }
  catch(Exception e){
      System.out.print(e);
  }
}