Obtaining Server Alarm Overview

Function

This API is used to query the server alarm overview.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account root user has all the permissions required to call all APIs, but IAM users must be assigned the following required identity policy-based permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
clouddc::listAlarmStat	List	-	-	-	ces:alarmHistory:list

URI

GET /v1/{project_id}/physicalservers/alarms/summary

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID. Constraints N/A Range Project ID of the account. Default Value N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition Requests for calling an API can be authenticated using a token. If token-based authentication is used, this parameter is mandatory and must be set to a user token. Constraints N/A Range N/A Default Value N/A

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
alarm_levels	Array of AlarmLevel objects	Definition Alarm severity, which can be 1 (critical), 2 (major), 3 (minor), or 4 (warning). Constraints N/A Range 1: Critical 2: Major 3: Minor 4: Warning Default Value N/A
alarm_devices	Array of AlarmDevice objects	Definition Information about devices for which an alarm was generated, including the device types and the number of alarms. Constraints N/A
alarm_hosts	Array of AlarmHost objects	Definition Top 10 faulty servers. Constraints N/A
alarm_groups	Array of AlarmGroup objects	Definition Alarm groups. Constraints N/A

**Table 4** AlarmLevel
Parameter	Type	Description
alarm_level	Integer	Definition Alarm severity. Constraints N/A Range N/A Default Value N/A
alarm_number	Integer	Definition The number of alarms. Constraints N/A Range N/A Default Value N/A

**Table 5** AlarmHost
Parameter	Type	Description
resource_name	String	Definition Resource name. Constraints N/A Range N/A Default Value N/A
resource_id	String	Definition Resource ID. Constraints N/A Range N/A Default Value N/A
alarm_infos	Array of AlarmInfo objects	Definition Alarm information. Constraints N/A

**Table 6** AlarmInfo
Parameter	Type	Description
alarm_device	String	Definition The devices for which an alarm was generated. Constraints N/A Range N/A Default Value N/A
alarm_number	Integer	Definition The number of alarms. Constraints N/A Range N/A Default Value N/A
alarm_duration	String	Definition Alarm duration. Constraints N/A Range N/A Default Value N/A

**Table 7** AlarmGroup
Parameter	Type	Description
label	String	Definition Tags. Constraints N/A Range N/A Default Value N/A
alarm_devices	Array of AlarmDevice objects	Definition The devices for which an alarm was generated. Constraints N/A
sns	Array of strings	Definition SN list. Constraints N/A

**Table 8** AlarmDevice
Parameter	Type	Description
alarm_device	String	Definition Hardware for which an alarm was generated. Constraints N/A Range N/A Default Value N/A
alarm_number	Integer	Definition The number of alarms. Constraints N/A Range N/A Default Value N/A

Status code: 400

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Definition Error code.
error_msg	String	Definition Error description.

Status code: 401

**Table 10** Response body parameters
Parameter	Type	Description
error_code	String	Definition Error code.
error_msg	String	Definition Error description.

Status code: 429

**Table 11** Response body parameters
Parameter	Type	Description
-	String	-

Status code: 500

**Table 12** Response body parameters
Parameter	Type	Description
error_code	String	Definition Error code.
error_msg	String	Definition Error description.

Example Requests

Obtaining server alarm overview

GET https://{endpoint}/v1/{project_id}/physicalservers/alarms/summary

Example Responses

Status code: 200

{
  "alarm_levels" : [ {
    "alarm_level" : 3,
    "alarm_number" : 90
  }, {
    "alarm_level" : 2,
    "alarm_number" : 104
  }, {
    "alarm_level" : 1,
    "alarm_number" : 15
  }, {
    "alarm_level" : 4,
    "alarm_number" : 60
  } ],
  "alarm_devices" : [ {
    "alarm_device" : "memory_health",
    "alarm_number" : 163
  }, {
    "alarm_device" : "cpu_health",
    "alarm_number" : 19
  }, {
    "alarm_device" : "fan_health",
    "alarm_number" : 6
  }, {
    "alarm_device" : "nic_health",
    "alarm_number" : 6
  }, {
    "alarm_device" : "disk_health",
    "alarm_number" : 2
  }, {
    "alarm_device" : "power_health",
    "alarm_number" : 0
  }, {
    "alarm_device" : "other_health",
    "alarm_number" : 73
  } ],
  "alarm_hosts" : [ {
    "resource_name" : "",
    "resource_id" : "01963d9c-dfca-72bc-8974-fae1f2c0700b",
    "alarm_infos" : [ {
      "alarm_device" : "alarm-eu43Rear",
      "alarm_duration" : 7161622903615878
    } ]
  } ],
  "alarm_groups" : [ {
    "label" : "Unknown",
    "alarm_devices" : [ {
      "alarm_device" : "power_health",
      "alarm_number" : 0
    }, {
      "alarm_device" : "nic_health",
      "alarm_number" : 6
    }, {
      "alarm_device" : "memory_health",
      "alarm_number" : 163
    }, {
      "alarm_device" : "fan_health",
      "alarm_number" : 6
    }, {
      "alarm_device" : "disk_health",
      "alarm_number" : 2
    }, {
      "alarm_device" : "cpu_health",
      "alarm_number" : 19
    }, {
      "alarm_device" : "other_health",
      "alarm_number" : 73
    } ],
    "sns" : [ "01963d9c-dfdf-7e66-a8cf-29ba55dcb4bd", "0197a5d0-0b9c-7564-a0ad-bf152d026a3c", "01963d9c-dfca-72bc-8974-fae1f2c0700b", "019661e2-5390-7aa5-91e8-5fc6841f6ed9", "01963d9c-dfd0-7a44-b42e-5270e52296b6" ]
  } ]
}