Batch Update Active Alert Tags¶

批量更新当前告警库中指定告警的标签数据。返回的结构依次说明每一条告警的更新结果。如果某一条发生了错误信息，会记录下错误信息并且继续执行余下的更新。

请求格式¶

POST https://{apigw-address}/event-service/v2.1/active-alerts?action=batchUpdateTags

请求参数（URI）¶

名称	位置（Path/Query）	必需/可选	数据类型	描述
orgId	Query	必需	String	资产所属的组织ID。如何获取orgId信息>>
isPatchUpdate	Query	必需	Boolean	是否全量更新。当其值为 `true` 时，只更新参数中指定字段的值；当其值为 `false` 时，更新所有字段的值，即未指定值的字段将被置空。

请求参数（Body）¶

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

响应参数¶

名称	数据类型	描述
data	EnosBatchEachData结构体数组	成功或失败消息列表。EnosBatchEachData的详细信息，参见下表。
successSize	Integer	成功更新的当前告警数。
totalSize	Integer	需要更新的当前告警总数。

EnosBatchEachData结构体¶

名称	数据类型	描述
code	Integer	更新成功或失败的指示码： 0: 成功， -1: 失败。
msg	String	成功时返回 `OK` ；如果返回其他值，则为失败。

示例¶

请求示例¶

url: https://{apigw-address}/event-service/v2.1/active-alerts?action=batchUpdateTags&orgId=yourOrgId&isPatchUpdate=false
method: POST
requestBody:
{
    "eventIds":[
        "yourEventId1",
        "yourEventId2"
    ],
    "tags":{
        "Tag999":"999"
    },
    "action":"batchUpdate"
}

返回示例¶

{
    "code":0,
    "msg":"OK",
    "requestId":"4873095e-621d-4cfd-bc2c-edb520f574ea",
    "data":[
        {
            "code":0,
            "msg":"OK",
            "data":null
        },
        {
            "code":0,
            "msg":"OK",
            "data":null
        },
        {
            "code":0,
            "msg":"OK",
            "data":null
        }
    ],
    "successSize":3,
    "totalSize":3
}

Java SDK调用示例¶

public void testBatchUpdateActiveAlertTags() {
    String accessKey = "yourAppAccessKey";
    String secretKey = "yourAppSecretKey";
    String orgId = "yourOrgId";
    String url = "https://{apigw-address}";
    BatchUpdateActiveAlertTagsRequest request = new BatchUpdateActiveAlertTagsRequest();
    request.setOrgId(orgId);
    List < String > list = new LinkedList < > ();
    list.add("20191105f64a4c904e59c84c9daa92da6112c7aa");
    request.setEventIds(list);

    Map < String, String > map = new HashMap < > ();
    map.put("yourTagKey", "yourTagValue");
    request.setTags(map);
    request.setIsPatchUpdate(false);
    try {
        BatchUpdateActiveAlertTagsResponse response = Poseidon.config(PConfig.init().appKey(accessKey).appSecret(secretKey).debug())
            .url(url)
            .getResponse(request, BatchUpdateActiveAlertTagsResponse.class);
        System.out.println(response);
    } catch (Exception e) {
        System.out.print(e);
    }
}