全部產品
Search
文件中心

DataWorks:ListSecurityStrategies - 分頁檢索安全性原則

更新時間:Jun 10, 2026

根據指定條件分頁查詢系統中的安全性原則列表。需要Dataworks 租用戶系統管理員與安全性系統管理員許可權。

介面說明

請求說明

  • 該 API 用於分頁檢索系統中已配置的安全性原則。

  • 可通過 ControlModuleControlSubModule 參數過濾特定模組或子模組下的策略。

  • 分頁參數包括 PageNumPageSize,分別表示頁碼和每頁大小,預設值分別為 1 和 20。

  • 如果需要進一步的分頁控制,可以使用 MaxResultsNextToken 參數(私人參數)。

調試

您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

當前API暫無授權資訊透出。

請求參數

名稱

類型

必填

描述

樣本值

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 模板名稱

枚舉值:

  • DataStudioMyCatalogSecurityStrategySchema :

    DataStudioMyCatalogSecurityStrategySchema

  • DataQuerySecurityStrategySchema :

    DataQuerySecurityStrategySchema

  • DataStudioSecurityStrategySchema :

    DataStudioSecurityStrategySchema

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

建立者使用者識別碼

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 :

    Tenant

  • Workspace :

    Workspace

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
              ]
            }
          ]
        }
      }
    ]
  }
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊,參考變更詳情