1. 接口描述
接口请求域名: trocket.tencentcloudapi.com 。
查询实例信息
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeInstance。 |
Version | 是 | String | 公共参数,本接口取值:2023-03-08。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
InstanceId | 是 | String | 实例ID 示例值:rocketmq-xxxx |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
InstanceType | String | 实例类型, EXPERIMENT 体验版 BASIC 基础版 PRO 专业版 PLATINUM 铂金版 示例值:BASIC |
InstanceId | String | 实例ID |
InstanceName | String | 实例名称 |
TopicNum | Integer | 主题数量 |
TopicNumLimit | Integer | 实例最大主题数量 |
GroupNum | Integer | 消费组数量 |
GroupNumLimit | Integer | 实例最大消费组数量 |
MessageRetention | Integer | 消息保留时间,小时为单位 |
RetentionUpperLimit | Integer | 最大可调整消息保留时间,小时为单位 |
RetentionLowerLimit | Integer | 最小可调整消息保留时间,小时为单位 |
TpsLimit | Integer | TPS限流值 |
ScaledTpsLimit | Integer | 弹性TPS限流值 |
MaxMessageDelay | Integer | 延迟消息最长时间,小时为单位 |
CreatedTime | Integer | 创建时间,秒为单位 |
SendReceiveRatio | Float | 消息发送接收比例 |
TagList | Array of Tag | 标签 注意:此字段可能返回 null,表示取不到有效值。 |
EndpointList | Array of Endpoint | 接入点列表 注意:此字段可能返回 null,表示取不到有效值。 |
TopicQueueNumUpperLimit | Integer | 主题队列数上限 |
TopicQueueNumLowerLimit | Integer | 主题队列数下限 |
Remark | String | 备注信息 |
InstanceStatus | String | 实例状态 |
SkuCode | String | 实例规格 |
PayMode | String | 计费模式 |
ScaledTpsEnabled | Boolean | 是否开启弹性TPS 示例值:false |
RenewFlag | Integer | 是否自动续费 |
ExpiryTime | Integer | 到期时间 |
RoleNumLimit | Integer | 角色数量限制 |
AclEnabled | Boolean | 是否开启 ACL 注意:此字段可能返回 null,表示取不到有效值。 |
TopicNumLowerLimit | Integer | topic个数免费额度 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
TopicNumUpperLimit | Integer | 最大可设置的topic个数 注意:此字段可能返回 null,表示取不到有效值。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询实例
查询实例
输入示例
POST / HTTP/1.1
Host: trocket.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeInstance
<公共请求参数>
{
"InstanceId": "abc"
}
输出示例
{
"Response": {
"ScaledTpsEnabled": false,
"InstanceType": "abc",
"InstanceId": "abc",
"InstanceName": "abc",
"TopicNum": 0,
"TopicNumLimit": 0,
"GroupNum": 0,
"GroupNumLimit": 0,
"MessageRetention": 0,
"RetentionUpperLimit": 0,
"RetentionLowerLimit": 0,
"TpsLimit": 0,
"ScaledTpsLimit": 0,
"MaxMessageDelay": 0,
"CreatedTime": 0,
"SendReceiveRatio": 0,
"TagList": [
{
"TagKey": "abc",
"TagValue": "abc"
}
],
"EndpointList": [
{
"Type": "abc",
"Status": "abc",
"PayMode": "abc",
"EndpointUrl": "abc",
"VpcId": "abc",
"SubnetId": "abc",
"Bandwidth": 0,
"IpRules": [
{
"Ip": "abc",
"Allow": true,
"Remark": "abc"
}
]
}
],
"TopicQueueNumUpperLimit": 0,
"TopicQueueNumLowerLimit": 0,
"Remark": "abc",
"InstanceStatus": "abc",
"SkuCode": "abc",
"PayMode": "abc",
"RequestId": "abc"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
ResourceNotFound.Instance | 实例不存在。 |