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

Crea o actualiza una regla de enmascaramiento de datos.

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

list

*All resources.

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
DesensRules	array<object>	Sí	La colección de reglas de enmascaramiento de datos que se van a crear o actualizar.
	array<object>	No	La información de la regla de enmascaramiento de datos.
Id	integer	No	El ID de la regla de enmascaramiento de datos. Puede llamar a la operación DsgDesensPlanQueryList para consultar el ID.	123
DataType	string	No	El tipo de campo sensible.	phone
RuleName	string	Sí	El nombre de la regla de enmascaramiento de datos.	phone_hash
Status	integer	No	El estado de la regla de enmascaramiento de datos. Valores válidos: 0: Inactivo. 1: Activo.	1
SceneIds	array	Sí	Los escenarios de enmascaramiento de datos de nivel 2.
	integer	No	El ID del escenario de enmascaramiento de datos de nivel 2. El escenario de enmascaramiento de datos de nivel 2 especificado aquí no debe tener configurada una regla de enmascaramiento de datos para el tipo de campo sensible especificado por el parámetro DataType. Puede llamar a la operación DsgSceneQuerySceneListByName para consultar el ID del escenario de enmascaramiento de datos.	123
Owner	string	Sí	El propietario de la regla de enmascaramiento de datos.	test_user
CheckWatermark	boolean	No	Especifica si se debe agregar una marca de agua. Valores válidos: true: Sí. false: No.	true
DesensPlan	object	Sí	El plan de enmascaramiento de datos.
DesensPlanType	string	Sí	El método de enmascaramiento de datos configurado en la regla de enmascaramiento de datos. Valores válidos: hash: Hashing. mapping: Pseudonimización. mask: Enmascaramiento. charreplacement: Reemplazo de caracteres. intervalselect: Transformación de intervalos. decimalpoint: Redondeo. emptydesens: Anulación.	hash
ExtParam	object	No	Los parámetros de la regla de enmascaramiento de datos.
	any	No	La configuración de parámetros de la regla de enmascaramiento de datos. Agregue diferentes parámetros según la regla de enmascaramiento de datos que desee configurar. Para obtener más información, consulte los siguientes ejemplos.	{ "algo": "MD5", "salt":6 }
emptyNotDesens	boolean	No	Especifica si se deben mantener los valores nulos sin enmascarar. Un valor true indica que los valores nulos no se enmascaran. Un valor false indica que los valores nulos se procesan según la regla.
columns	array<object>	No	La lista de columnas asociadas con la regla de enmascaramiento de datos.
	object	No
dbType	string	Sí	El tipo de origen de datos.	ODPS.ODPS
project	string	Sí	El nombre del proyecto.	test_dev
table	string	Sí	El nombre de la tabla.	test_table_dev
column	string	Sí	El nombre de la columna.	test_col_dev

ExtParam es un parámetro dinámico y varía según la regla de enmascaramiento de datos. Los siguientes ejemplos son solo de referencia:

Hashing:
{
    "algo": "MD5",
    "salt": 6
}
Pseudonimización:
{
    "charset": "Aa",
    "salt": 6
}
Enmascaramiento:
{
    "before": 3,
    "after": 4
}
Enmascaramiento personalizado:
{
    "separatorList": [
        {
            "desens": true,
            "left": 3
        },
        {
            "desens": false,
            "left": 6
        },
        {
            "desens": true,
            "left": -99
        }
    ]
}
Reemplazo de caracteres por valor de muestra:
{
    "library": "test_library",
    "position": 3
}
Reemplazo de caracteres por valor fijo:
{
    "replace": "repData",
    "position": 3
}
Reemplazo de caracteres aleatorio:
{
    "replace": "repData"
}
Reemplazo de caracteres personalizado:
{
    "separatorList": [
        {
            "desensParam": {
                "replace": "repData"
            },
            "left": 3
        },
        {
            "desensParam": {
                "library": "test_library"
            },
            "left": 6
        },
        {
            "desensParam": {
            },
            "left": 99
        }
    ]
}
Transformación de intervalos:
{
    "intervalselects": [
        {
            "desens": "1",
            "interval": [
                "1",
                "100"
            ]
        }
    ]
}
Redondeo:
{
"point":3
}
Anulación:
{}

Para obtener más información sobre los métodos de enmascaramiento de datos admitidos y las reglas relacionadas, puede llamar a la operación DsgQueryDefaultTemplates.

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	OpenApiResultModel
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.	1029030003
ErrorMessage	string	El mensaje de error.	param error
HttpStatusCode	integer	El código de estado HTTP.	400
Data	boolean	El resultado de la ejecución de la operación de creación o actualización.	true
RequestId	string	El ID de la solicitud. Puede utilizar el ID para localizar registros y solucionar problemas.	102400001

Ejemplos

Respuesta exitosa

JSON Formato

{
  "Success": true,
  "ErrorCode": "1029030003",
  "ErrorMessage": "param error",
  "HttpStatusCode": 400,
  "Data": true,
  "RequestId": "102400001"
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
400	PARAMS.ERROR	param error.	El parámetro no es válido.
400	DESENSPLAN.DATATYPE.ERROR	Sensitive type already has a desensitization rule.	Ya se ha configurado una regla de enmascaramiento de datos para el tipo de datos sensibles.
400	DESENSPLAN.DATATYPENOTEXIST.ERROR	Sensitive type not exist.	El tipo de datos sensibles no existe.
400	DESENSPLAN.ID.ERROR	Desensitization rule ID does not exist.	El ID de la regla de enmascaramiento de datos no existe.
400	DESENSPLAN.PAGESIZE.ERROR	Page size is too large, maximum of 100.	El tamaño de página supera el límite. El valor máximo es 100.
400	DESENSPLAN.PARAM.ERROR	Desensitization rule parameter error.	El parámetro de la regla de enmascaramiento de datos no es válido.
400	DESENSPLAN.SCENECODE.ERROR	Scene code does not exist.	El código del escenario no existe.
400	DESENSPLAN.SCENEID.ERROR	Scene ID does not exist.	El ID del escenario no existe.
400	DESENSPLAN.SCENEIDLEVEL.ERROR	The scene is not a secondary scene.	El escenario no es un escenario de nivel 2.
400	DESENSPLAN.SIZE.ERROR	The number of desens plan exceeds the limit.	El número de reglas de enmascaramiento de datos supera el límite.
500	UNKNOWN.ERROR	unknown error.	Se produjo un error desconocido.
403	PERMISSION.DENIED.ERROR	Permission denied	No tiene permisos suficientes.

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.