根據提供的安全性原則ID,擷取對應的安全性原則詳細資料。需要Dataworks 租用戶系統管理員與安全性系統管理員許可權。
介面說明
請求說明
該 API 用於通過指定的安全性原則 ID 來檢索特定安全性原則的全部配置資訊。
確保提供的
Id參數值有效且存在,否則將返回錯誤資訊。返回的資料結構包括了策略的基本資料(如名稱、描述等)以及詳細的策略內容(如管控項及其設定)。
注意:系統預設策略的部分欄位可能不允許修改或刪除。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| Id |
integer |
是 |
安全性原則 ID |
13 |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
Schema of Response |
||
| RequestId |
string |
API 請求 ID |
0bc5df3a17****903790e8e8a |
| SecurityStrategy |
object |
安全性原則 |
|
| Id |
integer |
策略 ID |
13 |
| Name |
string |
策略名稱稱 |
預設資料分析策略 |
| Description |
string |
策略描述 |
控制資料分析模組的查詢結果安全行為 |
| SchemaName |
string |
Schema 模板名稱 |
DataQuerySecurityStrategySchema |
| ControlModule |
string |
管控模組 |
DataQuery |
| ControlSubModule |
string |
管控子模組 |
MyCatalog |
| ControlDwScope |
string |
管控範圍(Workspace/Tenant) |
Tenant |
| Workspaces |
array |
關聯工作空間 ID 列表 |
|
|
integer |
工作空間 ID |
4843434 |
|
| Enabled |
boolean |
是否啟用 |
true |
| OriginPolicyId |
integer |
系統預設策略來源 ID |
12 |
| Creator |
string |
建立者使用者識別碼 |
203322746501002787 |
| Updater |
string |
最後更新者使用者識別碼 |
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 |
是否啟用該管控項 |
true |
| ControllerValueType |
string |
實值型別(Boolean/Integer/Long/String) |
Integer |
| UserConfigValue |
any |
使用者配置值,類型取決於 ControllerValueType |
10 |
| 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",
"SecurityStrategy": {
"Id": 13,
"Name": "預設資料分析策略",
"Description": "控制資料分析模組的查詢結果安全行為",
"SchemaName": "DataQuerySecurityStrategySchema",
"ControlModule": "DataQuery",
"ControlSubModule": "MyCatalog",
"ControlDwScope": "Tenant",
"Workspaces": [
4843434
],
"Enabled": true,
"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": "10",
"BasicEditionDefaultValue": "10000",
"StandardEditionDefaultValue": "10000",
"ProfessionalEditionDefaultValue": "10000",
"EnterpriseEditionDefaultValue": "10000",
"BasicEditionIntervalValue": [
0
],
"StandardEditionIntervalValue": [
0
],
"ProfessionalEditionIntervalValue": [
0
],
"EnterpriseEditionIntervalValue": [
0
]
}
]
}
}
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。