Todos os produtos
Search
Central de documentação

DataWorks:ListSecurityStrategies

Última atualização: Jun 26, 2026

Obtém uma lista paginada de políticas de segurança com base em condições especificadas. Esta operação requer permissões de administrador de locatário ou administrador de segurança do DataWorks.

Descrição da operação

Solicitação

  • Esta API obtém uma lista paginada de políticas de segurança configuradas.

  • Os parâmetros ControlModule e ControlSubModule filtram políticas por um módulo ou submódulo específico.

  • Os parâmetros PageNum e PageSize controlam a paginação. PageNum especifica o número da página a ser obtida (padrão: 1) e PageSize especifica o número de políticas a serem retornadas por página (padrão: 20).

  • Use os parâmetros privados MaxResults e NextToken para paginação avançada.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

Nenhuma autorização necessária para esta operação. Se você encontrar problemas com esta operação, entre em contato com o suporte técnico.

Parâmetros da solicitação

Parâmetro

Tipo

Obrigatório

Descrição

Exemplo

ControlModule

string

Não

O módulo de controle..

DataQuery

ControlSubModule

string

Não

O submódulo de controle..

MyCatalog

PageNumber

integer

Não

O número da página. Começa em 1. Valor padrão: 1.

1

PageSize

integer

Não

O número de entradas por página. Valor padrão: 20.

10

Elementos de resposta

Elemento

Tipo

Descrição

Exemplo

object

O esquema da resposta.

RequestId

string

O ID da solicitação.

0bc5df3a17****903790e8e8a

PagingInfo

object

O resultado da paginação.

PageNumber

integer

O número da página. Valor padrão: 1.

1

PageSize

integer

O tamanho da página. Valor padrão: 20.

10

TotalCount

integer

A contagem total.

12

SecurityStrategies

array<object>

A lista de políticas de segurança.

array<object>

Uma política de segurança.

Id

string

The policy ID.

12345

Name

string

The policy name.

默认数据分析策略

Description

string

The policy description.

控制数据分析模块的查询结果安全行为

SchemaName

string

The name of the schema template.

Valores válidos:

  • DataStudioMyCatalogSecurityStrategySchema :

    DataStudioMyCatalogSecurityStrategySchema

  • DataQuerySecurityStrategySchema :

    DataQuerySecurityStrategySchema

  • DataStudioSecurityStrategySchema :

    DataStudioSecurityStrategySchema

DataQuerySecurityStrategySchema

ControlModule

string

The control module.

DataQuery

ControlSubModule

string

The control submodule.

MyCatalog

ControlDwScope

string

The control scope. Valid values: Workspace and Tenant.

Tenant

Workspaces

array

The associated workspace IDs.

integer

The workspace ID.

343434

Enabled

boolean

Whether the policy is enabled.

false

OriginPolicyId

integer

The source ID of the system default policy.

12

Creator

string

The user ID of the creator.

203322746501002787

Updater

string

The ID of the user who last updated the policy.

203322746501002787

CreateTime

string

The creation time.

2026-05-25T20:46:19

UpdateTime

string

The time of the last update.

2026-05-25T20:46:19

Content

object

The policy content. The content is constrained by SecurityStrategySchema.

Name

string

The name of the associated SecurityStrategySchema.

DataQuerySecurityStrategySchema

DisplayName

string

The displayName of the associated SecurityStrategySchema.

数据分析

DisplayNameEn

string

The displayNameEn of the associated SecurityStrategySchema.

Data Query

ControlModule

string

The control module. This value is from the controlModule property of the associated SecurityStrategySchema.

DataQuery

ControlSubModule

string

The control submodule. This value is from the controlSubModule property of the associated SecurityStrategySchema.

MyCatalog

ControlDwScope

string

The control scope.

Valores válidos:

  • Tenant :

    Tenant

  • Workspace :

    Workspace

Tenant

SystemPolicyName

string

The name of the system policy. If this property is not empty, the system automatically creates a default policy.

SYSTEM_GENERATE_DEFAULT_DATA_QUERY

SystemPolicyDisplayName

string

The display name of the system policy.

Default system generate data query policy

Controllers

array<object>

A list of control items. The available items depend on the schema. For details, see the Controller definition and the list of control items for each schema.

object

A control item.

Controller

string

The identifier of the control item. For valid values, see the list of control items for each schema.

viewCount

DisplayName

string

The display name.

查询结果-单次展示记录值上限

DisplayNameEn

string

The display name in English.

Query Results - Single Display Record Limit

Enable

boolean

Whether the control item is enabled.

ControllerValueType

string

The data type of the value. Valid values: Boolean, Integer, Long, and String.

Integer

UserConfigValue

any

The value set for the control item. The data type of this value is specified by ControllerValueType.

20

BasicEditionDefaultValue

any

The default value for Basic Edition.

10000

StandardEditionDefaultValue

any

The default value for Standard Edition.

10000

ProfessionalEditionDefaultValue

any

The default value for Professional Edition.

10000

EnterpriseEditionDefaultValue

any

The default value for Enterprise Edition.

10000

BasicEditionIntervalValue

array

The valid value range for Basic Edition, specified as [min, max].

integer

A boundary value of the range.

0

StandardEditionIntervalValue

array

The valid value range for Standard Edition, specified as [min, max].

integer

A boundary value of the range.

0

ProfessionalEditionIntervalValue

array

The valid value range for Professional Edition, specified as [min, max].

integer

A boundary value of the range.

0

EnterpriseEditionIntervalValue

array

The valid value range for Enterprise Edition, specified as [min, max].

integer

A boundary value of the range.

0

Exemplos

Resposta de sucesso

JSON formato

{
  "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": false,
              "ControllerValueType": "Integer",
              "UserConfigValue": "20",
              "BasicEditionDefaultValue": "10000",
              "StandardEditionDefaultValue": "10000",
              "ProfessionalEditionDefaultValue": "10000",
              "EnterpriseEditionDefaultValue": "10000",
              "BasicEditionIntervalValue": [
                0
              ],
              "StandardEditionIntervalValue": [
                0
              ],
              "ProfessionalEditionIntervalValue": [
                0
              ],
              "EnterpriseEditionIntervalValue": [
                0
              ]
            }
          ]
        }
      }
    ]
  }
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.