1. 接口描述
接口请求域名: mqtt.tencentcloudapi.com 。
修改策略规则
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:ModifyAuthorizationPolicy。 |
Version | 是 | String | 公共参数,本接口取值:2024-05-16。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
Id | 是 | Integer | 策略 示例值:1 |
InstanceId | 是 | String | 实例ID 示例值:mqtt-xxxx |
PolicyName | 否 | String | 策略名称 示例值:name |
PolicyVersion | 否 | Integer | 策略版本 示例值:1 |
Priority | 否 | Integer | 策略优先级,越小越优先 示例值:1 |
Effect | 否 | String | allow、deny 示例值:allow |
Actions | 否 | String | connect、pub、sub 示例值:connect |
Resources | 否 | String | 资源 示例值:topic1 |
Username | 否 | String | 用户名 示例值:user1 |
Retain | 否 | Integer | 1.匹配保留消息;2.匹配非保留消息;3.匹配所有消息 示例值:1 |
ClientId | 否 | String | 客户端 示例值:client1 |
Ip | 否 | String | IP 示例值:127.0.0.1 |
Qos | 否 | String | 0、1、2 示例值:1 |
Remark | 否 | String | 备注信息 示例值:remark |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 示例
示例
输入示例
POST / HTTP/1.1
Host: mqtt.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyAuthorizationPolicy
<公共请求参数>
{
"Id": 18,
"InstanceId": "mqtt-jeredv33",
"PolicyName": "policy-1"
}
输出示例
{
"Error": null,
"RequestId": null,
"Response": {
"RequestId": "657a771d-a70e-4c0d-a70a-eb7f82471000"
}
}
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. 错误码
该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码。