ListInstanceInspectionResources - ApsaraMQ for RocketMQ - Alibaba Cloud Documentation Center

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

rocketmq:ListInstanceInspectionResources

list

*Instance

acs:rocketmq:{#regionId}:{#accountId}:instance/{#instanceId}

None

Request syntax

GET /api/v1/monitoring/instance-inspections/{instanceId}/resources HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
instanceId	string	Yes	The ID of the associated instance. Wildcards are not allowed.	rmq-cn-example

Request parameters

Parameter	Type	Required	Description	Example
regionId	string	Yes	The region ID.	cn-hangzhou
templateCode	string	Yes	The code of the inspection item.	rmq.consumer-health
runId	string	No	Optional. If you specify this parameter, only the historical resource snapshot of the specified run is queried. If the snapshot is not generated, a 409 error is returned.	inspection-run-001
maxResults	integer	No	The maximum number of entries to return on each page. Default value: 20. Valid values: 1 to 100.	20
nextToken	string	No	The pagination token returned from the previous request. Do not specify this parameter for the first request.	eyJvZmZzZXQiOjIwfQ

Response elements

Element	Type	Description	Example
	object
maxResults	integer	The maximum number of entries per page that takes effect in the current request. This is not the actual number of returned entries.	20
data	array<object>	The resources returned on the current page. If runId is specified, historical snapshots are returned.	[]
	object
type	string	The type of the resource.	ConsumerGroup
id	string	The ID of the resource.	orders-g1
name	string	The display name of the resource. This parameter is optional.	Order instance
result	string	The inspection result. Valid values: info and risk. If the inspection is not completed or fails, this parameter is left empty. Valid values: info risk	Risk
summary	string	The summary of the inspection result for the resource. This parameter may not be returned for the current resource list.	Consumption delay exceeds the threshold
total	integer	The total number of resources.	5
nextToken	string	The pagination token for the next page. If this is the last page, this parameter is left empty.	eyJvZmZzZXQiOjIwfQ

Examples

Success response

JSON format

{
  "maxResults": 20,
  "data": [
    {
      "type": "ConsumerGroup",
      "id": "orders-g1",
      "name": "Order instance",
      "result": "Risk",
      "summary": "Consumption delay exceeds the threshold"
    }
  ],
  "total": 5,
  "nextToken": "eyJvZmZzZXQiOjIwfQ"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.