Queries all ApsaraMQ for RocketMQ instances in a specific region.
Operation description
Debugging
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:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resourcesis 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:ListInstances | list |
|
| none |
Request syntax
GET /instances HTTP/1.1
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| filter | string | No | The filter condition that is used to query instances. If you do not configure this parameter, all instances are queried. | rmq-cn-7e22ody**** |
| pageNumber | integer | No | The page number. Valid values: 1 to 100000000. If you set this parameter to a value smaller than 1, the system uses 1 as the value. If you set this parameter to a value greater than 100000000, the system uses 100000000 as the value. | 1 |
| pageSize | integer | No | The number of entries per page. Value values: 10 to 200. If you set this parameter to a value smaller than 10, the system uses 10 as the value. If you set this parameter to a value greater than 200, the system uses 200 as the value. | 10 |
| resourceGroupId | string | No | The ID of the resource group to which the instance belongs. | rg-acfmx7caj****** |
| tags | string | No | The tags that are used to filter instances. | [{"key": "rmq-test", "value": "test"}] |
| seriesCodes | array | No | The primary edition of the instance. Valid values:
| |
| string | No | The primary edition of the instance. | standard |
Response parameters
Examples
Sample success responses
JSONformat
{
"requestId": "84445A20-2B50-5306-A3C0-AF99FC1833C6",
"success": true,
"data": {
"pageNumber": 1,
"pageSize": 10,
"totalCount": 100,
"list": [
{
"regionId": "cn-hangzhou",
"instanceId": "rmq-cn-7e22ody****",
"instanceName": "test instance",
"status": "RUNNING",
"startTime": "2022-08-01 00:00:00",
"expireTime": "2022-09-01 00:00:00",
"releaseTime": "2022-09-07 00:00:00",
"userId": "6W0xz2uPfiwp****",
"commodityCode": "ons_rmqsub_public_cn",
"serviceCode": "rmq",
"seriesCode": "standard",
"subSeriesCode": "cluster_ha",
"paymentType": "Subscription",
"remark": "This is remark for instance.",
"topicCount": 20,
"groupCount": 10,
"createTime": "2022-08-01 00:00:00",
"updateTime": "2022-08-02 00:00:00",
"resourceGroupId": "rg-acfmx7caj******",
"tags": [
{
"key": "key",
"value": "value"
}
],
"productInfo": {
"traceOn": true
}
}
]
},
"code": "MissingPageNumber",
"message": "Parameter pageNumber is mandatory for this action .",
"httpStatusCode": 400,
"dynamicCode": "PageNumber",
"dynamicMessage": "pageNumber"
}Error codes
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2024-05-31 | The internal configuration of the API is changed, but the call is not affected | View Change Details |
| 2023-10-09 | The response structure of the API has changed | View Change Details |
| 2023-08-02 | The request parameters of the API has changed. The response structure of the API has changed | View Change Details |
| 2023-05-08 | The internal configuration of the API is changed, but the call is not affected | View Change Details |
| 2023-03-14 | The internal configuration of the API is changed, but the call is not affected | View Change Details |