1. 接口描述
接口请求域名: tdmq.tencentcloudapi.com 。
获取单个RabbitMQ专享实例信息
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeRabbitMQVipInstance。 |
Version | 是 | String | 公共参数,本接口取值:2020-02-17。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
ClusterId | 是 | String | 集群ID 示例值:amqp-xxxxx |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
ClusterInfo | RabbitMQClusterInfo | 集群信息 |
ClusterSpecInfo | RabbitMQClusterSpecInfo | 集群规格信息 |
ClusterNetInfo | RabbitMQClusterAccessInfo | 集群访问 注意:此字段可能返回 null,表示取不到有效值。 |
ClusterWhiteListInfo | RabbitMQClusterWhiteListInfo | 集群白名单 注意:此字段可能返回 null,表示取不到有效值。 |
VirtualHostQuota | VirtualHostQuota | vhost配额信息 |
ExchangeQuota | ExchangeQuota | exchange配额信息 |
QueueQuota | QueueQuota | queue配额信息 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取单个Amqp集群信息
-
输入示例
POST / HTTP/1.1
Host: tdmq.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeRabbitMQVipInstance
<公共请求参数>
{
"ClusterId": "amqp-dsadasd"
}
输出示例
{
"Response": {
"ClusterInfo": {
"ClusterId": "amqp-dsadasd",
"ClusterName": "abc",
"Region": "ap-guangzhou",
"CreateTime": 1,
"Remark": "abc",
"Vpcs": [
{
"VpcId": "abc",
"SubnetId": "abc",
"VpcEndpoint": "abc",
"VpcDataStreamEndpointStatus": "1"
}
],
"ZoneIds": [
100001
],
"VirtualHostNumber": 10,
"QueueNumber": 10,
"MessagePublishRate": 10.1,
"MessageStackNumber": 10,
"ExpireTime": 20,
"ChannelNumber": 10,
"ConnectionNumber": 10,
"ConsumerNumber": 10,
"ExchangeNumber": 10,
"ExceptionInformation": "abc",
"ClusterStatus": 1,
"AutoRenewFlag": 1,
"MirrorQueuePolicyFlag": 1
},
"ClusterSpecInfo": {
"SpecName": "标准版",
"NodeCount": 1,
"MaxTps": 1,
"MaxBandWidth": 3,
"MaxStorage": 200,
"PublicNetworkTps": 1
},
"ClusterNetInfo": {
"WebConsoleDomainEndpoint": "1",
"PublicAccessEndpoint": "1.1.1.1",
"WebConsoleEndpoint": "1.1.1.1",
"WebConsoleUsername": "abc",
"WebConsolePassword": "abc",
"PublicAccessEndpointStatus": true,
"PublicControlConsoleSwitchStatus": true,
"VpcControlConsoleSwitchStatus": true,
"VpcWebConsoleEndpoint": "1.1.1.1",
"PublicWebConsoleSwitchStatus": "ON",
"VpcWebConsoleSwitchStatus": "ON",
"PublicDataStreamStatus": "ON",
"PrometheusEndpointInfo": {
"PrometheusEndpointStatus": "ON",
"VpcPrometheusEndpoint": [
"abc"
],
"NodePrometheusAddress": [
"abc"
],
"VpcEndpointInfo": {
"VpcId": "abc",
"SubnetId": "abc",
"VpcEndpoint": "abc",
"VpcDataStreamEndpointStatus": "abc"
}
}
},
"ClusterWhiteListInfo": {
"WhiteList": "1.1.1.1",
"PublicControlConsoleWhiteList": "1.1.1.1",
"PublicDataStreamWhiteList": "1.1.1.1",
"PublicControlConsoleWhiteListStatus": "ON",
"PublicDataStreamWhiteListStatus": "ON"
},
"VirtualHostQuota": {
"MaxVirtualHost": 10,
"UsedVirtualHost": 10
},
"ExchangeQuota": {
"MaxExchange": 10,
"UsedExchange": 10
},
"QueueQuota": {
"MaxQueue": 10,
"UsedQueue": 10
},
"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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
InternalError.IllegalMessage | 内部错误。 |
InvalidParameter | 参数错误。 |
ResourceNotFound | 资源不存在。 |
ResourceNotFound.Cluster | 集群不存在。 |