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

Consulta a lista de cenários de mascaramento.

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:DsgSceneQuerySceneListByName

list

*All resources.

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
SceneName	string	Não	A palavra-chave de correspondência aproximada para o nome do cenário de mascaramento. A plataforma recupera informações relacionadas ao cenário de mascaramento com base nessa palavra-chave.	dev_

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	OpenApiResultModel<List>
Success	boolean	Indica se a chamada é bem-sucedida. Valores válidos: true: A chamada é bem-sucedida. false: A chamada falha.	true
ErrorCode	string	O código de erro.	1029030003
ErrorMessage	string	A mensagem de erro.	param error
HttpStatusCode	integer	O código de status HTTP.	400
Data	array<object>	Os dados retornados.
	array<object>	Os dados retornados.
Id	integer	O ID do cenário de mascaramento.	123
SceneCode	string	O código do cenário de mascaramento de nível 1. Valores válidos: dataworks_display_desense_code: mascaramento para exibição no Data Studio e Data Map maxcompute_desense_code: mascaramento na camada do mecanismo MaxCompute maxcompute_new_desense_code: mascaramento na camada do mecanismo MaxCompute (novo) hologres_display_desense_code: mascaramento na camada do mecanismo Hologres dataworks_data_integration_desense_code: mascaramento de dados estáticos para o Data Integration dataworks_analysis_desense_code: mascaramento para exibição no Data Analysis	dataworks_display_desense_code
Desc	string	A descrição do cenário de mascaramento.	Test scenarios
SceneName	string	O nome do cenário de mascaramento.	test_scene
UserGroups	string	A lista de nomes de grupos de usuários para o cenário de mascaramento. Vários nomes são separados por vírgulas (,).	user1,user2
SceneLevel	integer	O nível do cenário de mascaramento. Valores válidos: 0: cenário de nível 1 1: cenário de nível 2	1
Projects	array<object>	As informações do mecanismo onde o cenário de mascaramento tem efeito.
	object	As informações do mecanismo onde o cenário de mascaramento tem efeito.
DbType	string	O tipo de mecanismo. Valores válidos: ODPS: ODPS.ODPS HOLO: HOLO.POSTGRES EMR: EMR	ODPS.ODPS
ProjectName	string	O nome da instância do mecanismo.	dev_project
ClusterId	string	O ID do cluster EMR. Este parâmetro é retornado apenas quando o escopo de dados no qual o cenário de mascaramento tem efeito é um mecanismo EMR.	c-123456
Children	array	As informações de parâmetros dos cenários de mascaramento multinível.
	any	Se existirem cenários de mascaramento multinível, o que significa que os cenários de mascaramento possuem nós pai e filho aninhados, este campo contém as informações do cenário de mascaramento aninhado. Os parâmetros são os mesmos que os parâmetros externos.	$ref
scenceDbType	string	O tipo de fonte de dados do cenário de mascaramento.
RequestId	string	O ID da solicitação. Você pode usar o ID para localizar logs e solucionar problemas.	102400001

Exemplos

Resposta de sucesso

JSON formato

{
  "Success": true,
  "ErrorCode": "1029030003",
  "ErrorMessage": "param error",
  "HttpStatusCode": 400,
  "Data": [
    {
      "Id": 123,
      "SceneCode": "dataworks_display_desense_code",
      "Desc": "Test scenarios",
      "SceneName": "test_scene",
      "UserGroups": "user1,user2",
      "SceneLevel": 1,
      "Projects": [
        {
          "DbType": "ODPS.ODPS",
          "ProjectName": "dev_project",
          "ClusterId": "c-123456"
        }
      ],
      "Children": [
        "$ref"
      ],
      "scenceDbType": ""
    }
  ],
  "RequestId": "102400001"
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	DESENSSCENE.ID.ERROR	The desensitization scenario ID does not match or does not exist with the tenant.	O ID do cenário não existe ou não pertence a este tenant.
400	DESENSSCENE.IDLEVEL.ERROR	The desensitization scenario is not a secondary scenario.	O cenário de mascaramento de dados não é um cenário de nível 2.
400	DESENSSCENE.PROJECT.ERROR	The project space does not exist.	O workspace não existe.
400	DESENSSCENE.SIZE.ERROR	The number of desens scene exceeds the limit.	O número de cenários de mascaramento de dados excede o limite.
400	DESENSSCENE.UESRGROUP.ERROR	The user group ID does not match the tenant or does not exist.	O ID do grupo de usuários não existe ou não pertence a este tenant.
400	PARAMS.ERROR	param error.	O parâmetro é inválido.
500	UNKNOWN.ERROR	unknown error.	Ocorreu um erro desconhecido.
403	PERMISSION.DENIED.ERROR	Permission denied	Você não tem permissões suficientes.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.