Search Alert Type


Search for alert types based on the search criteria.

Request Format

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

Request Parameters (URI)

Name Location (Path/Query) Mandatory/Optional Data Type Description
orgId Query Mandatory String The organization ID which the asset belongs to. How to get orgId>>

Request Parameters (Body)

Name Mandatory/Optional Data Type Description
expression Optional String

The query expression, which supports sql-like query. The supported logical operators are “and” and “or”, and query fields are as per the below.

  • typeId and parentTypeId: support operators “=” and “in”.
  • tags.*: supports operator “=”. Note: EnOS Edge does not support tag queries.

How to use expression>>
pagination Optional Pagination Request Struct Lists the paging requirements in a request. When not specified, 10 records are displayed per page by default and sorted in descending order by updateTime. The maximum records per page is 1000 but for optimal performance, it is recommended to have not more than 50 records per page. Alternatively, you can specify typeId or parentTypeId as the sorting criterion. For more details, see Pagination Request Struct.

Response Parameters

Name Data Type Description
data Array of AlertType Struct A list of the alert types. For details of an alertType struct, see AlertType Struct.

AlertType Struct

Name Data Type Description
typeId String The alert severity ID.
typeDesc StringI18n The alert type description.
orgId String The rganization ID which the asset belongs to.
parentTypeId String The alert type ID of the parent alert.
tags Map User-defined tags. (The Key and Value are of String type.)
updatePerson String The name of the person who last updated the alert severity.
updateTime Long The time when the alert was last updated in UTC format.

Samples

Request Sample

url: https://{apigw-address}/event-service/v2.1/alert-types?action=search&orgId=yourOrgId
method: POST
requestBody:
{
    "pagination": {
        "pageNo": 1,
        "pageSize": 1,
        "sorters": [{
            "field": "typeId",
            "order": "DESC"
        }]
    },
  "action": "search"
}

Return Sample

{
    "pagination": {
        "pageNo": 1,
        "pageSize": 1,
        "totalSize": 14,
        "sortedBy": [{
            "field": "typeId",
            "order": "DESC"
        }]
    },
    "code": 0,
    "msg": "OK",
    "requestId": "c1be09d8-a6f2-4647-92e1-3c545fa1b3dd",
    "data": [{
        "typeId": "dateType",
        "orgId": "yourOrgId",
        "typeDesc": {
            "i18nValue": {
        "defaultValue": null,
                "en_US": "dateType desc",
                "zh_CN": ""
            }
        },
        "tags": {
        },
        "updatePerson": "yj_test_customer",
        "updateTime": 1546612655000
    }]
}

Java SDK Sample

public void testSearchAlertType() {
    SearchAlertTypeRequest request = new SearchAlertTypeRequest();
    request.setOrgId(orgId);
    Pagination pagination = new Pagination();
    pagination.setPageNo(1);
    pagination.setPageSize(1);
    List < Sorter > sorterList = new ArrayList < > ();
    sorterList.add(new Sorter("typeId", Sorter.Order.DESC));
    pagination.setSorters(sorterList);
    request.setPagination(pagination);
    try {
        SearchAlertTypeResponse response = Poseidon.config(PConfig.init().appKey(accessKey).appSecret(secretKey).debug())
            .url("https://{apigw-address}")
            .getResponse(request, SearchAlertTypeResponse.class);
        Gson gson = new Gson();
        System.out.println(gson.toJson(response));
    } catch (Exception e) {
        e.printStackTrace();
    }
}