Queries the detailed information about an instance.
Operation description
Note
API operations provided by Alibaba Cloud are used to manage and query resources of Alibaba Cloud services. We recommend that you integrate these API operations only in management systems. Do not use these API operations in the core system of messaging services. Otherwise, system risks may occur.
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:GetInstance | get | *Instance acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId} |
| none |
Request syntax
GET /instances/{instanceId} HTTP/1.1
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| instanceId | string | Yes | The ID of the instance that you want to query. | rmq-cn-7e22ody**** |
Response parameters
Examples
Sample success responses
JSONformat
{
"requestId": "05AB7FBD-F1D3-5D87-BF78-BD782249****",
"success": true,
"data": {
"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": "111111111111111",
"bid": "26842",
"commodityCode": "ons_rmqsub_public_cn",
"serviceCode": "rmq",
"seriesCode": "standard",
"subSeriesCode": "cluster_ha",
"paymentType": "Subscription",
"remark": "This is remark for instance.",
"networkInfo": {
"vpcInfo": {
"vpcId": "vpc-uf6of9452b2pba82c****",
"vSwitchId": "vsw-uf6gwtbn6etadpvz7****",
"vSwitches": [
{
"vSwitchId": "vsw-uf6gwtbn6etadpvz7****",
"zoneId": "cn-hangzhou"
}
],
"securityGroupIds": "sg-hp35r2hc3a3sv8q2sb16"
},
"endpoints": [
{
"endpointType": "TCP_INTERNET",
"endpointUrl": "rmq-cn-c4d2tbk****-vpc.cn-hangzhou.rmq.aliyuncs.com:8080",
"ipWhitelist": "192.168.x.x/24"
}
],
"internetInfo": {
"internetSpec": "enable",
"flowOutType": "payByBandwidth",
"flowOutBandwidth": 1,
"ipWhitelist": [
"192.168.x.x/24"
]
}
},
"accountInfo": {
"username": "6W0xz2uPfiwp****"
},
"instanceQuotas": [
{
"quotaName": "TOPIC_COUNT",
"usedCount": 10,
"freeCount": 20,
"totalCount": 100
}
],
"createTime": "2022-08-01 00:00:00 ",
"updateTime": "2022-08-02 00:00:00 ",
"extConfig": {
"aclType": "default",
"sendReceiveRatio": 0.5,
"autoScaling": true,
"messageRetentionTime": 72,
"supportAutoScaling": true,
"internetSpec": "enable",
"flowOutType": "payByBandwidth",
"flowOutBandwidth": 10,
"msgProcessSpec": "rmq.s2.2xlarge"
},
"resourceGroupId": "rg-acfm3tmjruyribi",
"productInfo": {
"msgProcessSpec": "rmq.s2.2xlarge",
"sendReceiveRatio": 0.5,
"autoScaling": true,
"messageRetentionTime": 72,
"supportAutoScaling": true,
"traceOn": true,
"storageEncryption": false,
"storageSecretKey": "xxxxx"
},
"aclInfo": {
"aclTypes": [
"default"
],
"defaultVpcAuthFree": true,
"aclType": "default"
},
"software": {
"softwareVersion": "5.0-rmq-20230619-1",
"maintainTime": "02:00-06:00",
"upgradeMethod": "auto"
},
"topicCount": 10,
"groupCount": 10,
"tags": [
{
"key": "key",
"value": "value"
}
]
},
"code": "MissingInstanceId",
"message": "Parameter instanceId is mandatory for this action .",
"httpStatusCode": 400,
"dynamicCode": "InstanceId",
"dynamicMessage": "instanceId"
}Error codes
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2024-11-26 | The response structure of the API has changed | View Change Details |
| 2024-05-28 | The response structure of the API has changed | View Change Details |
| 2024-03-29 | The response structure of the API has changed | View Change Details |
| 2023-10-09 | The response structure of the API has changed | View Change Details |
| 2023-08-02 | The response structure of the API has changed | View Change Details |
| 2023-07-06 | The response structure of the API has changed | View Change Details |
| 2023-05-08 | The response structure of the API has changed | View Change Details |
| 2023-03-14 | The response structure of the API has changed | View Change Details |
| 2022-12-15 | The response structure of the API has changed | View Change Details |