1. 接口描述
接口请求域名： mqtt.tencentcloudapi.com 。
创建封禁规则
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：CreateBlockRule。 |
| Version | 是 | String | 公共参数，本接口取值：2024-05-16。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| InstanceId | 是 | String | 腾讯云MQTT实例ID，从 DescribeInstanceList接口或控制台获得。 示例值：mqtt-zj944d74 |
| Name | 是 | String | 封禁规则名，不可重复，只支持数字字母中划线 示例值：aaaccc |
| Type | 否 | Integer | 封禁规则类型 CLIENT_ID(1), 默认值 USERNAME(2), IP_ADDRESS(3); 示例值：3 |
| Include | 否 | String | 包含表达式支持*（多个字符）和？（一个字符） 示例值：127.0.0.1 |
| Excludes.N | 否 | Array of String | 排除表达式支持*（多个字符）和？（一个字符），最多三条。 示例值：["0.0.0.0/0"] |
| ExpireTime | 否 | Integer | 过期时间，毫秒级时间戳 示例值：1774597703556 |
| Remark | 否 | String | 备注，最长 128 字符 示例值：this is remark |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| InstanceId | String | 实例ID 示例值：mqtt-zj944d74 |
| Name | String | 封禁规则名 示例值：aaaccc |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 示例
输入示例
POST / HTTP/1.1
Host: mqtt.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateBlockRule
<公共请求参数>
{
"InstanceId": "mqtt-zj944d74",
"Name": "aaaccc",
"Type": 3,
"Include": "127.0.0.1",
"Excludes": [
"0.0.0.0/0"
],
"ExpireTime": 1774597703556,
"Remark": "this is remark"
}输出示例
{
"Response": {
"InstanceId": "mqtt-zj944d74",
"Name": "aaaccc",
"RequestId": "9eee3852-13cd-491e-833c-92977cf047a5"
}
}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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| FailedOperation.InstanceNotReady | FailedOperation.InstanceNotReady |
| LimitExceeded.TopicNum | LimitExceeded.TopicNum |
| OperationDenied | 操作被拒绝。 |
| ResourceNotFound.Instance | ResourceNotFound.Instance |
| UnsupportedOperation.ResourceAlreadyExists | UnsupportedOperation.ResourceAlreadyExists |
