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

Adiciona um campo sensível definido pelas regras de classificação e graduação de dados do 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, faça login no console do DataWorks, acesse a página Data Studio, clique no nome de usuário no canto superior direito e escolha Menu > Informações do Usuário.	10241024
AccountName	string	Sim	A conta Alibaba Cloud que cria a regra de reconhecimento de dados sensíveis. Insira o nome de usuário.	dsg-uat
SensitiveName	string	Sim	O nome personalizado do campo sensível. O valor deve ser 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 padrão atual.	e1970541-6cf5-4d23-b101-****
NodeId	string	Sim	O ID do nó de classificação. Você pode chamar a operação QuerySensClassification para obter todos os IDs de nó e selecionar um nó para criar um campo sensível. Insira o ID do nó selecionado.	0ce67949-0810-400f-a24a-****
NodeParent	string	Sim	As informações do nó pai do nó de classificação. Você pode chamar a operação QuerySensClassification para obter as informações.	Customer/personal/personal_Natural _Information/personal basic_profile_information
Level	string	Sim	O nível de sensibilidade do campo sensível. Selecione um nível definido no modelo para o novo campo sensível, como os níveis de 1 a 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 selecionado no modelo. Nota: Este parâmetro é obrigatório para o serviço atual. Se for omitido, um erro 400 (InternalError.Bad.Parameters: levelName not empty) será retornado.	Confidential
SensitiveDescription	string	Não	A descrição do campo sensível. O valor deve ser uma string com menos de 128 caracteres.	This is a sensitive field that identifies the name.
OperationType	integer	Sim	O tipo de operação. Valores válidos: 0: OR 1: AND	0
RecognizeRulesType	string	Não	O tipo da regra de reconhecimento de dados sensíveis. Valores válidos: 1: expressão regular 2: regra integrada 3: biblioteca de amostras 4: modelo autogerado	1
RecognizeRules	string	Não	O conteúdo da regra de reconhecimento de dados sensíveis. Você pode chamar a operação QuerySensNodeInfo e consultar a configuração do mesmo campo nas regras integradas.	{"contentRule":{"_clazz":"com.alipay.dsgclient.sdk.dsg.fastscan.engine.cond.GenderCond"},"_clazz":"com.alipay.dsg.dal.model.RuleContent"}
ContentScan	string	Não	A configuração de reconhecimento de conteúdo. Você pode chamar a operação QuerySensNodeInfo e consultar a configuração do mesmo campo nas regras integradas.	{"_clazz":"com.alipay.dsgclient.sdk.dsg.fastscan.engine.cond.NationalityCond"}
HitThreshold	integer	Não	O limite de correspondência. Se a porcentagem de dados amostrados que correspondem ao modelo de reconhecimento de entidade nomeada (NER) exceder o limite, como 60%, os dados serão considerados como correspondentes ao campo sensível. Valores válidos: um número inteiro de 0 a 100.	50
ColScan	string	Não	A configuração de verificação de campos. Apenas os campos especificados são reconhecidos. Formato: ${project}.${table}.${field} ou ${project}.${schema}.${table}.${field}. O curinga asterisco () é suportado. Por exemplo, default.table.column1 pode corresponder a default.table.column10 e a qualquer outro conteúdo que siga o asterisco.	default.qujian.*
ColExclude	string	Não	A configuração de exclusão de campos. Os campos especificados não são reconhecidos. Formato: ${project}.${table}.${field} ou ${project}.${schema}.${table}.${field}. O curinga asterisco () é suportado. Por exemplo, default.table.column1 pode corresponder a default.table.column10 e a qualquer outro conteúdo que siga o asterisco.	default.qujian.*6
CommentScan	string	Não	A configuração de verificação de comentários. O valor é o texto do comentário de cada campo em seus ativos de dados. A correspondência aproximada é suportada.	test
Status	integer	Não	O status do campo sensível. Valores válidos: 0: rascunho 1: ativo	0

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os dados da resposta.
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.	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.