跳转至

授权

接口概述

本接口是用于用户对某个资源对其他用户进行批量授权操作,授权的资源包含租户,数据集,指标,分析视图,指标类目,数据集类目,结果加速类目,数据源,数据库,数据源表。如果被授权的用户已经存在授权记录,授权角色会升级,但是不会进行降级操作,降级则会忽略

接口请求地址

POST  Http://{anymetrics_host:anymetrics_port}/anymetrics/api/v1/authority/grant

anymetrics_host:anymetrics_port 获取方式请参考:调用方式

请求参数

公共请求参数(HEADRS)

参数 类型 是否必选 最大长度 描述 示例值
tenant-id String 32 当前租户ID tn_125288
auth-type String 32 身份类型,UID/TOKEN UID
auth-value String 32 UID或者TOKEN值 341523017135816704

公共参数获取方式

tenant-id 与 auth-value:在 Aloudata CAN 顶部导航栏选择指标应用,左边菜单栏选择 API 集成。在 API 集成界面获取取到tenant-id 与auth-value。

imagepng

请求参数

参数 类型 是否必选 最大长度 描述 示例值
authorizedAccountList List 被授权用户的userId列表 ["336178570944581632"]
authorityRole AuthorityRoleEnum 被授权的角色枚举,枚举值请参考:3.2.1 AuthorityRoleEnum ADMIN USAGER
resource Map 被授权的资源对象,更多详情请参考 3.2.2 resource

AuthorityRoleEnum

参数 说明
AuthorityRoleEnum 枚举值为:OWNER,ADMIN,USAGER
OWNER(不可主动被授权):可授权ADMIN,USAGER
 ADMIN:管理员,可授权USAGE
USAGER:使用者
CREATOR: 可新建

resource

参数名 类型 是否必选 描述
resourceType ResourceTypeEnum 被授权的资源类型,枚举值如下:
TENANT:租户
VIEW:分析视图
DATASET:数据集
METRIC:指标
DIMENSION:维度
CATEGORY_METRIC:指标类目
CATEGORY_DATASET:数据集类目
CATEGORY_RESULT_PLAN:结果加速类目
DATASOURCE:数据源
DATABASE:数据源数据库
TABLE:数据源表
resourceId String 资源 ID,每个类型资源示例如下:
TENANT:租户 ID,例如:tn_12345
DATASET:数据集名称,例如:order<br />
METRIC:指标 code,例如:uv_7day
DIMENSION:维度 code,例如:dmfa48e4cb69c60912210bc5162ff324<br />
VIEW:视图名称,例如:order_view
CATEGORY_METRIC:指标类目名称
CATEGORY_DATASET:数据集类目名称
CATEGORY_RESULT_PLAN:结果加速类目名称
DATASOURCE:数据源,例如:default_catalog
DATABASE:数据源数据库,例如:aloudata_datasource.`default_catalog.aloudatacan`
TABLE:数据源表,例如:aloudata_datasource.`default_catalog.aloudatacan`.API_MZTEST

资源点权限说明

