消息队列 RocketMQ 版创建集群

1. 接口描述

接口请求域名： trocket.tencentcloudapi.com 。

创建 RocketMQ 5.x 集群

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：CreateInstance。
Version	是	String	公共参数，本接口取值：2023-03-08。
Region	是	String	公共参数，详见产品支持的地域列表。
InstanceType	是	String	实例类型，枚举值如下： - EXPERIMENT：体验版 - BASIC：基础版 - PRO：专业版 - PLATINUM：铂金版示例值：BASIC
Name	是	String	集群名称，不能为空， 3-64个字符，只能包含数字、字母、“-”和“_” 示例值：test_name
SkuCode	是	String	商品规格，从 DescribeProductSKUs 接口中的 ProductSKU 出参获得。示例值：basic_1k
Remark	否	String	备注信息示例值：测试集群
TagList.N	否	Array of Tag	标签列表
VpcList.N	否	Array of VpcInfo	集群绑定的VPC信息，必填
EnablePublic	否	Boolean	是否开启公网，默认值为false表示不开启示例值：true
BillingFlow	否	Boolean	公网是否按流量计费，默认值为false表示不按流量计费示例值：false
Bandwidth	否	Integer	公网带宽（单位：兆），默认值为0。如果开启公网，该字段必须为大于0的正整数示例值：2
IpRules.N	否	Array of IpRule	公网访问白名单，不填表示拒绝所有 IP 访问
MessageRetention	否	Integer	消息保留时长（单位：小时），取值范围参考 DescribeProductSKUs 接口中的 ProductSKU 出参： - 默认值：DefaultRetention 参数 - 最小值：RetentionLowerLimit 参数 - 最大值：RetentionUpperLimit 参数示例值：72
PayMode	否	Integer	付费模式（0: 后付费；1: 预付费），默认值为0 示例值：0
RenewFlag	否	Integer	预付费集群是否自动续费（0: 不自动续费；1: 自动续费），默认值为0 示例值：1
TimeSpan	否	Integer	预付费集群的购买时长（单位：月），取值范围为1～60，默认值为1 示例值：1
MaxTopicNum	否	Integer	最大可创建主题数，从 DescribeProductSKUs 接口中的 ProductSKU 出参： - 默认值和最小值：TopicNumLimit 参数 - 最大值：TopicNumUpperLimit 参数示例值：50
ZoneIds.N	否	Array of Integer	部署可用区列表，从 DescribeZones 接口获得。示例值：[10001,10002]

3. 输出参数

参数名称	类型	描述
InstanceId	String	集群ID 示例值：rmq-72mo3a9o
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 正常响应

成功创建一个 TPS 2000 的 RocketMQ 5.x 集群。

输入示例

POST / HTTP/1.1
Host: trocket.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateInstance
<公共请求参数>

{
    "InstanceType": "BASIC",
    "Name": "test_instance",
    "SkuCode": "basic_2k"
}

输出示例

{
    "Error": null,
    "RequestId": null,
    "Response": {
        "InstanceId": "rmq-72mo3a9or",
        "RequestId": "32759095-0372-4ec0-ae3a-e5a2759fd0ff"
    }
}

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
FailedOperation	操作失败。

创建集群

本页目录：