ListEnvironmentAlertRules - Managed Service for Prometheus

Queries the alert groups of an environment instance.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
arms:ListEnvironmentAlertRules	none	*Environment `acs:arms:{#regionId}:{#accountId}:environment/{#environmentId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
EnvironmentId	string	Yes	The environment ID.	env-xxx
RegionId	string	No	The region ID.	cn-hangzhou
AddonName	string	No	The name of the add-on. You must specify AddonName or Scene.	mysql
Scene	string	No	The scenario of the add-on. You must specify AddonName or Scene.	database

Response parameters

Parameter	Type	Description	Example
	object	response
RequestId	string	The request ID.	4C518054-852F-4023-ABC1-4AF95FF7****
Code	integer	The status code. The status code 200 indicates that the request was successful. Other status codes indicate that the request failed.	200
Message	string	The returned message.	message
Success	boolean	Indicates whether the request was successful. Valid values: true false	true
Data	object	The struct returned.
Groups	array	The queried alert groups.
groups	string	The alert group.	mysql-CS-MySQLdAlerts
Rules	array<object>	The queried rules.
rules	object	The rule.
AlertId	long	The ID of the alert rule.	9502571
Name	string	The name of the alert rule.	mysql-CS-MySQLInnoDBLogWaits_lu
Total	long	The total number of entries returned.	26

Examples

Sample success responses

JSONformat

{
  "RequestId": "4C518054-852F-4023-ABC1-4AF95FF7****",
  "Code": 200,
  "Message": "message",
  "Success": true,
  "Data": {
    "Groups": [
      "mysql-CS-MySQLdAlerts"
    ],
    "Rules": [
      {
        "AlertId": 9502571,
        "Name": "mysql-CS-MySQLInnoDBLogWaits_lu"
      }
    ],
    "Total": 26
  }
}

Error codes

For a list of error codes, visit the Service error codes.