1. 接口描述
接口请求域名： tdmq.tencentcloudapi.com 。
创建 RabbitMQ 托管版实例
默认接口请求频率限制：1次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：CreateRabbitMQVipInstance。 |
| Version | 是 | String | 公共参数，本接口取值：2020-02-17。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| ZoneIds.N | 是 | Array of Integer | 可用区 示例值：[100003,100004] |
| VpcId | 是 | String | 私有网络ID，形如 vpc-xxx。有效的 VpcId 可通过登录私有网络控制台查询；也可以调用接口 DescribeVpcEx，从接口返回中的 unVpcId 字段获取。若在创建子机时 VpcId 与 SubnetId 同时传入 DEFAULT，则强制使用默认 vpc 网络。 示例值：vpc-5ghsr4p9 |
| SubnetId | 是 | String | 私有网络子网 ID，形如 subnet-xxx。有效的私有网络子网 ID 可通过登录子网控制台查询；也可以调用接口 DescribeSubnets，从接口返回中的 unSubnetId 字段获取。若在创建子机时 SubnetId 与 VpcId 同时传入 DEFAULT，则强制使用默认 vpc 网络。 示例值：subnet-67y9wil4 |
| ClusterName | 是 | String | 集群名称 示例值：prod_rabbitmq |
| NodeSpec | 否 | String | 集群的节点规格，需要输入对应的规格标识： 2C8G：rabbit-vip-basic-2c8g 4C16G：rabbit-vip-basic-4c16g 8C32G：rabbit-vip-basic-8c32g 16C32G：rabbit-vip-basic-4 16C64G：rabbit-vip-basic-16c64g 2C4G：rabbit-vip-basic-5 4C8G：rabbit-vip-basic-1 8C16G（已售罄）：rabbit-vip-basic-2 不传默认为 4C8G：rabbit-vip-basic-1 示例值：rabbit-vip-basic-1 |
| NodeNum | 否 | Integer | 节点数量,多可用区最少为3节点。不传默认单可用区为1,多可用区为3 示例值：1 |
| StorageSize | 否 | Integer | 单节点存储规格,不传默认为200G 示例值：200 |
| EnableCreateDefaultHaMirrorQueue | 否 | Boolean | 是否开启默认镜像队列，true 表示为开启，false 表示为不开启。不传默认为 false 示例值：false |
| AutoRenewFlag | 否 | Boolean | 仅预付费集群（PayMode 参数为 1 时）使用该参数，表示是否自动续费，true 表示打开自动续费。不传默认为 true 示例值：true |
| TimeSpan | 否 | Integer | 购买时长,不传默认为1(月) 示例值：1 |
| PayMode | 否 | Integer | 付费方式，0 为后付费，即按量计费；1 为预付费，即包年包月。默认包年包月 示例值：1 |
| ClusterVersion | 否 | String | 集群版本，不传默认为 3.8.30，可选值为 3.8.30 和 3.11.8 示例值：3.8.30 |
| IsIntl | 否 | Boolean | 是否国际站请求，默认 false 示例值：false |
| ResourceTags.N | 否 | Array of Tag | 资源标签列表 示例值：[{"tagKey":"业务","tagValue":"num77083"}] |
| Bandwidth | 否 | Integer | 公网带宽大小，单位 Mbps 示例值：5 |
| EnablePublicAccess | 否 | Boolean | 是否打开公网接入，不传默认为false 示例值：false |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TranId | String | 订单号 ID 示例值：20230110002025620411234 |
| InstanceId | String | 实例 ID 示例值：amqp-aegnagjg |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建 RabbitMQ 托管版实例
创建 RabbitMQ 托管版实例
输入示例
POST / HTTP/1.1
Host: tdmq.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateRabbitMQVipInstance
<公共请求参数>
{
"ZoneIds": [
190001
],
"NodeSpec": "rabbit-vip-basic-2",
"NodeNum": 1,
"StorageSize": 100,
"VpcId": "vpc-5ghsr4p9",
"SubnetId": "subnet-67y9wil4",
"ClusterName": "ApiCreate",
"EnableCreateDefaultHaMirrorQueue": false
}输出示例
{
"Response": {
"RequestId": "a8f28d5e-a7e2-4b0b-afa0-2fba09c077a0",
"TranId": "20230110002025620411234",
"InstanceId": "amqp-jero744g"
}
}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 | 内部错误。 |
| InvalidParameter | 参数错误。 |
