AddRecognizeRule - DataWorks - Centro de documentación de Alibaba Cloud

Agrega un campo sensible definido por las reglas de clasificación y graduación de datos de Data Security Guard.

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

dataworks:AddRecognizeRule

create

*All Resource

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
TenantId	string	Sí	El ID del inquilino. Para obtener el ID del inquilino, inicie sesión en la consola de DataWorks, vaya a la página de Data Studio, haga clic en el nombre de usuario en la esquina superior derecha y seleccione Menú > Información de usuario.	10241024
AccountName	string	Sí	La cuenta de Alibaba Cloud que crea la regla de reconocimiento de datos sensibles. Ingrese el nombre de usuario.	dsg-uat
SensitiveName	string	Sí	El nombre personalizado del campo sensible. El valor debe ser una cadena de menos de 128 caracteres.	name
TemplateId	string	Sí	El ID de la plantilla. Puede llamar a la operación QueryDefaultTemplate para obtener el ID de la plantilla predeterminada actual.	e1970541-6cf5-4d23-b101-****
NodeId	string	Sí	El ID del nodo de clasificación. Puede llamar a la operación QuerySensClassification para obtener todos los ID de los nodos y seleccionar un nodo para crear un campo sensible. Ingrese el ID del nodo seleccionado.	0ce67949-0810-400f-a24a-****
NodeParent	string	Sí	La información del nodo padre del nodo de clasificación. Puede llamar a la operación QuerySensClassification para obtener esta información.	Customer/personal/personal_Natural _Information/personal basic_profile_information
Level	string	Sí	El nivel de sensibilidad del campo sensible. Seleccione un nivel definido en la plantilla para el nuevo campo sensible, por ejemplo, los niveles del 1 al 10.	1
LevelName	string	No	El nombre del nivel de sensibilidad. Puede llamar a la operación QueryDefaultTemplate para obtener el nombre del nivel seleccionado en la plantilla. Nota: Este parámetro es obligatorio para el servicio actual. Si se omite, se devuelve un error 400 (InternalError.Bad.Parameters: levelName not empty).	Confidential
SensitiveDescription	string	No	La descripción del campo sensible. El valor debe ser una cadena de menos de 128 caracteres.	This is a sensitive field that identifies the name.
OperationType	integer	Sí	El tipo de operación. Valores válidos: 0: OR 1: AND	0
RecognizeRulesType	string	No	El tipo de regla de reconocimiento de datos sensibles. Valores válidos: 1: expresión regular 2: regla integrada 3: biblioteca de muestras 4: modelo autogenerado	1
RecognizeRules	string	No	El contenido de la regla de reconocimiento de datos sensibles. Puede llamar a la operación QuerySensNodeInfo y consultar la configuración del mismo campo en las reglas integradas.	{"contentRule":{"_clazz":"com.alipay.dsgclient.sdk.dsg.fastscan.engine.cond.GenderCond"},"_clazz":"com.alipay.dsg.dal.model.RuleContent"}
ContentScan	string	No	La configuración de reconocimiento de contenido. Puede llamar a la operación QuerySensNodeInfo y consultar la configuración del mismo campo en las reglas integradas.	{"_clazz":"com.alipay.dsgclient.sdk.dsg.fastscan.engine.cond.NationalityCond"}
HitThreshold	integer	No	El umbral de coincidencia. Si el porcentaje de datos muestreados que coincide con el modelo de reconocimiento de entidades nombradas (NER) supera el umbral, por ejemplo, el 60%, se considera que los datos coinciden con el campo sensible. Valores válidos: un número entero del 0 al 100.	50
ColScan	string	No	La configuración de escaneo de campos. Solo se reconocen los campos especificados. Formato: ${project}.${table}.${field} o ${project}.${schema}.${table}.${field}. Se admite el comodín de asterisco (). Por ejemplo, default.table.column1 puede coincidir con default.table.column10 y cualquier otro contenido que siga al asterisco.	default.qujian.*
ColExclude	string	No	La configuración de exclusión de campos. Los campos especificados no se reconocen. Formato: ${project}.${table}.${field} o ${project}.${schema}.${table}.${field}. Se admite el comodín de asterisco (). Por ejemplo, default.table.column1 puede coincidir con default.table.column10 y cualquier otro contenido que siga al asterisco.	default.qujian.*6
CommentScan	string	No	La configuración de escaneo de comentarios. El valor es el texto del comentario de cada campo en sus activos de datos. Se admite la coincidencia aproximada.	test
Status	integer	No	El estado del campo sensible. Valores válidos: 0: borrador 1: activo	0

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Los datos de la respuesta.
Success	boolean	Indica si la llamada se realizó correctamente. Valores válidos: true: La llamada se realizó correctamente. false: La llamada falló.	true
ErrorCode	string	El código de error.	9990030003
ErrorMessage	string	El mensaje de error.	Missing parameter
HttpStatusCode	integer	El código de estado HTTP.	200
Data	any	El resultado devuelto en formato JSON.	{ "HttpStatusCode": 200, "Success": true }
RequestId	string	El ID de la solicitud.	10000001

Ejemplos

Respuesta exitosa

JSON Formato

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

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
400	BADPARAMETERS	Parameters are missing or in the wrong format.

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.