获取某个指定实例的详细信息。
接口说明
注意 阿里云提供的 OpenAPI 属于管控类 API，用于管理和查询阿里云服务的相关资源。仅推荐在管控链路集成，消息收发的核心数据链路中严禁依赖 OpenAPI 实现，否则可能会导致链路产生风险。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| rocketmq:GetInstance | get | *Instance acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId} |
| 无 |
请求语法
GET /instances/{instanceId} HTTP/1.1
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| instanceId | string | 是 | 待查询实例的 ID。 | rmq-cn-7e22ody**** |
返回参数
示例
正常返回示例
JSON格式
{
"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"
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-11-26 | OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2024-05-28 | OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2024-03-29 | OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2023-10-09 | OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2023-08-02 | OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2023-07-06 | OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2023-05-08 | OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2023-03-14 | OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2022-12-15 | OpenAPI 返回结构发生变更 | 查看变更详情 |