更新时间:2024-10-21 GMT+08:00

添加权限策略

功能介绍

本接口用于给指定通道添加权限策略。

调用方法

请参见如何调用API

URI

POST /v2/{project_id}/streams/{stream_name}/policies

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。

stream_name

String

需要添加授权策略的通道名称。

最大长度:64

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

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

表3 请求Body参数

参数

是否必选

参数类型

描述

stream_id

String

通道唯一标识符。

principal_name

String

授权用户。

如果授权给指定租户,格式为:domainName.*;如果授权给租户下的指定子用户,则格式为:domainName.userName;

支持多账号添加,用","隔开,比如:domainName1.userName1,domainName2.userName2;

action_type

String

授权操作类型。

  • putRecords:上传数据。

  • getRecords:下载数据。

  • getStreamInfo:通道详情。

枚举值:

  • putRecords

  • getRecords

  • getStreamInfo

effect

String

授权影响类型。

  • accept:允许该授权操作。

枚举值:

  • accept

响应参数

请求示例

  • 给租户添加权限策略

    POST https://{Endpoint}/v2/{project_id}/streams/{stream_name}/policies
    
    {
      "stream_id" : "CiFdELMr0401K9GGZlp",
      "principal_name" : "domainname1",
      "action_type" : "putRecords",
      "effect" : "accept"
    }
  • 给子用户添加权限策略

    POST https://{Endpoint}/v2/{project_id}/streams/{stream_name}/policies
    
    {
      "stream_id" : "CiFdELMr0401K9GGZlp",
      "principal_name" : "domainname1.username1",
      "action_type" : "putRecords",
      "effect" : "accept"
    }

响应示例

状态码

状态码

描述

200

正常返回

错误码

请参见错误码