使用 OnsInstanceBaseInfo 查询实例基本信息和收发消息的接入点。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | OnsInstanceBaseInfo |
系统规定参数。取值:OnsInstanceBaseInfo。 |
InstanceId | String | 是 | MQ_INST_138015630679****_BAAy1Hac |
需查询的实例 ID。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
InstanceBaseInfo | Struct |
实例信息对象。 |
|
Endpoints | Struct |
各个协议的接入点。 |
|
HttpInternalEndpoint | String | http://138015630679****.mqrest.cn-zhangjiakou-internal.aliyuncs.com |
HTTP 内网接入点。 |
HttpInternetEndpoint | String | http://138015630679****.mqrest.cn-zhangjiakou.aliyuncs.com |
HTTP 公网接入点。 |
HttpInternetSecureEndpoint | String | https://138015630679****.mqrest.cn-zhangjiakou.aliyuncs.com |
HTTPS 公网接入点。 |
TcpEndpoint | String | http://MQ_INST_138015630679****_BAAy1Hac.cn-zhangjiakou.mq-internal.aliyuncs.com:8080 |
TCP 协议接入点。 |
IndependentNaming | Boolean | true |
实例是否有命名空间。取值说明如下:
|
InstanceId | String | MQ_INST_138015630679****_BAAy1Hac |
实例 ID。 |
InstanceName | String | test |
实例名称。 长度限制为3 ~ 64 个字符,可以是中文、英文、数字、短划线(-)以及下划线(_)。 |
InstanceStatus | Integer | 5 |
实例状态。取值说明如下:
|
InstanceType | Integer | 2 |
实例类型。取值说明如下:
|
MaxTps | Long | 10000 |
消息收发 TPS 上限。取值如下: 5000、10000、20000、50000、100000、200000、300000、500000、800000、1000000。 详细的解释以购买页的说明为准。 说明 该参数仅适用于消息队列 RocketMQ 版企业铂金版实例。
|
ReleaseTime | Long | 1603555200000 |
铂金版实例过期时间。 |
Remark | String | test |
备注。 |
TopicCapacity | Integer | 50 |
该实例下允许创建的 Topic 数量上限。取值如下: 25、50、100、300、500。 说明 该参数仅适用于消息队列 RocketMQ 版企业铂金版实例。
|
RequestId | String | 6CC46974-65E8-4C20-AB07-D20D102E**** |
为公共参数,每个请求的 ID 都是唯一的。 |
示例
请求示例
http(s)://ons.cn-zhangjiakou.aliyuncs.com/?Action=OnsInstanceBaseInfo
&InstanceId=MQ_INST_138015630679****_BAAy1Hac
&<公共请求参数>
正常返回示例
XML
格式
<InstanceBaseInfoResponse>
<InstanceBaseInfo>
<InstanceName>test</InstanceName>
<MaxTps>10000</MaxTps>
<Endpoints>
<HttpInternalEndpoint>http://138015630679****.mqrest.cn-zhangjiakou-internal.aliyuncs.com</HttpInternalEndpoint>
<TcpEndpoint>http://MQ_INST_138015630679****_BAAy1Hac.cn-zhangjiakou.mq-internal.aliyuncs.com:8080</TcpEndpoint>
<HttpInternetEndpoint>http://138015630679****.mqrest.cn-zhangjiakou.aliyuncs.com</HttpInternetEndpoint>
<HttpInternetSecureEndpoint>https://138015630679****.mqrest.cn-zhangjiakou.aliyuncs.com</HttpInternetSecureEndpoint>
</Endpoints>
<TopicCapacity>50</TopicCapacity>
<InstanceId>MQ_INST_138015630679****_BAAy1Hac</InstanceId>
<ReleaseTime>1603555200000</ReleaseTime>
<InstanceStatus>5</InstanceStatus>
<IndependentNaming>true</IndependentNaming>
<InstanceType>2</InstanceType>
<Remark>onspre-cn-m7r1r5f****</Remark>
</InstanceBaseInfo>
<RequestId>6CC46974-65E8-4C20-AB07-D20D102E****</RequestId>
</InstanceBaseInfoResponse>
JSON
格式
{
"InstanceBaseInfo": {
"InstanceName": "test",
"MaxTps": 10000,
"Endpoints": {
"HttpInternalEndpoint": "http://138015630679****.mqrest.cn-zhangjiakou-internal.aliyuncs.com",
"TcpEndpoint": "http://MQ_INST_138015630679****_BAAy1Hac.cn-zhangjiakou.mq-internal.aliyuncs.com:8080",
"HttpInternetEndpoint": "http://138015630679****.mqrest.cn-zhangjiakou.aliyuncs.com",
"HttpInternetSecureEndpoint": "https://138015630679****.mqrest.cn-zhangjiakou.aliyuncs.com"
},
"TopicCapacity": 50,
"InstanceId": "MQ_INST_138015630679****_BAAy1Hac",
"ReleaseTime": 1603555200000,
"InstanceStatus": 5,
"IndependentNaming": true,
"InstanceType": 2,
"Remark": "onspre-cn-m7r1r5f****"
},
"RequestId": "6CC46974-65E8-4C20-AB07-D20D102E****"
}
错误码
访问错误中心查看更多错误码。
在文档使用中是否遇到以下问题
更多建议
匿名提交