获取数据集权限列表 - ListPermission
功能介绍
获取数据集权限列表。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。
URI
GET /v1/{project_id}/datasets/{dataset_id}/permissions
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
dataset_id |
是 |
String |
参数解释: 数据集ID。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 0 |
|
project_id |
是 |
String |
参数解释: 项目ID。获取方法请参见获取项目ID。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
permission_type |
是 |
String |
参数解释: 权限类别。 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
offset |
否 |
Integer |
参数解释: 分页的偏移值。 约束限制: 不涉及 取值范围: [0,1000] 默认取值: 0。 |
|
limit |
否 |
Integer |
参数解释: 返回条目数。 约束限制: 不涉及 取值范围: [1, 1000] 默认取值: 10。 |
|
sort_key |
否 |
String |
参数解释: 排序字段。 约束限制: 不涉及 取值范围: 不涉及 默认取值: isOpen |
|
sort_dir |
否 |
String |
参数解释: 排序类型。 约束限制: 不涉及 取值范围:
默认取值: asc |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Workspace-Id |
是 |
String |
参数解释: 工作空间ID。获取方法请参见获取工作空间ID。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。通过调用IAM服务获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
count |
Integer |
参数解释: 数据总量。 取值范围: 不涉及 |
|
page_data |
Array of DatasetPermissionVo objects |
参数解释: 数据。 取值范围: 不涉及 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
参数解释: 规则ID。 取值范围: 不涉及 |
|
name |
String |
参数解释: 规则名称。 取值范围: 不涉及 |
|
dataset_id |
String |
参数解释: 数据集ID。 取值范围: 不涉及 |
|
is_open |
Integer |
参数解释: 当前规则是否生效。 取值范围:
|
|
permission_type |
String |
参数解释: 权限类别 取值范围:
|
|
rule_scope |
String |
参数解释: 规则范围 取值范围:
说明:
|
|
rule_type |
String |
参数解释: 规则类型 取值范围: 权限类型为COLUMN时:
权限类型为ROW时:
|
|
rule_user |
RuleUserDescribe object |
生效用户或用户组列表。 |
|
rule_content |
PermissionRuleContent object |
参数解释: 规则条件详情。 取值范围: 不涉及 |
|
display_fields |
DisplayFieldsDescribe object |
用户、用户组、字段ID和名称映射关系。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
user_groups |
Array of strings |
参数解释: 用户组ID列表。 取值范围: 不涉及 |
|
users |
Array of strings |
参数解释: 用户ID列表。 取值范围: 不涉及 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
last |
Integer |
参数解释: 自定义情况下待处理字符的结束位置。 取值范围: 不涉及 |
|
first |
Integer |
参数解释: 自定义情况下待处理字符的开始位置。 取值范围: 不涉及 |
|
mask_type |
String |
参数解释: 脱敏类型 取值范围:
|
|
column_ids |
Array of strings |
参数解释: 字段ID列表。 取值范围: 不涉及 |
|
special_words |
Array of strings |
参数解释: 特殊字符列表。 取值范围: 不涉及 |
|
logic_operator |
String |
参数解释: 当前层次下sub_conditions条件间关联关系; 取值范围:
|
|
condition_node |
Object |
参数解释: 条件信息。 取值范围: 不涉及 |
|
sub_conditions |
Array of RowPermissionDescribe objects |
参数解释: 行条件列表信息。 取值范围: 不涉及 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
logic_operator |
String |
参数解释: 当前层sub_conditions条件间关联关系。 取值范围:
|
|
condition_node |
condition_node object |
条件信息 |
|
sub_conditions |
Array of RowPermissionDescribe objects |
参数解释: 行条件信息列表。 取值范围: 不涉及 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
column_id |
String |
参数解释: 字段ID 取值范围: 不涉及 |
|
column_name |
String |
参数解释: 字段名称。 取值范围: 不涉及 |
|
is_measure |
Boolean |
参数解释: 是否为度量字段。 取值范围: 不涉及 |
|
execute_expression |
String |
参数解释: 可执行函数表达式。 取值范围: 不涉及 |
|
relation_operator |
String |
参数解释: 条件符。 取值范围:
|
|
data_type |
String |
参数解释: 字段类型。 取值范围: 不涉及 |
|
value |
value object |
条件值信息 |
请求示例
获取数据集权限列表。
GET https://{endpoint}/v1/{project_id}/datasets/{dataset_id}/permissions?limt=10&offset=0&sort_key=isOpen&sort_dir=desc&permission_type=ROW
响应示例
状态码:200
数据集权限配置信息。
{
"count" : 3,
"page_data" : [ {
"id" : "xxxxxx3c1b-4xxxx-8f52-e15e35a361ea",
"name" : "COLUMN",
"dataset_id" : "1xxxxxxxxe129-xxxx-ad8e-673f02d395f4",
"is_open" : true,
"permission_type" : "COLUMN",
"rule_type" : "MASK",
"rule_scope" : "ALL",
"project_id" : "xxxxxxxxxxxxxxxxx",
"workspace_Id" : "xxxxxx4982fb3c00f9feee911",
"rule_user" : {
"users" : [ ],
"user_groups" : [ ]
},
"rule_content" : {
"last" : 1,
"first" : 1,
"mask_type" : "RETAIN_FIRST_N_LAST_M",
"column_ids" : [ "fd7ce9d6-xxxx-4126-bd51-xxxxxxxxx.amount" ],
"special_words" : [ "xxx" ]
},
"display_fields" : {
"user_map" : { },
"group_map" : { },
"field_map" : {
"fxxxxxxx-6dae-4126-bd51-36fc0ee3ce54.amount" : "amount"
}
}
}, {
"id" : "xxxxxx-dace-40a8-8ddf-c6dfa485fbf1",
"name" : "USER_TAG",
"dataset_id" : "xxxxxxxx3-426f-b657-829addaba20e",
"is_open" : true,
"permission_type" : "ROW",
"rule_type" : "BY_TAG",
"rule_scope" : "ALL",
"rule_user" : {
"users" : [ ],
"user_groups" : [ ]
},
"rule_content" : {
"condition_node" : null,
"logic_operator" : "AND",
"sub_conditions" : [ {
"condition_node" : {
"value" : {
"values" : [ "xxxxxx5-4ffa-4340-9b5d-0bd85668cbd4" ],
"value_type" : "TAG_USER_GROUP",
"value_names" : [ "userGroup2" ]
},
"column_id" : "xxxxxxx-b74c-4752-9630-43ca65d0d12c.buyer_name",
"is_measure" : false,
"column_name" : "buyer_name",
"relation_operator" : ""
},
"logic_operator" : null
}, {
"condition_node" : {
"value" : {
"values" : [ "0xxxxxxx-4ffa-4340-9b5d-0bd85668cbd4" ],
"value_type" : "TAG_USER_GROUP",
"value_names" : [ "userGroup2" ]
},
"column_id" : "xxxxx-b74c-4752-9630-43ca65d0d12c.buyer_name",
"is_measure" : false,
"column_name" : "buyer_name",
"relation_operator" : ""
},
"logic_operator" : null
} ]
},
"display_fields" : null
}, {
"id" : "xxxxxxx-ef3d-4ebc-a9ee-c651f563d67c",
"name" : "测试",
"dataset_id" : "8xxxxx-c2a3-426f-b657-829addaba20e",
"is_open" : true,
"permission_type" : "ROW",
"rule_type" : "BY_CONDITION",
"rule_scope" : "SPECIFIED",
"rule_user" : {
"users" : [ "dxxxxxxxxxxxxxxxxxxxxxx4ae564", "6071xxxxxxxxxxxxxxdff1e733bb4", "774xxxxxxxxxxxxxxxx513080f9ba" ],
"user_groups" : [ ]
},
"rule_content" : {
"condition_node" : null,
"logic_operator" : "AND",
"sub_conditions" : [ {
"condition_node" : {
"value" : {
"values" : [ "123" ],
"value_type" : "CONDITION"
},
"column_id" : "xxxxxxxx-b74c-4752-9630-43ca65d0d12c.buyer_name",
"is_measure" : false,
"column_name" : "buyer_name",
"relation_operator" : "CONTAIN"
},
"logic_operator" : null
}, {
"condition_node" : null,
"logic_operator" : "OR",
"sub_conditions" : [ {
"condition_node" : {
"value" : {
"values" : [ "qwe" ],
"value_type" : "CONDITION"
},
"column_id" : "xxxxxx2-b74c-4752-9630-43ca65d0d12c.buyer_name",
"is_measure" : false,
"column_name" : "buyer_name",
"relation_operator" : "CONTAIN"
},
"logic_operator" : null
} ]
} ]
},
"display_fields" : {
"user_map" : {
"6xxxxxxxff1e733bb4" : "auth_test",
"774xxxxxxxc86513080f9ba" : "chenxiantao",
"d6exxxxxxc943de304ae564" : "abac_test"
},
"group_map" : { },
"field_map" : null
}
} ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
数据集权限配置信息。 |
错误码
请参见错误码。