Obtaining Instance Alarm Configurations

Function

This API is used to obtain instance alarm configurations.

URI

GET /v1/{project_id}/{instance_id}/audit/alarm/topic

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.
instance_id	Yes	String	Instance ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. You can obtain it by calling the IAM API. The value of X-Subject-Token in the response header is the user token.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
alarm_cpu	String	Specifies the CPU alarm threshold.
alarm_disk	String	Specifies the disk alarm threshold.
alarm_memory	String	Specifies the memory alarm threshold.
alarm_num	String	Daily alarms
alarm_risk	Array of strings	Alarm severity. The options are as follows: high medium low
alarm_switch	String	Notifications. The value can be: ON OFF
alarm_topic_urn	String	URN of the notification topic. You can call the SMN API to obtain the URN.
smn_effective	Boolean	Specifies whether SMN subscription is supported. The options are as follows: true: supported false: not supported

Status code: 400

**Table 4** Response body parameters
Parameter	Type	Description
details	Array of DbssErrorDetail objects	PDP5 authentication exception information
encoded_authorization_message	String	PDP5 authentication exception information
error_code	String	Error code.
error_msg	String	Error message

**Table 5** DbssErrorDetail
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	PDP5 error information

Status code: 401

**Table 6** Response body parameters
Parameter	Type	Description
details	Array of DbssErrorDetail objects	PDP5 authentication exception information
encoded_authorization_message	String	PDP5 authentication exception information
error_code	String	Error code.
error_msg	String	Error message

**Table 7** DbssErrorDetail
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	PDP5 error information

Status code: 403

**Table 8** Response body parameters
Parameter	Type	Description
details	Array of DbssErrorDetail objects	PDP5 authentication exception information
encoded_authorization_message	String	PDP5 authentication exception information
error_code	String	Error code.
error_msg	String	Error message

**Table 9** DbssErrorDetail
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	PDP5 error information

Status code: 500

**Table 10** Response body parameters
Parameter	Type	Description
details	Array of DbssErrorDetail objects	PDP5 authentication exception information
encoded_authorization_message	String	PDP5 authentication exception information
error_code	String	Error code.
error_msg	String	Error message

**Table 11** DbssErrorDetail
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	PDP5 error information

Example Requests

/v1/{project_id}/{instance_id}/audit/alarm/topic

Example Responses

Status code: 200

{
  "alarm_cpu" : 80,
  "alarm_disk" : 80,
  "alarm_memory" : 80,
  "alarm_num" : 10,
  "alarm_risk" : [ "high", "low" ],
  "alarm_switch" : "OFF",
  "alarm_topic_urn" : "urn:smn:cn-north-7:b9351f98c724428xxxxxxxxx:DBSS-Message",
  "smn_effective" : false
}