GetSecurityStrategy - DataWorks: Central de Documentação do Alibaba Cloud

Obtém os detalhes de uma política de segurança com base no ID da política de segurança fornecido.

Descrição da operação

Descrição da solicitação\n- Esta API obtém todas as informações de configuração de uma política de segurança específica usando o ID da política de segurança especificado.\n- Certifique-se de que o valor do parâmetro `Id` fornecido seja válido e exista. Caso contrário, uma mensagem de erro será retornada.\n- A estrutura de dados retornada inclui as informações básicas da política, como nome e descrição, e o conteúdo detalhado da política, como itens de controle e suas configurações.\n- Observação: Alguns campos das políticas padrão do sistema podem estar protegidos contra modificação ou exclusão.

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

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

dataworks:GetSecurityStrategy

get

*All resources.

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
Id	integer	Sim	O ID da política de segurança.	13

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Esquema da resposta.
RequestId	string	O ID da solicitação de API.	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.	Default Data Analysis policy
Description	string	A descrição da política.	Controls the security behavior of query results in the Data Analysis module
SchemaName	string	O nome do modelo de esquema. Valores válidos: DataStudioMyCatalogSecurityStrategySchema : O esquema de política de segurança do catálogo de dados pessoais do Data Studio. DataQuerySecurityStrategySchema : O esquema de política de segurança do Data Analysis. DataStudioSecurityStrategySchema : O esquema de política de segurança do Data Studio.	DataQuerySecurityStrategySchema
ControlModule	string	O módulo de controle. Valores válidos: DataStudio : Data Studio. DataQuery : Data Analysis.	DataQuery
ControlSubModule	string	O submódulo de controle. Valores válidos: MyCatalog : Catálogo de dados pessoais.	MyCatalog
ControlDwScope	string	O escopo de controle (Workspace/Tenant). Valores válidos: Tenant : Tenant. Workspace : Workspace.	Tenant
Workspaces	array	A lista de IDs de workspace associados.
	integer	O ID do workspace.	4843434
Enabled	boolean	Especifica se a política está ativada.	true
OriginPolicyId	integer	O ID de origem da política padrão do sistema.	12
Creator	string	O ID de usuário do criador.	203322746501002787
Updater	string	O ID de usuário do último atualizador.	203322746501002787
CreateTime	string	A hora de criação. O formato é AAAA-MM-DDTHH:mm:ss. O fuso horário não é especificado no documento atual.	2026-05-25T20:46:19
UpdateTime	string	A hora de atualização. O formato é AAAA-MM-DDTHH:mm:ss. O fuso horário não é especificado no documento atual.	2026-05-25T20:46:19
Content	object	O conteúdo da política. O conteúdo é restringido pelo SecurityStrategySchema.
Name	string	O SecurityStrategySchema.name associado à política atual. Valores válidos: DataStudioMyCatalogSecurityStrategySchema : O esquema de política de segurança do catálogo de dados pessoais do Data Studio. DataQuerySecurityStrategySchema : O esquema de política de segurança do Data Analysis. DataStudioSecurityStrategySchema : O esquema de política de segurança do Data Studio.	DataQuerySecurityStrategySchema
DisplayName	string	O SecurityStrategySchema.displayName associado à política atual.	Data Analysis
DisplayNameEn	string	O SecurityStrategySchema.displayNameEn associado à política atual.	Data Query
ControlModule	string	O módulo de controle. O SecurityStrategySchema.controlModule associado à política atual. Valores válidos: DataStudio : Data Studio. DataQuery : Data Analysis.	DataQuery
ControlSubModule	string	O submódulo de controle. O SecurityStrategySchema.controlSubModule associado à política atual. Valores válidos: MyCatalog : Catálogo de dados pessoais.	MyCatalog
ControlDwScope	string	O escopo efetivo. Valores válidos: Tenant : Tenant. Workspace : Workspace.	Tenant
SystemPolicyName	string	O nome da política do sistema. Se este parâmetro não estiver vazio, o sistema executará a criação automática de uma política padrão.	SYSTEM_GENERATE_DEFAULT_DATA_QUERY
SystemPolicyDisplayName	string	O nome de exibição da política do sistema.	Default system generate data query policy
Controllers	array<object>	A lista de itens de controle.\n\nObservação: Os itens de controle válidos dependem do esquema selecionado. Consulte a definição do controlador e a lista de itens de controle para cada esquema.
	object	O item de controle.
Controller	string	O identificador do item de controle. Para valores válidos, consulte a lista de itens de controle para cada esquema.	viewCount
DisplayName	string	O nome de exibição.	Query results - Maximum number of records displayed at a time
DisplayNameEn	string	O nome de exibição em inglês.	Query Results - Single Display Record Limit
Enable	boolean	Especifica se o item de controle está ativado.	true
ControllerValueType	string	O tipo de valor (Boolean/Integer/Long/String).	Integer
UserConfigValue	any	O valor configurado pelo usuário. O tipo depende de ControllerValueType.	10
BasicEditionDefaultValue	any	O valor padrão para a Basic Edition.	10000
StandardEditionDefaultValue	any	O valor padrão para a Standard Edition.	10000
ProfessionalEditionDefaultValue	any	O valor padrão para a Professional Edition.	10000
EnterpriseEditionDefaultValue	any	O valor padrão para a Enterprise Edition.	10000
BasicEditionIntervalValue	array	O intervalo de valores válidos [min, max] para a Basic Edition.
	integer	Os valores inicial e final do intervalo.	0
StandardEditionIntervalValue	array	O intervalo de valores válidos [min, max] para a Standard Edition.
	integer	Os valores inicial e final do intervalo.	0
ProfessionalEditionIntervalValue	array	O intervalo de valores válidos [min, max] para a Professional Edition.
	integer	Os valores inicial e final do intervalo.	0
EnterpriseEditionIntervalValue	array	O intervalo de valores válidos [min, max] para a Enterprise Edition.
	integer	Os valores inicial e final do intervalo.	0

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "0bc5df3a17****903790e8e8a",
  "SecurityStrategy": {
    "Id": 13,
    "Name": "Default data analytics policy",
    "Description": "Controls the security behavior of query results in the data analytics module",
    "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": "Data analytics",
      "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": "Query results - Maximum number of records displayed at a time",
          "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.