ListMetricMeta - ApsaraMQ for RocketMQ - Alibaba Cloud Documentation Center

This topic is generated by a machine translation engine without any human intervention. ALIBABA CLOUD DOES NOT GUARANTEE THE ACCURACY OF MACHINE TRANSLATED CONTENT. To request a human-translated version of this topic or provide feedback on this translation, please include it in the feedback form.

Query Monitoring Items List

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
rocketmq:ListMetricMeta	list	All Resources ``	none	none

Request syntax

GET /monitor/metrics/meta HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
pageNumber	integer	Yes	Page number, indicating which page of the results to return.	1
pageSize	integer	Yes	Page size, indicating the maximum number of results per page.	10

Response parameters

Parameter	Type	Description	Example
	object	Result<MyPage>
requestId	string	Request ID	8B459455-4A35-5796-BA9D-98EF1AB9A931
success	boolean	Whether the operation was successful	true
data	object	Return result
pageNumber	long	Current page number	1
pageSize	long	Page size	10
totalCount	long	Total record count	1
list	array<object>	Paged data
list	object	List of monitoring items.
metricName	string	Monitoring item name	SendMessageCountPerInstance
description	string	Monitoring item description	Using Serverless Devs to deploy the infrastructure of project:get-userinfo-v1-infrastructure-as-template-project
category	string	Monitoring item tag	Bug
code	string	Error code	Topic.NotFound
message	string	Error message	The topic already exists.
httpStatusCode	integer	HTTP status code	200
dynamicCode	string	Dynamic error code	xxx
dynamicMessage	string	The dynamic error message.	xxx

Examples

Sample success responses

JSONformat

{
  "requestId": "8B459455-4A35-5796-BA9D-98EF1AB9A931",
  "success": true,
  "data": {
    "pageNumber": 1,
    "pageSize": 10,
    "totalCount": 1,
    "list": [
      {
        "metricName": "SendMessageCountPerInstance",
        "description": "Using Serverless Devs to deploy the infrastructure of project:get-userinfo-v1-infrastructure-as-template-project",
        "category": "Bug"
      }
    ]
  },
  "code": "Topic.NotFound",
  "message": "The topic already exists.",
  "httpStatusCode": 200,
  "dynamicCode": "xxx",
  "dynamicMessage": "xxx"
}

Error codes

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