1. 接口描述
接口请求域名: trabbit.tencentcloudapi.com 。
获取单个RabbitMQ专享实例信息
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeRabbitMQServerlessInstance。 |
Version | 是 | String | 公共参数,本接口取值:2023-04-18。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
InstanceId | 是 | String | 集群ID 示例值:amqp-slrlpeddnr |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
ClusterInfo | RabbitMQClusterInfo | 集群信息 |
ClusterSpecInfo | RabbitMQClusterSpecInfo | 集群规格信息 |
VirtualHostQuota | VirtualHostQuota | vhost配额信息 |
ExchangeQuota | ExchangeQuota | exchange配额信息 |
QueueQuota | QueueQuota | queue配额信息 |
ClusterNetInfo | RabbitMQServerlessAccessInfo | 网络信息 |
ClusterWhiteListInfo | RabbitMQServerlessWhiteListInfo | 公网白名单信息 |
UserQuota | UserQuota | user配额信息 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 实例详情示例
输入示例
POST / HTTP/1.1
Host: trabbit.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeRabbitMQServerlessInstance
<公共请求参数>
{
"InstanceId": "amqp-slnatby"
}
输出示例
{
"Response": {
"RequestId": "bae00352-45fb-46ea-8960-2c8ce102db5f",
"ClusterInfo": {
"InstanceType": 1,
"ClusterName": "devCluster",
"ClusterId": "amqp-slnatby",
"Region": "ap-guangzhou",
"CreateTime": 1737775135000,
"Remark": "",
"Vpcs": [
{
"VpcId": "vpc-test",
"SubnetId": "subnet-test",
"VpcEndpoint": "amqp://10.0.0.1:5672",
"VpcDataStreamEndpointStatus": "ON"
}
],
"ZoneIds": null,
"VirtualHostNumber": 2,
"QueueNumber": 11,
"ChannelNumber": 0,
"ConnectionNumber": 0,
"ConsumerNumber": 0,
"ExchangeNumber": 13,
"MessagePublishRate": 0,
"MessageConsumeRate": 0,
"MessageStackNumber": 19,
"ExpireTime": 1740453535000,
"ExceptionInformation": null,
"ClusterStatus": 1,
"AutoRenewFlag": 1,
"ClusterVersion": "0.1.0",
"PayMode": 0,
"MessageRetainTime": 72,
"MirrorQueuePolicyFlag": null
},
"ClusterNetInfo": {
"PublicDataStreamStatus": "OFF",
"PublicAccessEndpoint": null
},
"ClusterWhiteListInfo": {
"PublicDataStreamWhiteList": null,
"PublicDataStreamWhiteListStatus": "OFF"
},
"ClusterSpecInfo": {
"SpecName": "BASIC",
"MaxTps": 2000,
"MaxQueueNum": 100,
"MaxVhostNum": 250,
"MaxExchangeNum": 100,
"MaxConnNum": 2000,
"MaxUserNum": 20,
"MaxBandWidth": 0,
"PublicNetworkTps": 3
},
"VirtualHostQuota": {
"MaxVirtualHost": 250,
"UsedVirtualHost": 2
},
"ExchangeQuota": {
"MaxExchange": 100,
"UsedExchange": 13
},
"QueueQuota": {
"MaxQueue": 100,
"UsedQueue": 11
},
"UserQuota": {
"MaxUser": 20,
"UsedUser": 1
}
}
}
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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
AuthFailure | CAM签名/鉴权错误。 |
DryRunOperation | DryRun 操作,代表请求将会是成功的,只是多传了 DryRun 参数。 |
FailedOperation | 操作失败。 |
InternalError | 内部错误。 |
InvalidFilter | 无效的过滤器 |
InvalidParameter | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |
LimitExceeded | 超过配额限制。 |
MissingParameter | 缺少参数错误。 |
OperationDenied | 操作被拒绝。 |
RegionError | 地域错误 |
RequestLimitExceeded | 请求的次数超过了频率限制。 |
ResourceInUse | 资源被占用。 |
ResourceInsufficient | 资源不足。 |
ResourceNotFound | 资源不存在。 |
ResourceUnavailable | 资源不可用。 |
ResourcesSoldOut | 资源售罄。 |
UnauthorizedOperation | 未授权操作。 |
UnknownParameter | 未知参数错误。 |
UnsupportedOperation | 操作不支持。 |