Create Alert Severity


Create a new alert severity.

Request Format

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

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

severity

Mandatory

GenerateSeverity Struct

The details of the alert severity. For more information, see GenerateSeverity Struct.

GenerateSeverity Struct

Name

Mandatory/Optional

Data Type

Description

severityId

Mandatory

String

The alert severity ID.

severityDesc

Mandatory

StringI18n

Specify the alert severity’s description in its respective locale’s language. For more details on the structure and locales supported, see Internationalized name struct.

tags

Optional

Map

The user-defined tags. (The Key and Value are of String type.) How to use tags>>

Response Parameters

Name

Data Type

Description

data

String

The alert severity ID.

Samples

Request Sample

url: https://{apigw-address}/event-service/v2.1/alert-severities?action=create&orgId=yourOrgId
method: POST
requestBody:
{
    "severity": {
        "severityId": "planetTemperature",
        "severityDesc": {
            "defaultValue": "Error",
            "i18nValue": {
                "en_US": "Error",
                "zh_CN": "错误"
            }
        },
        "tags": {
            "year": "2000",
            "author": "cshan"
        }
    }
}

Return Sample

{
    "code": 0,
    "msg": "OK",
    "requestId": "94e0e6e5-10dd-4fcb-a013-331d5869975a",
    "data": "planetTemperature"
}

SDK Samples


You can access the SDK samples for alert engine service on GitHub: