根据指定条件分页查询系统中的安全策略列表。需要Dataworks 租户管理员与安全管理员权限。
接口说明
请求说明
该 API 用于分页检索系统中已配置的安全策略。
可通过
ControlModule和ControlSubModule参数过滤特定模块或子模块下的策略。分页参数包括
PageNum和PageSize,分别表示页码和每页大小,默认值分别为 1 和 20。如果需要进一步的分页控制,可以使用
MaxResults和NextToken参数(私有参数)。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| ControlModule |
string |
否 |
管控模块 |
DataQuery |
| ControlSubModule |
string |
否 |
管控子模块 |
MyCatalog |
| PageNumber |
integer |
否 |
页码,从 1 开始。默认值为 1。 |
1 |
| PageSize |
integer |
否 |
页大小,默认 20 |
10 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| RequestId |
string |
API 请求 ID |
0bc5df3a17****903790e8e8a |
| PagingInfo |
object |
分页结果。 |
|
| PageNumber |
integer |
页码,默认 1 |
1 |
| PageSize |
integer |
页大小,默认 20 |
10 |
| TotalCount |
integer |
总记录数 |
12 |
| SecurityStrategies |
array<object> |
安全策略列表 |
|
|
array<object> |
安全策略 |
||
| Id |
string |
策略 ID |
12345 |
| Name |
string |
策略名称 |
默认数据分析策略 |
| Description |
string |
策略描述 |
控制数据分析模块的查询结果安全行为 |
| SchemaName |
string |
Schema 模板名称 枚举值:
|
DataQuerySecurityStrategySchema |
| ControlModule |
string |
管控模块 |
DataQuery |
| ControlSubModule |
string |
管控子模块 |
MyCatalog |
| ControlDwScope |
string |
管控范围(Workspace/Tenant) |
Tenant |
| Workspaces |
array |
关联工作空间 ID 列表 |
|
|
integer |
工作空间 ID。 |
343434 |
|
| Enabled |
boolean |
是否启用 |
false |
| OriginPolicyId |
integer |
系统默认策略来源 ID |
12 |
| Creator |
string |
创建者用户 ID |
203322746501002787 |
| Updater |
string |
最后更新者用户 ID |
203322746501002787 |
| CreateTime |
string |
创建时间。 |
2026-05-25T20:46:19 |
| UpdateTime |
string |
更新时间。 |
2026-05-25T20:46:19 |
| Content |
object |
策略内容。内容受 SecurityStrategySchema 约束 |
|
| Name |
string |
当前策略关联的 SecurityStrategySchema.name |
DataQuerySecurityStrategySchema |
| DisplayName |
string |
当前策略关联的 SecurityStrategySchema. displayName |
数据分析 |
| DisplayNameEn |
string |
当前策略关联的 SecurityStrategySchema. displayNameEn |
Data Query |
| ControlModule |
string |
控制模块。当前策略关联的 SecurityStrategySchema.controlModule |
DataQuery |
| ControlSubModule |
string |
管控子模块。当前策略关联的 SecurityStrategySchema.controlSubModule |
MyCatalog |
| ControlDwScope |
string |
管控范围 枚举值:
|
Tenant |
| SystemPolicyName |
string |
系统策略名称(非空时系统自动创建默认策略) |
SYSTEM_GENERATE_DEFAULT_DATA_QUERY |
| SystemPolicyDisplayName |
string |
系统策略显示名称 |
Default system generate data query policy |
| Controllers |
array<object> |
管控项列表,合法管控项取决于所选 Schema,参考 Controller 定义 及 各 Schema 管控项列表 |
|
|
object |
管控项 |
||
| Controller |
string |
管控项标识符,取值见 各 Schema 管控项列表 |
viewCount |
| DisplayName |
string |
显示名称 |
查询结果-单次展示记录值上限 |
| DisplayNameEn |
string |
英文显示名称 |
Query Results - Single Display Record Limit |
| Enable |
boolean |
是否启用该管控项 |
|
| ControllerValueType |
string |
值类型(Boolean/Integer/Long/String) |
Integer |
| UserConfigValue |
any |
用户配置值,类型取决于 ControllerValueType |
20 |
| BasicEditionDefaultValue |
any |
基础版默认值 |
10000 |
| StandardEditionDefaultValue |
any |
标准版默认值 |
10000 |
| ProfessionalEditionDefaultValue |
any |
专业版默认值 |
10000 |
| EnterpriseEditionDefaultValue |
any |
企业版默认值 |
10000 |
| BasicEditionIntervalValue |
array |
基础版有效值区间[min, max] |
|
|
integer |
区间起止值 |
0 |
|
| StandardEditionIntervalValue |
array |
标准版有效值区间[min, max] |
|
|
integer |
区间起止值 |
0 |
|
| ProfessionalEditionIntervalValue |
array |
专业版有效值区间[min, max] |
|
|
integer |
区间起止值 |
0 |
|
| EnterpriseEditionIntervalValue |
array |
企业版有效值区间[min, max] |
|
|
integer |
区间起止值 |
0 |
示例
正常返回示例
JSON格式
{
"RequestId": "0bc5df3a17****903790e8e8a",
"PagingInfo": {
"PageNumber": 1,
"PageSize": 10,
"TotalCount": 12,
"SecurityStrategies": [
{
"Id": "12345",
"Name": "默认数据分析策略",
"Description": "控制数据分析模块的查询结果安全行为",
"SchemaName": "DataQuerySecurityStrategySchema",
"ControlModule": "DataQuery",
"ControlSubModule": "MyCatalog",
"ControlDwScope": "Tenant",
"Workspaces": [
343434
],
"Enabled": false,
"OriginPolicyId": 12,
"Creator": "203322746501002787",
"Updater": "203322746501002787",
"CreateTime": "2026-05-25T20:46:19",
"UpdateTime": "2026-05-25T20:46:19",
"Content": {
"Name": "DataQuerySecurityStrategySchema",
"DisplayName": "数据分析",
"DisplayNameEn": "Data Query",
"ControlModule": "DataQuery",
"ControlSubModule": "MyCatalog",
"ControlDwScope": "Tenant",
"SystemPolicyName": "SYSTEM_GENERATE_DEFAULT_DATA_QUERY",
"SystemPolicyDisplayName": "Default system generate data query policy",
"Controllers": [
{
"Controller": "viewCount",
"DisplayName": "查询结果-单次展示记录值上限",
"DisplayNameEn": "Query Results - Single Display Record Limit",
"Enable": true,
"ControllerValueType": "Integer",
"UserConfigValue": "20",
"BasicEditionDefaultValue": "10000",
"StandardEditionDefaultValue": "10000",
"ProfessionalEditionDefaultValue": "10000",
"EnterpriseEditionDefaultValue": "10000",
"BasicEditionIntervalValue": [
0
],
"StandardEditionIntervalValue": [
0
],
"ProfessionalEditionIntervalValue": [
0
],
"EnterpriseEditionIntervalValue": [
0
]
}
]
}
}
]
}
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。