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

Chama a operação DsgQueryDefaultTemplates para consultar a lista de modelos de tipos de dados confidenciais disponíveis e as regras de mascaramento suportadas pelos modelos. Você pode consultar os parâmetros de resposta desta operação para configurar regras 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:QueryDefaultTemplates

list

*All resources.

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
SceneId	integer	Sim	O ID do cenário de mascaramento secundário. Você pode chamar a operação DsgSceneQuerySceneListByName para obter o ID.	123

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	OpenApiResultModel<List>
Success	boolean	Indica se a chamada foi bem-sucedida. Valores válidos: true: A chamada foi bem-sucedida. false: A chamada falhou.	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.
DataType	string	O tipo de campo confidencial.	phone
DesensPlanTemplate	object	A lista de métodos de mascaramento suportados e as descrições dos parâmetros.
	array<object>	O método de mascaramento e as informações dos parâmetros.
	object	O método de mascaramento e as informações dos parâmetros.
Name	string	O nome do método de mascaramento.	hash
SupportWaterMark	boolean	Indica se a adição de marcas d'água é permitida. Valores válidos: true: Permitido. false: Não permitido.	true
ExtParamTemplate	array	A lista de parâmetros de mascaramento e suas descrições.
	any	A referência para as regras de mascaramento suportadas e as configurações de parâmetros relacionadas no formato JSON. O resultado retornado serve apenas como uma explicação para os parâmetros relacionados às regras de mascaramento e não pode ser usado diretamente como parâmetros de entrada para criar ou editar regras de mascaramento.	{ "key": "algo", "valueEnum": [ "MD5", "SHA256", "SHA512", "SM3" ], "valueType": "string" }, { "key": "salt", "valueEnum": [ 1, 2, 3, 4, 5, 6, 7, 8, 9 ], "valueType": "int" }
RequestId	string	O ID da solicitação. É usado para localizar logs e solucionar problemas.	102400001

Exemplos

Resposta de sucesso

JSON formato

{
  "Success": true,
  "ErrorCode": "1029030003",
  "ErrorMessage": "param error",
  "HttpStatusCode": 400,
  "Data": [
    {
      "DataType": "phone",
      "DesensPlanTemplate": {
        "key": [
          {
            "Name": "hash",
            "SupportWaterMark": true,
            "ExtParamTemplate": [
              "{                     \"key\": \"algo\",                     \"valueEnum\": [                         \"MD5\",                         \"SHA256\",                         \"SHA512\",                         \"SM3\"                     ],                     \"valueType\": \"string\"                 },                 {                     \"key\": \"salt\",                     \"valueEnum\": [                         1,                         2,                         3,                         4,                         5,                         6,                         7,                         8,                         9                     ],                     \"valueType\": \"int\"                 }"
            ]
          }
        ]
      }
    }
  ],
  "RequestId": "102400001"
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	DESENSTEMPLATE.SCENE.ERROR	Scene ID does not exist.	O ID do cenário não existe.
400	DESENSTEMPLATE.SCENELEVEL.ERROR	The scene is not a secondary scene.	O cenário não é um cenário de nível 2.
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.