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

Adiciona um campo sensível definido com base na categoria e no nível de sensibilidade dos dados no Data Security Guard.

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

create

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
TenantId	string	Sim	O ID do locatário. Para obter o ID do locatário, execute as seguintes etapas: faça login no console do DataWorks. Encontre seu espaço de trabalho e acesse a página DataStudio. Na página DataStudio, clique no nome de usuário de login no canto superior direito e clique em Informações do Usuário na seção Menu.	10241024
AccountName	string	Sim	A conta Alibaba Cloud usada para criar uma regra de identificação de dados sensíveis. Insira o nome de usuário da conta Alibaba Cloud.	dsg-uat
SensitiveName	string	Sim	O nome do campo sensível personalizado. Insira uma string com menos de 128 caracteres.	name
TemplateId	string	Sim	O ID do modelo. Você pode chamar a operação QueryDefaultTemplate para obter o ID do modelo.	e1970541-6cf5-4d23-b101-d5b66f6e1024
NodeId	string	Sim	O ID da categoria de dados. Você pode chamar a operação QuerySensClassification para consultar o ID de todas as categorias de dados. Em seguida, você pode selecionar uma categoria de dados para criar um campo sensível. Insira o ID da categoria de dados selecionada.	0ce67949-0810-400f-a24a-cc5ffafe1024
NodeParent	string	Sim	As informações sobre a categoria de dados pai da categoria de dados atual. Você pode chamar a operação QuerySensClassification para obter o ID de uma categoria de dados.	Customer/personal/personal_Natural _Information/personal basic_profile_information
Level	string	Sim	O nível de sensibilidade do campo sensível. Você pode selecionar um entre todos os níveis de sensibilidade definidos em um modelo como o nível de sensibilidade do campo sensível, como do nível 1 ao nível 10.	1
LevelName	string	Não	O nome do nível de sensibilidade. Você pode chamar a operação QueryDefaultTemplate para obter o nome do nível de sensibilidade no modelo relacionado.	Confidential
SensitiveDescription	string	Não	A descrição do campo sensível. Insira uma string com menos de 128 caracteres.	This is a sensitive field that identifies the name.
OperationType	integer	Sim	O tipo da operação aritmética. Valores válidos: 0: OR 1: AND	0
RecognizeRulesType	string	Não	O tipo da regra de identificação de dados sensíveis. Valores válidos: 1: expressão regular 2: regra integrada 3: biblioteca de amostras 4: modelo de identificação de dados gerado automaticamente	1
RecognizeRules	string	Não	O conteúdo da regra de identificação de dados sensíveis. Você pode chamar a operação QuerySensNodeInfo para consultar o valor do parâmetro atual para um campo sensível integrado.	{"contentRule":{"_clazz":"com.alipay.dsgclient.sdk.dsg.fastscan.engine.cond.GenderCond"},"_clazz":"com.alipay.dsg.dal.model.RuleContent"}
ContentScan	string	Não	Identifica o conteúdo. Você pode chamar a operação QuerySensNodeInfo para consultar o valor do parâmetro atual para um campo sensível integrado.	{"_clazz":"com.alipay.dsgclient.sdk.dsg.fastscan.engine.cond.NationalityCond"}
HitThreshold	integer	Não	O limite da taxa de acerto. Se mais de 60%, que é um limite de taxa de acerto de amostra, de todos os registros de dados de amostra corresponderem ao modelo de Reconhecimento de Entidade Nomeada (NER), o campo sensível será considerado atingido. O valor pode ser um número inteiro de 0 a 100.	50
ColScan	string	Não	Verifica os campos. O sistema identifica apenas campos aos quais valores são atribuídos. O valor deve estar no formato ${Project name}.${Table name}.${Field name} ou ${Project name}.${Schema name}.${Table name}.${Field name}. Há suporte a curingas. Por exemplo, o asterisco () em default.table.column1 pode ser usado para corresponder a qualquer conteúdo após default.table.column1, como default.table.column10.	default.qujian.*
ColExclude	string	Não	Exclui os campos. O sistema não identifica campos aos quais valores são atribuídos. O valor deve estar no formato ${Project name}.${Table name}.${Field name} ou ${Project name}.${Schema name}.${Table name}.${Field name}. Há suporte a curingas. Por exemplo, o asterisco () em default.table.column1 pode ser usado para corresponder a qualquer conteúdo após default.table.column1, como default.table.column10.	default.qujian.*6
CommentScan	string	Não	Verifica o conteúdo. O valor é o texto de cada comentário de campo em seu ativo de dados. Há suporte a correspondência aproximada.	test
Status	integer	Não	O status do campo sensível. Valores válidos: 0: rascunho 1: efetivo	0

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros de resposta.
Success	boolean	Indica se a solicitação foi bem-sucedida. true false	true
ErrorCode	string	O código de erro.	9990030003
ErrorMessage	string	A mensagem de erro.	Missing parameter
HttpStatusCode	integer	O código de status HTTP.	200
Data	any	O resultado retornado no formato JSON.	{ "HttpStatusCode": 200, "Success": true }
RequestId	string	O ID da solicitação.	10000001

Exemplos

Resposta de sucesso

JSON formato

{
  "Success": true,
  "ErrorCode": "9990030003",
  "ErrorMessage": "Missing parameter",
  "HttpStatusCode": 200,
  "Data": "{   \"HttpStatusCode\": 200,   \"Success\": true }",
  "RequestId": "10000001"
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	BADPARAMETERS	Parameters are missing or in the wrong format.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.