1. 接口描述
接口请求域名： tdmq.tencentcloudapi.com 。
创建RocketMQ专享实例
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：CreateRocketMQVipInstance。 |
| Version | 是 | String | 公共参数，本接口取值：2020-02-17。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| Name | 是 | String | 实例名称 |
| Spec | 是 | String | 集群规格，支持规格有 1.通用型:rocket-vip-basic-0; 2.基础型:rocket-vip-basic-1; 3.标准型:rocket-vip-basic-2; 4.高阶Ⅰ型:rocket-vip-basic-3; 5.高阶Ⅱ型:rocket-vip-basic-4 示例值：rocket-vip-basic-1 |
| NodeCount | 是 | Integer | 节点数量，最小2，最大20 |
| StorageSize | 是 | Integer | 单节点存储空间，GB为单位，最低200GB |
| ZoneIds.N | 是 | Array of String | 节点部署的区域ID列表，如广州一区，则是100001，具体可查询腾讯云官网 |
| VpcInfo | 是 | VpcInfo | VPC信息 |
| TimeSpan | 是 | Integer | 购买时长，月为单位 |
| SupportsMigrateToCloud | 否 | Boolean | 是否用于迁移上云，默认为false 示例值：false |
| EnablePublic | 否 | Boolean | 是否开启公网 示例值：false |
| Bandwidth | 否 | Integer | 公网带宽，在开启公网情况下为必传字段 示例值：1 |
| IpRules.N | 否 | Array of PublicAccessRule | 公网白名单 |
| Tags.N | 否 | Array of Tag | 标签 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ClusterId | String | 集群ID |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 购买RocketMQ专享实例
购买RocketMQ专享实例
输入示例
POST / HTTP/1.1
Host: tdmq.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateRocketMQVipInstance
<公共请求参数>
{
"Name": "abc",
"Spec": "rocket-vip-basic-1",
"NodeCount": 1,
"StorageSize": 0,
"ZoneIds": [
"100001"
],
"VpcInfo": {
"VpcId": "abc",
"SubnetId": "abc"
},
"TimeSpan": 1
}输出示例
{
"Response": {
"ClusterId": "rocketmq-xxxx",
"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.CallTrade | 调用交易服务发生异常。 |
