Update Alert Severity¶

Update an alert severity.

Request Format¶

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

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>>

isPatchUpdate

Query

Mandatory

Boolean

true (default) = Only the fields specified in the parameters are updated. The values of those fields not specified will be retained.
false = The fields specified in the parameters are updated. Those fields not specified will have their existing values (if any) deleted.

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	User-defined tags. (The Key and Value are of String type.) For details, see How to use tags.

Samples¶

Request Sample¶

url: https://{apigw-address}/event-service/v2.1/alert-severities?action=update&orgId=yourOrgId&isPatchUpdate=false
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": "4873095e-621d-4cfd-bc2c-edb520f574ea",
    "data": null
}

SDK Samples¶

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

Java
Python