Help Center/ Database Security Service/ API Reference/ API/ Data Analytics/ Querying Audit Alarm Information
Updated on 2024-11-01 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying Audit Alarm Information

Function

This API is used to query audit alarm information.

Calling Method

For details, see Calling APIs.

URI

POST /v1/{project_id}/{instance_id}/audit/alarm-log

Table 1 URI parameter

Parameter

Mandatory

Parameter Type

Description

project_id

Yes

String

Project ID.

instance_id

Yes

String

Instance ID. You can obtain the value from the ID field in the API for querying the instance list.

Request Parameter

Table 2 Request header parameter

Parameter

Mandatory

Parameter Type

Description

X-Auth-Token

Yes

String

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.)
Table 3 Request body parameter

Parameter

Mandatory

Parameter Type

Description

time

Yes

time object

Time

risk

No

String

Risk severity

  • LOW
  • MEDIUM
  • HIGH

type

No

String

Alarm type

  • RISK_RULE: risk rule
  • RISK_CPU: The CPU usage exceeds the threshold.
  • RISK_MEMORY: The memory usage exceeds the threshold.
  • RISK_DISK: The disk usage exceeds the threshold.
  • RISK_DISK_CAPACITY: The disk capacity is less than six months.
  • RISK_BACKUP: Backup failed.
  • AUDIT_QPS_OVERFLOW: delay alarm when the traffic exceeds the threshold
  • RISK_AGENT: The agent is abnormal.
  • AUDIT_BACKUP_FAILED: Instances failed to be backed up (O&M)

status

No

String

Alarm confirmation status

  • DONE: confirmed
  • UNDO: unconfirmed

page

No

Integer

The page number.

size

No

Integer

Specifies the number of records on each page.
Table 4 Time

Parameter

Mandatory

Parameter Type

Description

time_range

No

String

Time range. This parameter cannot be used together with start_time and end_time. If they are used together, this parameter has a higher priority. The value can be: Enumerated values:

HALF_HOUR, HOUR, THREE_HOUR, TWELVE_HOUR, DAY, WEEK, MONTH;

start_time

No

String

Start time. This parameter must be used together with end_time. The format must be yyyy-MM-dd HH:mm:ss. Time when an action occurred, in UTC time.

end_time

No

String

End time. This parameter must be used together with start_time. The format must be yyyy-MM-dd HH:mm:ss. Time when an action occurred, in UTC time.

Response Parameters

Status code: 200

Table 5 Response body parameter

Parameter

Parameter Type

Description

total_num

Integer

Total number

alarm_log

Array of alarm_log objects

Alarms
Table 6 alarm_log

Parameter

Parameter Type

Description

id

String

Alarm ID

alarmLife

String

Alarm status.

  • ON
  • OFF

sendEmail

Boolean

Email notification

alarm_time

String

Alarm time

alarm_type

String

Alarm type

  • RISK_RULE: risk rule
  • RISK_CPU: The CPU usage exceeds the threshold.
  • RISK_MEMORY: The memory usage exceeds the threshold.
  • RISK_DISK: The disk usage exceeds the threshold.
  • RISK_DISK_CAPACITY: The disk capacity is less than six months.
  • RISK_BACKUP: Backup failed.
  • AUDIT_QPS_OVERFLOW: delay alarm when the traffic exceeds the threshold
  • RISK_AGENT: The agent is abnormal.
  • AUDIT_BACKUP_FAILED: Instances failed to be backed up (O&M)

alarm_fix_time

String

Indicates the alarm clearing time.

alarm_status

String

Alarm confirmation status

  • DONE: confirmed
  • UNDO: unacknowledged

alarm_risk

String

Alarm risk severity

  • LOW
  • MEDIUM
  • HIGH

alarm_description

String

Alarm description

Status code: 400

Table 7 Response body parameter

Parameter

Parameter Type

Description

error

Object

Error message.
Table 8 ErrorDetail

Parameter

Parameter Type

Description

error_code

String

Error code

error_msg

String

Error message

Status code: 403

Table 9 Response body parameter

Parameter

Parameter Type

Description

error

Object

Error message.
Table 10 ErrorDetail

Parameter

Parameter Type

Description

error_code

String

Error code

error_msg

String

Error message

Status code: 500

Table 11 Response body parameter

Parameter

Parameter Type

Description

error

Object

Error message.
Table 12 ErrorDetail

Parameter

Description

Description

error_code

String

Error code

error_msg

String

Error message

Example request

/v1/{project_id}/{instance_id}/audit/alarm-log

{
  "time" : {
    "time_range" : "DAY",
    "start_time" : null,
    "end_time" : null
  },
  "risk" : null,
  "type" : null,
  "status" : null,
  "page" : 1,
  "size" : 100
}

Example Response

Status code: 200

Succeeded

{
  "total_num" : 3,
  "alarm_log" : [ {
    "id" : "99AJFI8BZEbGVdGbOczC",
    "alarmLife" : "ON",
    "sendEmail" : true,
    "alarm_time" : "2024-04-25 06:55:00",
    "alarm_type" : "RISK_DISK",
    "alarm_fix_time" : null,
    "alarm_status" : "UNDO",
    "alarm_description" : "DISK USAGE 5%",
    "alarm_risk" : "HIGH"
  }, {
    "id" : "9tAJFI8BZEbGVdGbOcy4",
    "alarmLife" : "ON",
    "sendEmail" : true,
    "alarm_time" : "2024-04-25 06:55:00",
    "alarm_type" : "RISK_MEMORY",
    "alarm_fix_time" : null,
    "alarm_status" : "UNDO",
    "alarm_description" : "MEMORY USAGE 53.54%",
    "alarm_risk" : "HIGH"
  }, {
    "id" : "9dAJFI8BZEbGVdGbOcyq",
    "alarmLife" : "ON",
    "sendEmail" : true,
    "alarm_time" : "2024-04-25 06:55:00",
    "alarm_type" : "RISK_CPU",
    "alarm_fix_time" : null,
    "alarm_status" : "UNDO",
    "alarm_description" : "CPU USAGE 1.0%",
    "alarm_risk" : "HIGH"
  } ]
}

Status code: 400

Incorrect request parameter.

{
  "error" : {
    "error_code" : "DBSS.XXXX",
    "error_msg" : "XXX"
  }
}

Status code: 500

Internal server error.

{
  "error" : {
    "error_code" : "DBSS.XXXX",
    "error_msg" : "XXX"
  }
}

Status Code

Status Code

Description

200

Success

400

Incorrect request parameter.

403

Authentication failed.

500

Internal server error.

Error Codes

For details, see Error Codes.

Parent topic: Data Analytics