Help Center/ Workspace/ API Reference/ Workspace APIs/ Alarm/ Querying Alarm Statistics
Updated on 2026-02-10 GMT+08:00
View PDF
Share

Querying Alarm Statistics

Function

Number of alarms at each severity.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

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, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    workspace:statistics:getAlarm

    Read

    -

    -

    -

    ces:alarmHistory:list

URI

GET /v2/{project_id}/statistics/alarms

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

critical_count

Integer

Total number of critical alarm records.

major_count

Integer

Total number of major alarm records.

minor_count

Integer

Total number of minor alarm records.

info_count

Integer

Total number of warning alarm records.

total

Integer

Total number of alarm records.

Status code: 400

Table 3 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 401

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Requests

None

Example Responses

Status code: 200

Succeeded.

{
  "critical_count" : 100,
  "major_count" : 100,
  "minor_count" : 100,
  "info_count" : 100,
  "total" : 100
}

Status Codes

Status Code

Description

200

Succeeded.

400

Invalid request from the client.

401

Authentication failed.

500

Internal error.

Error Codes

See Error Codes.

Parent topic: Alarm