Updated on 2026-06-22 GMT+08:00

Modifying an Alarm Subscription

Function

This API is used to modify an alarm subscription.

Calling Method

For details, see Calling APIs.

URI

PUT /v2/{project_id}/alarm-subs/{alarm_sub_id}

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

alarm_sub_id

Yes

String

Definition

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

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

Modify the zrf-test-13 alarm subscription. Change the alarm severity to critical,major,minor, the SMN topic name to dws-test-nodelete, and the address to urn:smn:cn-north-7:4cf650fd46704908aa071b4df2453e1e:dws-test-nodelete.

https://{Endpoint}/v2/4cf650fd46704908aa071b4df2453e1e/alarm-subs/273ce506-dad8-411c-92f9-be5004739b40

{
  "alarm_level" : "urgent,important,minor",
  "enable" : 1,
  "name" : "zrf-test-13",
  "notification_target" : "urn:smn:cn-north-7:4cf650fd46704908aa071b4df2453e1e:dws-test-nodelete",
  "notification_target_name" : "dws-test-nodelete",
  "notification_target_type" : "SMN"
}

Example Responses

Status code: 200

Alarm subscription modified.

{
  "id" : "273ce506-dad8-411c-92f9-be5004739b40",
  "name" : "zrf-test-13",
  "enable" : 1,
  "language" : "zh-cn",
  "alarm_level" : "urgent,important,minor",
  "project_id" : "4cf650fd46704908aa071b4df2453e1e",
  "name_space" : "dws",
  "notification_target" : "urn:smn:cn-north-7:4cf650fd46704908aa071b4df2453e1e:dws-test-nodelete",
  "notification_target_name" : "dws-test-nodelete",
  "notification_target_type" : "SMN",
  "time_zone" : "GMT+08:00"
}

SDK Sample Code

The SDK sample code is as follows.

Modify the zrf-test-13 alarm subscription. Change the alarm severity to critical,major,minor, the SMN topic name to dws-test-nodelete, and the address to urn:smn:cn-north-7:4cf650fd46704908aa071b4df2453e1e:dws-test-nodelete.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.dws.v2.region.DwsRegion;
import com.huaweicloud.sdk.dws.v2.*;
import com.huaweicloud.sdk.dws.v2.model.*;


public class UpdateAlarmSubSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        DwsClient client = DwsClient.newBuilder()
                .withCredential(auth)
                .withRegion(DwsRegion.valueOf("<YOUR REGION>"))
                .build();
        UpdateAlarmSubRequest request = new UpdateAlarmSubRequest();
        request.withAlarmSubId("{alarm_sub_id}");
        AlarmSubUpdateRequest body = new AlarmSubUpdateRequest();
        body.withNotificationTargetType("SMN");
        body.withNotificationTargetName("dws-test-nodelete");
        body.withNotificationTarget("urn:smn:cn-north-7:4cf650fd46704908aa071b4df2453e1e:dws-test-nodelete");
        body.withAlarmLevel("urgent,important,minor");
        body.withEnable(1);
        body.withName("zrf-test-13");
        request.withBody(body);
        try {
            UpdateAlarmSubResponse response = client.updateAlarmSub(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

Modify the zrf-test-13 alarm subscription. Change the alarm severity to critical,major,minor, the SMN topic name to dws-test-nodelete, and the address to urn:smn:cn-north-7:4cf650fd46704908aa071b4df2453e1e:dws-test-nodelete.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkdws.v2.region.dws_region import DwsRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkdws.v2 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = DwsClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(DwsRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = UpdateAlarmSubRequest()
        request.alarm_sub_id = "{alarm_sub_id}"
        request.body = AlarmSubUpdateRequest(
            notification_target_type="SMN",
            notification_target_name="dws-test-nodelete",
            notification_target="urn:smn:cn-north-7:4cf650fd46704908aa071b4df2453e1e:dws-test-nodelete",
            alarm_level="urgent,important,minor",
            enable=1,
            name="zrf-test-13"
        )
        response = client.update_alarm_sub(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Modify the zrf-test-13 alarm subscription. Change the alarm severity to critical,major,minor, the SMN topic name to dws-test-nodelete, and the address to urn:smn:cn-north-7:4cf650fd46704908aa071b4df2453e1e:dws-test-nodelete.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    dws "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dws/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dws/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dws/v2/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := dws.NewDwsClient(
        dws.DwsClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.UpdateAlarmSubRequest{}
	request.AlarmSubId = "{alarm_sub_id}"
	alarmLevelAlarmSubUpdateRequest:= "urgent,important,minor"
	enableAlarmSubUpdateRequest:= int32(1)
	request.Body = &model.AlarmSubUpdateRequest{
		NotificationTargetType: "SMN",
		NotificationTargetName: "dws-test-nodelete",
		NotificationTarget: "urn:smn:cn-north-7:4cf650fd46704908aa071b4df2453e1e:dws-test-nodelete",
		AlarmLevel: &alarmLevelAlarmSubUpdateRequest,
		Enable: &enableAlarmSubUpdateRequest,
		Name: "zrf-test-13",
	}
	response, err := client.UpdateAlarmSub(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

Alarm subscription modified.

400

Request error.

401

Authentication failed.

403

You do not have required permissions.

404

No resources found.

500

Internal server error.

503

Service unavailable.