AddCustomAuthPermission - 添加Topic授权

更新时间:

添加Topic资源授权信息,且需要在控制台提前创建一级Topic。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
mq:AddCustomAuthPermissioncreate
*Instance
acs:mq:{#regionId}:{#accountId}:{#InstanceId}

请求参数

名称类型必填描述示例值
InstanceIdstring

消息队列 MQTT 版实例的 ID。

mqtt-cn-0pp12gl****
IdentityTypestring

身份类型,USER: 仅用户名,CLIENT: 具体到客户端

USER
Identitystring

用户名或客户端 ID。

test
PermitActionstring

授权操作。

PUB_SUB
Effectstring

允许或拒绝。

ALLOW
Topicstring

授权的 topic,支持 mqtt 多级 topic 与通配符。

test/t1

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

Id of the request

82B9E503-F4A1-4F30-976F-C6999FF9****
Codeinteger

状态码。说明 200 表示成功。

200
Successboolean

是否调用成功。返回值:true:调用成功。 false:调用失败。

True
Messagestring

返回信息。

operation success.

示例

正常返回示例

JSON格式

{
  "RequestId": "82B9E503-F4A1-4F30-976F-C6999FF9****",
  "Code": 200,
  "Success": true,
  "Message": "operation success."
}

错误码

HTTP status code错误码错误信息描述
400InstancePermissionCheckFailedAn error occurred while validating the permissions of the instance. Please verify the account that created the instance and its permissions settings.实例权限校验失败,请确认MQTT实例的所属关系以及授权策略。
400InvalidParameter.%sAn error occurred while validating the parameter. The parameter may be missing or invalid.参数校验失败,可能缺失或者传入值非法。
400Customauth.over.capacityOver custom auth capacity.自定义权限数量容量超限
404ApiNotSupportThe specified API is not supported.当前接口不支持,请检查。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史