Files

luhuayi 007dffd756 DWS API 8.5.1_20260108 version

Reviewed-by: Pruthi, Vineet <vineet.pruthi@t-systems.com>
Co-authored-by: luhuayi <luhuayi@huawei.com>
Co-committed-by: luhuayi <luhuayi@huawei.com>

2026-03-06 08:01:27 +00:00

27 KiB

Raw Permalink Blame History

Creating an Alarm Subscription

Function

This API is used to create an alarm subscription.

Calling Method

For details, see Calling APIs.

URI

POST /v2/{project_id}/alarm-subs

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID. To obtain the value, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
name	Yes	String	Definition Subscribed alarm name. Range N/A
enable	No	Integer	Definition Whether to enable subscription. Range N/A
alarm_level	No	String	Definition Alarm severity. Range N/A
notification_target	Yes	String	Definition Message topic address. Range N/A
notification_target_name	Yes	String	Definition Message topic name. Range N/A
notification_target_type	Yes	String	Definition Message topic type. Only SMN is supported. Range N/A
time_zone	Yes	String	Definition Time zone. Range N/A

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
id	String	Definition Alarm subscription ID. Range N/A
name	String	Definition Subscribed alarm name. Range N/A
enable	Integer	Definition Whether to enable subscription. Range N/A
alarm_level	String	Definition Alarm severity. Range N/A
project_id	String	Definition Project ID. Range N/A
name_space	String	Definition Service to which the alarm belongs. Range N/A
notification_target	String	Definition Message topic address. Range N/A
notification_target_name	String	Definition Message topic name. Range N/A
notification_target_type	String	Definition Message topic type. Range N/A
language	String	Definition Language. Range N/A
time_zone	String	Definition Time zone. Range N/A

Example Requests

Create an alarm subscription (Subscription name: zrf-test-12. Alarm m severity: critical,major,minor. SMN topic name: dws-test-nodelete. Topic address: urn:smn:eu-de-01:4cf650fd46704908aa071b4df2453e1e:dws-test-nodelete).

https://{Endpoint}/v2/4cf650fd46704908aa071b4df2453e1e/alarm-subs

{
  "alarm_level" : "urgent,important,minor",
  "enable" : 1,
  "name" : "zrf-test-12",
  "notification_target" : "urn:smn:eu-de-01:4cf650fd46704908aa071b4df2453e1e:dws-test-nodelete",
  "notification_target_name" : "dws-test-nodelete",
  "notification_target_type" : "SMN",
  "time_zone" : "GMT+08:00"
}

Example Responses