1. 接口描述
接口请求域名： mqtt.tencentcloudapi.com 。
购买新的MQTT实例
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：CreateInstance。 |
| Version | 是 | String | 公共参数，本接口取值：2024-05-16。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| InstanceType | 是 | String | 实例类型，需要和SkuCode保持对应关系，可参考 获取MQTT产品售卖规格 接口获取。 BASIC 基础版 PRO 专业版 PLATINUM 铂金版 示例值：BASIC |
| Name | 是 | String | 集群名称不能为空, 3-64个字符，只能包含数字、字母、“-”和“_”。 示例值：instance-1 |
| SkuCode | 是 | String | 商品规格，需要和InstanceType保持对应关系，可参考 获取MQTT产品售卖规格 接口获取。 示例值：pro_10k_1 |
| Remark | 否 | String | 备注信息，最长 128 字符 示例值：remark |
| TagList.N | 否 | Array of Tag | 标签列表 示例值：[{"tag1-key":"tag1-value","tag2-key":"tag2-value"}] |
| VpcList.N | 否 | Array of VpcInfo | 实例绑定的VPC信息，需要传当前用户下可用的VPC和SUBNET |
| EnablePublic | 否 | Boolean | 是否开启公网，默认false（关闭） 示例值：true |
| Bandwidth | 否 | Integer | 公网带宽（单位：Mbps），EnablePublic 为True时，该字段必须填写且大于0. 示例值：1 |
| IpRules.N | 否 | Array of IpRule | 公网访问白名单，不传表示拒绝所有IP网络访问。 |
| RenewFlag | 否 | Integer | 是否自动续费（0: 不自动续费；1: 自动续费），仅购买预付费集群时生效。默认1:自动续费 示例值：1 |
| TimeSpan | 否 | Integer | 购买时长（单位：月），购买预付费集群时生效，默认1m（月）。可选范围：1~12、24、36、48、60； 示例值：1 |
| PayMode | 否 | Integer | 付费模式（0: 后付费；1: 预付费），默认0（后付费）。 示例值：1 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| InstanceId | String | 实例ID 示例值：rmq-xxxx |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 示例
示例
输入示例
POST / HTTP/1.1
Host: mqtt.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateMQTTInstance
<公共请求参数>
{
"InstanceType": "BASIC",
"Name": "instance-1",
"SkuCode": "basic_1k",
"Remark": "this is remark",
"VpcList": [
{
"VpcId": "vpc-9a5wnirv",
"SubnetId": "subnet-0tw6tlfi"
}
],
"IpRules": [
{
"Ip": "1.1.1.1",
"Allow": true,
"Remark": "remark"
}
]
}输出示例
{
"Error": null,
"RequestId": null,
"Response": {
"InstanceId": "mqtt-7pnqmkrx",
"RequestId": "request-id"
}
}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 | 操作失败。 |
| InvalidParameter.InstanceTypeNotMatch | InstanceTypeNotMatch |
| InvalidParameterValue | 参数取值错误。 |
| InvalidParameterValue.PublicNetworkInvalidParameterValue | PublicNetworkInvalidParameterValue |
| MissingParameter | 缺少参数错误。 |
