Setting Instance Alarm Configurations (To Be Brought Offline)

Function

This API is used to set instance alarm configurations.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition: Project ID. You can obtain the value by calling the IAM API for querying the project list of a specified IAM user. Constraints N/A Range: The value is subject to the return value of the IAM service interface. The value contains 32 to 64 characters. Default Value: N/A
instance_id	Yes	String	Definition: Instance ID. The value can be obtained from the ID field of the API for querying the instance list. Constraints N/A Range: The value is subject to the value of the API for querying the instance list. The value contains 32 to 64 characters. Default Value: N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition: User token. The token can be queried by calling the IAM API. (The token is the value of X-Subject-Token in the response header.) Restrictions: N/A Range: Used by the IAM service to query the user token. Default Value: N/A

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
alarm_cpu	Yes	Integer	Specifies the CPU alarm threshold.
alarm_disk	Yes	Integer	Specifies the disk alarm threshold.
alarm_memory	Yes	Integer	Specifies the memory alarm threshold.
alarm_num	Yes	Integer	Daily alarms
alarm_risk	No	Array of strings	Alarm severity. The default value is empty. high: high medium: medium low: low
alarm_switch	Yes	String	Notification switch ON: enabled OFF: disabled
alarm_topic_urn	No	String	Notification topic URN, which is obtained by calling the SMN API. This field is mandatory when alarm_switch is set to ON.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
status	String	Status. success: successful fail: failed

Status code: 400

**Table 5** 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 Codes
error_msg	String	Error message.

**Table 6** DbssErrorDetail
Parameter	Type	Description
error_code	String	Error Codes
error_msg	String	PDP5 error information

Status code: 401

**Table 7** 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 Codes
error_msg	String	Error message.

**Table 8** DbssErrorDetail
Parameter	Type	Description
error_code	String	Error Codes
error_msg	String	PDP5 error information

Status code: 403

**Table 9** 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 Codes
error_msg	String	Error message.

**Table 10** DbssErrorDetail
Parameter	Type	Description
error_code	String	Error Codes
error_msg	String	PDP5 error information

Status code: 500

**Table 11** 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 Codes
error_msg	String	Error message.

**Table 12** DbssErrorDetail
Parameter	Type	Description
error_code	String	Error Codes
error_msg	String	PDP5 error information

Example Requests

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

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