管理与支持产品文档捉虫活动邀您参加！> HOT
文档中心>API 中心>消息队列 MQTT 版>授权策略相关接口>创建授权策略

创建授权策略

最近更新时间：2025-05-30 14:33:16

我的收藏

本页目录：

1. 接口描述

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

创建MQTT实例的性能测试任务

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：CreateAuthorizationPolicy。
Version 是 String 公共参数，本接口取值：2024-05-16。
Region 是 String 公共参数，详见产品支持的 地域列表。
InstanceId 是 String 腾讯云MQTT实例ID，从 DescribeInstanceList接口或控制台获得。
示例值：mqtt-xxxx
PolicyName 是 String 策略名称，不能为空，3-64个字符，支持中文、字母、数字、“-”及“_”。
示例值：name
PolicyVersion 是 Integer 策略版本,默认为1，当前仅支持1
示例值：1
Priority 是 Integer 策略优先级，越小越优先，不能重复，优先级ID越小表示策略越优先检查生效。可参考 数据面授权策略说明。
示例值：1
Effect 是 String 决策：
allow：允许符合该策略的设备的访问请求。
deny：拒绝覆盖该策略的设备的访问请求。
可参考 数据面授权策略说明。
示例值：allow
Actions 是 String 操作,支持多选，多个操作用英文逗号隔开。可参考 数据面授权策略说明。
connect：连接
pub：发布
sub：订阅
示例值：connect
Retain 是 Integer 条件-保留消息，可参考 数据面授权策略说明。
1,匹配保留消息；
2,匹配非保留消息，
3.匹配保留和非保留消息
示例值：1
Qos 是 String 条件：服务质量
0：最多一次
1：最少一次
2：精确一次
可参考 数据面授权策略说明。
示例值：1
Resources 否 String 资源，需要匹配的订阅，支持配置多条匹配规则，多个用英文逗号隔开。可参考 数据面授权策略说明。

示例值：topic1
Username 否 String 条件-用户名
示例值：user1
ClientId 否 String 条件：客户端ID，支持正则
示例值：client1
Ip 否 String 条件：客户端IP地址，支持IP或者CIDR，可参考 数据面授权策略说明。
示例值：127.0.0.1
Remark 否 String 备注信息，最长 128 字符
示例值：remark

3. 输出参数

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

4. 示例

示例1 示例

输入示例

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

{
    "InstanceId": "mqtt-xxx",
    "PolicyName": "name1",
    "PolicyVersion": 1,
    "Priority": 4,
    "Effect": "allow",
    "Actions": "pub",
    "Retain": 1,
    "Qos": "2"
}

输出示例

{
    "Error": null,
    "RequestId": null,
    "Response": {
        "Id": 6,
        "InstanceId": "mqtt-xxx",
        "RequestId": "2e477c8c-abef-46e2-bde3-29433b34f309"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.DuplicatePolicy DuplicatePolicy
FailedOperation.DuplicatePriority DuplicatePriority
FailedOperation.InstanceNotReady FailedOperation.InstanceNotReady
ResourceNotFound.Instance ResourceNotFound.Instance
中国站
目录