获取某个指定实例的详细信息。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
rocketmq:GetInstance |
get |
*Instance
|
无 | 无 |
请求语法
GET /instances/{instanceId} HTTP/1.1请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| instanceId |
string |
是 |
待查询实例的 ID。 |
rmq-cn-7e22ody**** |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
返回数据。 |
||
| requestId |
string |
请求 ID，每个请求的 ID 都是唯一的，可用于排查和定位问题。 |
05AB7FBD-F1D3-5D87-BF78-BD782249**** |
| success |
boolean |
执行结果是否成功。 |
true |
| data |
object |
返回结果。 |
|
| regionId |
string |
实例所属的地域 ID。 |
cn-hangzhou |
| instanceId |
string |
实例 ID。 |
rmq-cn-7e22ody**** |
| instanceName |
string |
实例名称。 |
test instance |
| status |
string |
实例状态。 参数取值如下：
枚举值：
|
RUNNING |
| startTime |
string |
实例的启动时间。 |
2022-08-01 00:00:00 |
| expireTime |
string |
实例的到期时间。 |
2022-09-01 00:00:00 |
| releaseTime |
string |
实例的释放时间。 |
2022-09-07 00:00:00 |
| userId |
string |
实例所属的用户 ID。 |
111111111111111 |
| bid |
string |
商品的售卖渠道 BID。 |
26842 |
| commodityCode |
string |
消息队列 RocketMQ 5.x 系列实例的商品代号类似于 ons_rmqsub_public_cn。 |
ons_rmqsub_public_cn |
| serviceCode |
string |
实例所属的服务编码。消息队列 RocketMQ 版的服务编码为 rmq。 |
rmq |
| seriesCode |
string |
实例的主系列编码。主系列间的具体差异，请参见产品选型。 参数取值如下：
枚举值：
|
standard |
| subSeriesCode |
string |
实例的子系列编码。子系列间的具体差异，请参见产品选型。 参数取值如下：
枚举值：
|
cluster_ha |
| paymentType |
string |
实例的付费类型。 参数取值如下：
枚举值：
|
Subscription |
| remark |
string |
实例的备注信息。 |
This is remark for instance. |
| networkInfo |
object |
网络信息。 |
|
| vpcInfo |
object |
专有网络信息。 |
|
| vpcId |
string |
实例所关联的专有网络的 ID。 |
vpc-uf6of9452b2pba82c**** |
vSwitchId
deprecated
|
string |
实例所关联的交换机 ID。 重要 该字段不推荐使用，请使用 vSwitches 字段。此外，为了兼容，该字段目前只返回一个交换机。 |
vsw-uf6gwtbn6etadpvz7**** |
| vSwitches |
array<object> |
交换机列表 |
|
|
object |
|||
| vSwitchId |
string |
交换机 ID |
vsw-uf6gwtbn6etadpvz7**** |
| zoneId |
string |
可用区 ID |
cn-hangzhou |
| securityGroupIds |
string |
安全组 ID。 |
sg-hp35r2hc3a3sv8q2sb16 |
| endpoints |
array<object> |
接入点信息。 |
|
|
object |
接入点信息。 |
||
| endpointType |
string |
表示实例的接入点类型。 枚举值：
|
TCP_INTERNET |
| endpointUrl |
string |
实例的接入点。 |
rmq-cn-c4d2tbk****-vpc.cn-hangzhou.rmq.aliyuncs.com:8080 |
| ipWhitelist |
array |
公网访问 IP 白名单。仅公网接入点支持配置 IP 白名单，VPC 接入点暂不支持。
该字段不再推荐使用，请使用 internetInfo.ipWhitelist 字段。 |
192.168.x.x/24 |
|
string |
公网访问 IP 白名单。 |
192.168.x.x/24 |
|
| internetInfo |
object |
实例公网信息。 |
|
| internetSpec |
string |
是否开通公网访问。 参数取值如下：
实例默认支持 VPC 访问方式，若开启公网访问，消息队列 RocketMQ 版会收取公网下行带宽费用。具体计费信息，请参见公网访问费用。 枚举值：
|
enable |
| flowOutType |
string |
公网计费类型。 参数取值如下：
枚举值：
|
payByBandwidth |
| flowOutBandwidth |
integer |
公网带宽规格。单位：1 Mb/s。 |
1 |
| ipWhitelist |
array |
公网访问 IP 白名单列表。
|
|
|
string |
公网访问 IP 白名单。 |
192.168.x.x/24 |
|
| accountInfo |
object |
账号信息。 |
|
| username |
string |
实例的用户名。使用公网访问时，SDK 代码中需要配置实例的用户名和密码，进行身份验证。 |
6W0xz2uPfiwp**** |
| instanceQuotas |
array<object> |
容量信息。 |
|
|
object |
容量信息。 |
||
| quotaName |
string |
实例的配额名称。 参数取值如下：
枚举值：
|
TOPIC_COUNT |
| usedCount |
number |
已使用量。单位：个。 |
10 |
| freeCount |
number |
免费额度。单位：个。 |
20 |
| totalCount |
number |
总配额。单位：个。 |
100 |
| createTime |
string |
实例的创建时间。 |
2022-08-01 00:00:00 |
| updateTime |
string |
实例最后的修改时间。 |
2022-08-02 00:00:00 |
extConfig
deprecated
|
object |
扩展配置。该字段不再推荐使用，请使用 productInfo、internetInfo、aclInfo 等字段替代。 |
|
| aclType |
string |
实例的鉴权类型。 参数取值如下：
枚举值：
|
default |
| sendReceiveRatio |
number |
消息发送和接收的比例。 |
0.5 |
| autoScaling |
boolean |
是否开启规格外突发弹性能力。 参数取值如下：
仅当 supportAutoScaling 参数值为 enable，即实例支持开启弹性能力，该参数才有效。 枚举值：
|
true |
| messageRetentionTime |
integer |
消息保存时长。单位：小时。 取值范围，请参见使用限制>资源配额>消息保存时长的限制值。 消息队列 RocketMQ 版的消息存储完全实现 Serverless 弹性，按照实际存储空间收取费用，您可以通过调整消息保存时长来控制消息的存储容量。更多信息，请参见存储费用。 |
72 |
| supportAutoScaling |
boolean |
实例是否支持开启规格外突发弹性能力。 参数取值如下：
开启弹性突发能力后，消息队列 RocketMQ 允许该实例在一定范围内超过基础规格限制的 TPS，且超过基础规格外的部分，需要收取额外的弹性规格费用。具体计费信息，请参见计算能力费用。 说明
仅部分规格的实例支持开启弹性突发规格能力，具体支持的实例，请参见实例规格。 枚举值：
|
true |
| internetSpec |
string |
是否开通公网访问。 参数取值如下：
实例默认支持 VPC 访问方式，若开启公网访问，消息队列 RocketMQ 版会收取公网下行带宽费用。具体计费信息，请参见公网访问费用。 枚举值：
|
enable |
| flowOutType |
string |
公网计费类型。 参数取值如下：
枚举值：
|
payByBandwidth |
| flowOutBandwidth |
integer |
公网带宽规格。单位：Mb/s。 |
10 |
| msgProcessSpec |
string |
消息收发计算规格。具体消息收发 TPS 上限，请参见实例规格。 |
rmq.s2.2xlarge |
| resourceGroupId |
string |
资源组 ID。 |
rg-acfm3tmjruyribi |
| productInfo |
object |
实例的扩展配置。 |
|
| msgProcessSpec |
string |
消息收发计算规格。具体消息收发 TPS 上限，请参见实例规格。 |
rmq.s2.2xlarge |
| sendReceiveRatio |
number |
消息发送和接收的比例。 |
0.5 |
| autoScaling |
boolean |
是否开启规格外突发弹性能力。 参数取值如下：
仅当 supportAutoScaling 参数值为 enable，即实例支持开启弹性能力，该参数才有效。 枚举值：
|
true |
| messageRetentionTime |
integer |
消息保存时长。单位：小时。 取值范围，请参见使用限制>资源配额>消息保存时长的限制值。 消息队列 RocketMQ 版的消息存储完全实现 Serverless 弹性，按照实际存储空间收取费用，您可以通过调整消息保存时长来控制消息的存储容量。更多信息，请参见存储费用。 |
72 |
| supportAutoScaling |
boolean |
是否支持开启规格外突发弹性能力。 参数取值如下：
开启弹性突发能力后，消息队列 RocketMQ 允许该实例在一定范围内超过基础规格限制的 TPS，且超过基础规格外的部分，需要收取额外的弹性规格费用。具体计费信息，请参见计算能力费用。 说明
仅部分规格的实例支持开启弹性突发规格能力，具体支持的实例，请参见实例规格。 枚举值：
|
true |
| traceOn |
boolean |
是否开启消息轨迹功能。
该参数仅对 Serverless 类型的实例生效，若开启消息轨迹功能，会产生相关的消息轨迹费用，具体计费信息，请参见 Serverless 计费说明。 对于按量付费和包年包月实例，该参数不生效，即不管参数是否开启，都默认支持消息轨迹功能。 |
true |
| storageEncryption |
boolean |
是否开启存储加密 |
false |
| storageSecretKey |
string |
存储加密密钥 Key |
xxxxx |
| capacityType |
string |
||
| provisionedCapacity |
integer |
||
| aclInfo |
object |
访问控制信息。 |
|
| aclTypes |
array |
实例的鉴权类型列表。 |
|
|
string |
实例的鉴权类型。 枚举值：
|
default |
|
| defaultVpcAuthFree |
boolean |
内网免身份识别开关。 枚举值：
|
true |
aclType
deprecated
|
string |
实例的鉴权类型。已废弃，推荐使用 aclTypes 字段 枚举值：
|
default |
| software |
object |
实例软件信息。 |
|
| softwareVersion |
string |
软件版本。 |
5.0-rmq-20230619-1 |
| maintainTime |
string |
升级时间段。 |
02:00-06:00 |
| upgradeMethod |
string |
升级方式。 参数取值如下
枚举值：
|
auto |
| topicCount |
integer |
主题数量。 |
10 |
| groupCount |
integer |
消费组数量。 |
10 |
| tags |
array<object> |
资源标签列表。 |
|
|
object |
资源标签。 |
||
| key |
string |
资源标签 key 值。 |
key |
| value |
string |
资源标签 value 值。 |
value |
| code |
string |
错误码。 |
MissingInstanceId |
| message |
string |
错误信息。 |
Parameter instanceId is mandatory for this action . |
| httpStatusCode |
integer |
HTTP 状态码。 |
400 |
| dynamicCode |
string |
动态错误码。 |
InstanceId |
| dynamicMessage |
string |
动态错误信息。 |
instanceId |
示例
正常返回示例
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",
"capacityType": "",
"provisionedCapacity": 0
},
"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"
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。