类型 角色 是否必选 描述
TENANT(租户) OWNER 包含权限点:租户授权、撤权、编辑、使用;数据集、指标、分析视图的创建权限
ADMIN 包含权限点:租户授权、撤权、编辑、使用;数据集、指标、分析视图的创建权限
USAGER 包含权限点:租户使用
DATASET(数据集) OWNER 包含权限点:数据集授权、撤权、删除、编辑、使用
ADMIN 包含权限点:数据集授权、撤权、编辑、使用;租户授权、撤权、数据集、指标、分析视图的创建权限
USAGER 包含权限点:数据集使用
METRIC(指标) OWNER 包含权限点:指标授权、撤权、删除、编辑、使用
ADMIN 包含权限点:指标授权、撤权、编辑、使用;租户授权、撤权、数据集、指标、分析视图的创建权限
USAGER 包含权限点:指标使用
DIMENSION(维度) OWNER 包含权限点:维度授权、撤权、删除、编辑、使用
ADMIN 包含权限点:维度授权、撤权、编辑、使用;租户授权、撤权、数据集、指标、分析视图的创建权限
USAGER 包含权限点:维度使用
ANALYSIS_VIEW(分析视图) OWNER 包含权限点:分析视图授权、撤权、删除、编辑、使用
ADMIN 包含权限点:分析视图授权、撤权、编辑、使用;租户授权、撤权、数据集、指标、分析视图的创建权限
USAGER 包含权限点:分析视图使用
CATEGORY_METRIC(指标类目) OWNER 包含权限点:指标类目授权、撤权、删除、编辑、使用;类目下可新建指标
ADMIN 包含权限点:指标类目授权、撤权、编辑、使用;类目下可新建指标;租户授权、撤权、数据集、指标、分析视图的创建权限
USAGER 包含权限点:指标类目使用
CREATOR 包含权限点:类目下可新建指标
CATEGORY_DATASET(数据集类目) OWNER 包含权限点:数据集类目授权、撤权、删除、编辑、使用;类目下可新建数据集
ADMIN 包含权限点:数据集类目授权、撤权、编辑、使用;类目下可新建数据集;租户授权、撤权、数据集、指标、分析视图的创建权限
USAGER 包含权限点:数据集类目使用
CREATOR 包含权限点:类目下可新建数据集
CATEGORY_RESULT_PLAN(结果加速类目) OWNER 包含权限点:结果加速类目授权、撤权、删除、编辑、使用;类目下可新建结果加速
ADMIN 包含权限点:结果加速类目授权、撤权、编辑、使用;租户授权、撤权、数据集、指标、分析视图的创建权限
USAGER 包含权限点:结果加速类目使用
CREATOR 包含权限点:类目下可新建结果加速
DATASOURCE(数据源) OWNER 包含权限点:数据源授权、撤权、使用
ADMIN 包含权限点:数据源授权、撤权、使用;租户授权、撤权、数据集、指标、分析视图的创建权限
USAGER 包含权限点:数据源使用
DATABASE(数据库) OWNER 包含权限点:数据库使用、撤权、使用
ADMIN 包含权限点:数据库授权、撤权、使用;租户授权、撤权、数据集、指标、分析视图的创建权限
USAGER 包含权限点:数据库使用
TABLE(数据源表) OWNER 包含权限点:数据源表授权、撤权、使用
ADMIN 包含权限点:数据源表授权、撤权、使用;租户授权、撤权、数据集、指标、分析视图的创建权限
USAGER 包含权限点:数据源表使用

响应参数

参数 类型 是否必选 最大长度 描述 示例值
code String 32 接口响应码 200
success boolean 是否成功 true
errorMsg String 512 报错信息 null
detailErrorMsg String 报错详情 null
traceId String 128 traceId 343f9ff2dcd70.292.16857691758642861
data Boolean 是否授权成功 true

请求示例

授予某用户在租户下的管理员(ADMIN)权限

  • 请求
{
    "authorizedAccountList": [
        "478208578931392512"
    ],
    "authorityRole": "ADMIN",
    "resource": {
        "resourceType": "TENANT",
        "resourceId": "tn_19487697"
    }
}
  • 响应
{
    "data": true,
    "success": true,
    "code": "200",
    "errorMsg": null,
    "detailErrorMsg": null,
    "traceId": "2bc7df9f294144deab6535e0b2a9b546.154.17234535618741285"
}

授予某用户某个数据集的使用者(USAGER)权限

  • 请求
{
    "authorizedAccountList": [
        "478208578931392512",
        "521414214241395324"
    ],
    "authorityRole": "USAGER",
    "resource": {
        "resourceType": "DATASET",
        "resourceId": "order"
    }
}
  • 响应
{
    "data": true,
    "success": true,
    "code": "200",
    "errorMsg": null,
    "detailErrorMsg": null,
    "traceId": "1bc7df9f294144deab6535e0b2a9b546.154.172345678496655652"
}