Querying the Automatic Alarm Configuration of the Current User

Function

This API is used to query the automatic alarm configuration of the current user.

Before calling this API, learn how to authenticate it.
Before calling this API, learn about request header parameters.

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 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
rds:instance:listAll	read	-	-	rds:instance:list	-

URI

URI format
GET /v3/{project_id}/auto-ces-alarm

Parameter description

**Table 1** Parameters
Parameter	Mandatory	Description
project_id	Yes	Definition Project ID of a tenant in a region. To obtain the value, see Obtaining a Project ID. Constraints The value cannot be empty. Range N/A Default Value N/A

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
engine	No	String	Definition DB engine. Constraints N/A Range mysql postgresql sqlserver Default Value N/A

Request

None

Example Request

Query the automatic alarms of the current user.

GET https://{Endpoint}/v3/54623db08b174c858ba779d2aa7923a3/auto-ces-alram

Response

Normal response

**Table 3** Parameters
Parameter	Type	Description
entities	Array of objects	Definition List of automatic alarms. For details, see Table 4.
count	Integer	Definition Total number. Range N/A

**Table 4** entities element structure description
Parameter	Type	Description
id	String	Definition Unique ID of an alarm record. Range N/A
domain_id	String	Definition Tenant ID. Range N/A
domain_name	String	Definition Tenant name. Range N/A
user_id	String	Definition User ID. Range N/A
user_name	String	Definition Username. Range N/A
project_id	String	Definition Project ID. Range N/A
project_name	String	Definition Project name. Range N/A
engine_name	String	Definition DB engine name. Range N/A
new_instance_default	Boolean	Definition Whether automatic alarm reporting is enabled for new instances by default. Range N/A
switch_status	String	Definition Automatic alarm reporting status switch. Range N/A
alarm_id	String	Definition Unique ID of an alarm rule. Range N/A
topic_urn	String	Definition Topic URN. Range N/A
created_at	String	Definition Timestamp when the record was created. Range N/A
updated_at	String	Definition Timestamp when the record was last updated. Range N/A

Example normal response

{
  "entities": [
    {
      "id": "cd8fc267492d4efab6a62501d6acf5e1",
      "domain_id": "05491c53e680d4e80f60c007evd35fc0",
      "domain_name": "account_name",
      "project_id": "54623db08b174c858ba77002aa7923a3",
      "project_name": "project_name",
      "engine_name": "mysql",
      "new_instance_default": true,
      "switch_status": "closed",
      "alarm_id": "al16908078013717jEgojzo8",
      "topic_urn": "urn:smn:xxx:54623db08b174c858ba77002aa7923a3:AUTO_ALARM_NOTIFY_TOPIC_MYSQL_mysql_54623db08b174c858ba77002aa7923a3",
      "created_at": 1683339579161,
      "updated_at": 1760001523537
    }
  ],
  "count": 1
}