DescribeMetricRuleCount - Cloud Monitor - Alibaba Cloud Documentation Center

Queries the number of alert rules in each state.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

cms:DescribeMetricRuleCount

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Namespace	string	No	The namespace of the cloud service. For more information, see Appendix 1: Metrics.	acs_ecs_dashboard
MetricName	string	No	The metric name. For more information, see Appendix 1: Metrics.	cpu_total

Response elements

Element	Type	Description	Example
	object
Code	string	The responses code. Note The status code 200 indicates that the request was successful.	200
Message	string	The error message.	The Request is not authorization.
RequestId	string	The request ID.	FF38D33A-67C1-40EB-AB65-FAEE51EDB644
Success	boolean	Indicates whether the request was successful. Valid values: true false	true
MetricRuleCount	object	The number of alert rules in each state.
Ok	integer	The number of alert rules without active alerts.	40
Nodata	integer	The number of alert rules without data.	0
Disable	integer	The number of disabled alert rules.	0
Total	integer	The total number of alert rules.	45
Alarm	integer	The number of alert rules with active alerts.	5

Examples

Success response

JSON format

{
  "Code": "200",
  "Message": "The Request is not authorization.",
  "RequestId": "FF38D33A-67C1-40EB-AB65-FAEE51EDB644",
  "Success": true,
  "MetricRuleCount": {
    "Ok": 40,
    "Nodata": 0,
    "Disable": 0,
    "Total": 45,
    "Alarm": 5
  }
}

Error codes

HTTP status code	Error code	Error message
400	%s	%s
500	%s	%s
500	InternalError	The request processing has failed due to some unknown error.
402	LimitExceeded	The quota for this customer had been reached.
403	%s	%s
404	%s	%s
503	%s	%s
429	Throttli∂ngException	The request was denied due to request throttling.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.