配置数据集权限 - CreateAndUpdatePermission
功能介绍
配置数据集权限。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。
URI
POST /v1/{project_id}/datasets/{dataset_id}/permissions
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
dataset_id |
是 |
String |
参数解释: 数据集ID 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
project_id |
是 |
String |
参数解释: 项目ID。获取方法请参见获取项目ID。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Workspace-Id |
是 |
String |
参数解释: 工作空间ID。获取方法请参见获取工作空间ID。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。通过调用IAM服务获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
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 |
条件值信息 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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 |
条件值信息 |
请求示例
配置数据集权限。
POST https://{endpoint}/v1/{project_id}/datasets/{dataset_id}/permissions
{
"name" : "行权限8",
"dataset_id" : "xxxxxxx-1ae0-4b4a-a476-48ea10b4bbd3",
"is_open" : 1,
"permission_type" : "ROW",
"rule_scope" : "ALL",
"rule_user" : {
"users" : [ ],
"userGroups" : [ ]
},
"rule_type" : "BY_CONDITION",
"rule_content" : {
"logic_operator" : "AND",
"condition_node" : null,
"sub_conditions" : [ {
"logic_operator" : null,
"condition_node" : {
"column_id" : "cxxxxx-a43e-4c09-aec5-a7aeedb19822.ca_country",
"column_name" : "ca_country",
"is_measure" : false,
"execute_expression" : null,
"relation_operator" : "CONTAIN",
"data_type" : null,
"value" : {
"values" : [ "123" ],
"value_type" : "CONDITION",
"value_names" : null
}
},
"sub_conditions" : [ ]
}, {
"logic_operator" : null,
"condition_node" : {
"column_id" : "cxxxxxx-a43e-4c09-aec5-a7aeedb19822.ca_zip",
"column_name" : "ca_zip",
"is_measure" : false,
"execute_expression" : null,
"relation_operator" : "CONTAIN",
"data_type" : null,
"value" : {
"values" : [ "weq" ],
"value_type" : "CONDITION",
"value_names" : null
}
},
"sub_conditions" : [ ]
}, {
"logic_operator" : "OR",
"condition_node" : null,
"sub_conditions" : [ {
"logic_operator" : null,
"condition_node" : {
"column_id" : "xxxxxxx-32bb-4002-9c55-2a47415bdaf6.cs_item_sk",
"column_name" : "cs_item_sk",
"is_measure" : true,
"execute_expression" : null,
"relation_operator" : "NOT-EQUAL",
"data_type" : null,
"value" : {
"values" : [ "12" ],
"value_type" : "CONDITION",
"value_names" : null
}
},
"sub_conditions" : [ ]
} ]
} ]
},
"display_fields" : {
"user_map" : { },
"group_map" : { }
}
}
响应示例
状态码:200
配置成功返回信息。
{
"id" : "xxxxxxxe2-46cd7dab427e",
"name" : "行权限8",
"dataset_id" : "xxxxxx-1ae0-4b4a-a476-48ea10b4bbd3",
"is_open" : true,
"permission_type" : "ROW",
"rule_scope" : "ALL",
"rule_user" : {
"user_groups" : null,
"users" : [ ]
},
"display_fields" : {
"user_map" : { },
"group_map" : { },
"field_map" : null
},
"rule_type" : "BY_CONDITION",
"rule_content" : {
"logic_operator" : "AND",
"condition_node" : null,
"sub_conditions" : [ {
"logic_operator" : null,
"condition_node" : {
"column_id" : "xxxxxxxx-a43e-4c09-aec5-a7aeedb19822.ca_country",
"column_name" : "ca_country",
"is_measure" : false,
"execute_expression" : null,
"relation_operator" : "CONTAIN",
"data_type" : null,
"value" : {
"values" : [ "123" ],
"value_type" : "CONDITION",
"value_names" : null
}
},
"sub_conditions" : [ ]
}, {
"logic_operator" : null,
"condition_node" : {
"column_id" : "cxxxxxx-a43e-4c09-aec5-a7aeedb19822.ca_zip",
"column_name" : "ca_zip",
"is_measure" : false,
"execute_expression" : null,
"relation_operator" : "CONTAIN",
"data_type" : null,
"value" : {
"values" : [ "weq" ],
"value_type" : "CONDITION",
"value_names" : null
}
},
"sub_conditions" : [ ]
}, {
"logic_operator" : "OR",
"condition_node" : null,
"sub_conditions" : [ {
"logic_operator" : null,
"condition_node" : {
"column_id" : "xxxxxxxx-32bb-4002-9c55-2a47415bdaf6.cs_item_sk",
"column_name" : "cs_item_sk",
"is_measure" : true,
"execute_expression" : null,
"relation_operator" : "NOT-EQUAL",
"data_type" : null,
"value" : {
"values" : [ "12" ],
"value_type" : "CONDITION",
"value_names" : null
}
},
"sub_conditions" : [ ]
} ]
} ]
}
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
配置成功返回信息。 |
错误码
请参见错误码。