Todos os produtos
Search
Central de documentação

DataWorks:GetSecurityStrategy

Última atualização: Jun 26, 2026

Obtém os detalhes de uma política de segurança pelo seu ID. Esta operação requer permissões de administrador de tenant do DataWorks e de administrador de segurança.

Descrição da operação

Solicitação

  • Esta API obtém as informações completas de configuração de uma política de segurança pelo seu ID.

  • A API retorna uma mensagem de erro se o Id fornecido for inválido ou não existir.

  • A resposta inclui informações básicas da política, como nome e descrição, e detalhes da política, como itens de controle e suas configurações.

  • Observação: Alguns campos em uma política padrão do sistema não podem ser modificados ou excluídos.

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

Id

integer

Sim

O ID da estratégia de segurança..

13

Elementos de resposta

Elemento

Tipo

Descrição

Exemplo

object

O esquema da resposta.

RequestId

string

O ID da solicitação.

0bc5df3a17****903790e8e8a

SecurityStrategy

object

A política de segurança.

Id

integer

O ID da política.

13

Name

string

O nome da política.

默认数据分析策略

Description

string

A descrição da política.

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

SchemaName

string

O nome do modelo de esquema.

DataQuerySecurityStrategySchema

ControlModule

string

O módulo de controle.

DataQuery

ControlSubModule

string

O submódulo de controle.

MyCatalog

ControlDwScope

string

O escopo no qual a política é efetiva. Valores válidos: Workspace ou Tenant.

Tenant

Workspaces

array

A lista de IDs de workspace associados.

integer

O ID do workspace.

4843434

Enabled

boolean

Indica se a política de segurança está ativada.

true

OriginPolicyId

integer

O ID de origem da política padrão do sistema.

12

Creator

string

O ID do criador.

203322746501002787

Updater

string

O ID do último atualizador.

203322746501002787

CreateTime

string

A hora em que a política de segurança foi criada.

2026-05-25T20:46:19

UpdateTime

string

A hora em que a política de segurança foi atualizada pela última vez.

2026-05-25T20:46:19

Content

object

O conteúdo da política de segurança. Sua estrutura é definida pelo SecurityStrategySchema.

Name

string

The name field from the associated SecurityStrategySchema.

DataQuerySecurityStrategySchema

DisplayName

string

The displayName field from the associated SecurityStrategySchema.

数据分析

DisplayNameEn

string

The displayNameEn field from the associated SecurityStrategySchema.

Data Query

ControlModule

string

The control module. This value corresponds to controlModule in the associated SecurityStrategySchema.

DataQuery

ControlSubModule

string

The control submodule. This value corresponds to controlSubModule in the associated SecurityStrategySchema.

MyCatalog

ControlDwScope

string

The scope where the policy is effective. Valid values:

Valores válidos:

  • Tenant :

    Applies at the tenant level.

  • Workspace :

    Applies at the workspace level.

Tenant

SystemPolicyName

string

The name of the system policy. If specified, a default policy is automatically created.

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 controllers.

Note: The available controllers depend on the selected schema. See the documentation for your schema for a list of valid controllers.

object

A controller.

Controller

string

The identifier for the controller. For valid values, see the documentation for the relevant schema.

viewCount

DisplayName

string

The display name.

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

DisplayNameEn

string

The display name in English.

Query Results - Single Display Record Limit

Enable

boolean

Whether the controller is enabled.

true

ControllerValueType

string

The value type of the controller. Valid values are Boolean, Integer, Long, and String.

Integer

UserConfigValue

any

The value configured by the user. The data type of this value is specified by the ControllerValueType parameter.

10

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 an array [min, max].

integer

The start or end value of the range.

0

StandardEditionIntervalValue

array

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

integer

The start or end value of the range.

0

ProfessionalEditionIntervalValue

array

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

integer

The start or end value of the range.

0

EnterpriseEditionIntervalValue

array

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

integer

The start or end value of the range.

0

Exemplos

Resposta de sucesso

JSON formato

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

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.