Search Alert Severity¶

Search for alert severity based on the search criteria.

Request Format¶

POST https://{apigw-address}/event-service/v2.1/alert-severities?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：

severityId: supports operators “=” and “in”.
tags.*: supports operator “=”.

For more information about field description, see AlertSeverity Struct. How to use expression>>

Note: EnOS Edge does not support tag queries.

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 severityId as the sorting criterion. For more details, see Pagination Request Struct.

Response Parameters¶

Name	Data Type	Description
data	Array of AlertSeverity Structs	A list of the alert severities. For details of an alertSeverity struct, see AlertSeverity Struct.

AlertSeverity Struct ¶

Name	Data Type	Description
severityId	String	The alert severity ID.
orgId	String	The organization ID which the asset belongs to.
severityDesc	StringI18n	The alert severity description.
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.

Pagination Struct¶

Name	Data Type	Description
pageNo	Integer	The number of the returned page.
pageSize	Integer	The number of the returned records on a single page.
totalSize	Integer	The total number of the returned records.
sortedBy	Array of Sorter struct	The pagination sorting method, supporting multiple sorting criteria. The earlier the sorting method appears, the higher its priority.

Sorter Struct¶

Name	Data Type	Description
field	String	The pagination field name.
order	String	`ASC` (default) = ascending order, `DESC` = descending order.

Samples¶

Request Sample¶

url: https://{apigw-address}/event-service/v2.1/alert-severities?action=search&orgId=yourOrgId
method: POST
requestBody:
{
    "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": "yourReportID",
    "data": [{
        "severityId": "001",
        "orgId": "yourOrgId",
        "severityDesc": {
      "defaultValue": null,
            "i18nValue": {
                "en_US": "Serious！！！",
                "zh_CN": "严重！！！"
            }
        },
        "tags": {
            "111": "2222"
        },
        "updatePerson": "yj_test_customer",
        "updateTime": 1559204166000,
    "source": null,
    }]
}