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

Obtém os modelos de tipo de dados sensíveis disponíveis e as regras de desensibilização compatíveis. Use a resposta desta API para configurar suas regras de desensibilizaçã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:QueryDefaultTemplates

list

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
SceneId	integer	Sim	O ID do cenário de desensibilização de nível 2. Chame a API DsgSceneQuerySceneListByName para obter este ID.	123

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os dados da resposta.
Success	boolean	Indica se a solicitação foi bem-sucedida. Valores válidos: true: A solicitação foi bem-sucedida. false: A solicitação falhou.	true
ErrorCode	string	O código de erro retornado se a solicitação falhar.	1029030003
ErrorMessage	string	A mensagem de erro retornada se a solicitação falhar.	param error
HttpStatusCode	integer	O código de status HTTP retornado.	400
Data	array<object>	Os dados retornados.
	array<object>	Um objeto que representa um modelo de tipo de dados sensíveis.
DataType	string	O tipo de dados sensíveis.	phone
DesensPlanTemplate	object	Uma lista de métodos de desensibilização compatíveis e suas descrições de parâmetros.
	array<object>	O método de desensibilização e seus parâmetros.
	object	O método de desensibilização e seus parâmetros.
Name	string	The name of the Desensitization Method.	hash
SupportWaterMark	boolean	Indicates whether watermarking is supported. Valid values: true: Watermarking is supported. false: Watermarking is not supported.	true
ExtParamTemplate	array	A list of Desensitization Parameters and their descriptions.
	any	A JSON object that describes the supported Desensitization Rules and their parameter configurations. This object is for reference only and cannot be used as direct input to create or modify Desensitization Rules.	{ "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. Você pode usar este ID para 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.	Scene ID does not exist.
400	DESENSTEMPLATE.SCENELEVEL.ERROR	The scene is not a secondary scene.	The scene is not a secondary scene.
400	PARAMS.ERROR	param error.
500	UNKNOWN.ERROR	unknown error.	Unknown error.
403	PERMISSION.DENIED.ERROR	Permission denied	Insufficient permissions.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.