更新时间:2024-07-03 GMT+08:00
分享

增量授权应用Topic权限

功能介绍

增量授权应用Topic权限。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

POST /v2/{project_id}/mqs/instances/{instance_id}/topics/{topic_name}/access-policies/batch-add

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,获取方式请参见API参考的“附录 > 获取项目ID”章节。

instance_id

String

实例ID。

topic_name

String

Topic名称。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

表3 请求Body参数

参数

是否必选

参数类型

描述

policies

Array of PolicyEntity objects

应用Topic权限列表。

表4 PolicyEntity

参数

是否必选

参数类型

描述

user_name

String

应用Key(access key)

app_name

String

应用名称。

access_policy

String

权限类型。

  • all:拥有发布、订阅权限;

  • pub:拥有发布权限;

  • sub:拥有订阅权限。

tag

String

标签列表,权限类型对应的标签。

当权限类型是all时,发布和订阅的标签用符号“&”隔开。

当有多个标签时,标签用符号“||”隔开。

规则:仅能包含数字、字母、中划线(-)、下划线(_),长度不超过48。

响应参数

状态码: 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误信息。

状态码: 403

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误信息。

请求示例

https://{endpoint}/v2/{project_id}/mqs/instances/{instance_id}/topics/{topic_name}/access-policies/batch-add

{
  "policies" : [ {
    "user_name" : "62034763-c4aa-416f-975d-1452ba90fec2",
    "app_name" : "app-uve7",
    "access_policy" : "sub",
    "tag" : "123&abc"
  } ]
}

响应示例

状态码: 400

Bad Request

{
  "error_code" : 400,
  "error_msg" : "Bad Request"
}

状态码: 403

Forbidden

{
  "error_code" : 403,
  "error_msg" : "Forbidden"
}

状态码

状态码

描述

204

No Content

400

Bad Request

403

Forbidden

错误码

请参见错误码

相关文档