Updated on 2026-09-10 GMT+08:00

Querying Alarm Settings

Function

This API is used to query alarm settings.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

GET /v2/aad/alarm

Request Parameters

Table 1 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

token

Content-Type

Yes

String

Content-Type

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

blackhole

String

0: enabled. 1: disabled.

ddos

String

0: enabled. 1: disabled.

topic_name

String

Topic name.

topic_urn

String

Topic subscription link.

Status code: 400

Table 3 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_description

String

Error description.

Example Requests

GET https://{endpoint}/v2/aad/alarm

Example Responses

Status code: 200

{
  "ddos" : "0",
  "blackhole" : "1",
  "topic_name" : "test",
  "topic_urn" : "urn:smn:cn-north-4:4229e3e5bxxxxb208b971f2e0e0c:test"
}

Status Codes

Status Code

Description

200

This API is used to query the response to alarm settings.

400

Error response

Error Codes

See Error Codes.