Search Alert Severity

Query alert severity by page.

Request Format

POST https://{apigw-address}/event-service/v2.1/alert-severities?action=search

Request Parameters (URI)

Name

Location (Path/Query)

Required or Not

Data Type

Description

orgId

Query

true

String

Organization ID which the asset belongs to. How to get orgId>>

Request Parameters (Body)

Name

Required or Not

Data Type

Description

expression

false

String

Query expression, which supports for sql-like query. The fields that are supported for query include: severityId. The supported arithmetic operators are “=” and “in”, and the logical operator is “and”. How to use expression>>

pagination

false

Pagination request struct

Pagination parameter. When not specified, 10 entries are displayed in each page. The entries are sorted in descending order by updateTime. You can specify a field in the AlertSeverity struct as the sorting criterion. See Pagination Request Struct>>

Response Parameters

Name

Data Type

Description

data

AlertSeverity struct

Alert severity. See AlertSeverity struct.

AlertSeverity Struct

Name

Data Type

Description

severityId

String

Alert severity ID

orgId

String

Organization ID which the asset belongs to

severityDesc

StringI18n

Alert severity description

tags

Tag struct

Tags

updatePerson

String

Update personnel name

updateTime

Long

Update time (UTC)

Input/Output Samples

Request Sample

POST  https://{apigw-address}/event-service/v2.1/alert-severities?action=search&orgId=1c499110e8800000
{
    "pagination": {
        "pageNo": 1,
        "pageSize": 1,
        "sorters": [{
            "field": "severityID",
            "order": "ASC"
        }]
    }
}

Return Sample

{
    "pagination": {
        "pageNo": 1,
        "pageSize": 1,
        "totalSize": 19,
        "sortedBy": [{
            "field": "severityID",
            "order": "ASC"
        }]
    },
    "code": 0,
    "msg": "OK",
    "requestId": "bd591868-0eb1-46dc-a989-c1de33cc671e",
    "data": [{
        "severityId": "001",
        "orgId": "yourOrgId",
        "severityDesc": {
            "i18nValue": {
                "en_US": "Serious!!!" ,
                "zh_CN": "Serious!!!"
            }
        },
        "tags": {
            "111": "2222"
        },
        "updatePerson": "yj_test_customer",
        "updateTime": 1559204166000
    }]
}

Java SDK Sample

public void testSearchAlertSeverity() {
    SearchAlertSeverityRequest request = new SearchAlertSeverityRequest();
    request.setOrgId("1c499110e8800000");
    Pagination pagination = new Pagination();
    pagination.setPageSize(1);
        pagination.setPageNo(1);
    Sorter sorter = new Sorter("severityID", Sorter.Order.ASC);
    List<Sorter> sorterList = new ArrayList<>();
    sorterList.add(sorter);
        pagination.setSorters(sorterList);
        request.setPagination(pagination);
        request.headerParams().put("apim-accesskey", "4ced4f38-1ced-476e0a446215-a602-4307");
        try {
            SearchAlertSeverityResponse response = Poseidon.config(PConfig.init().appKey(accessKey).appSecret(secretKey).debug())
                    .url("https://{apigw-address}")
                    .getResponse(request, SearchAlertSeverityResponse.class);
            Gson gson = new Gson();
            System.out.println(gson.toJson(response));
        } catch (Exception e) {
            System.out.print(e);
        }
}