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

Cria ou atualiza uma regra de mascaramento de dados.

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

list

*All resources.

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
DesensRules	array<object>	Sim	A coleção de regras de mascaramento de dados a serem criadas ou atualizadas.
	array<object>	Não	As informações da regra de mascaramento de dados.
Id	integer	Não	O ID da regra de mascaramento de dados. Você pode chamar a operação DsgDesensPlanQueryList para consultar o ID.	123
DataType	string	Não	O tipo de campo sensível. O valor é obtido a partir dos modelos de tipo de dados sensíveis disponíveis para o locatário atual. Você pode chamar a operação DsgQueryDefaultTemplates para consultar os modelos e suas regras de mascaramento de dados suportadas.	phone
RuleName	string	Sim	O nome da regra de mascaramento de dados.	phone_hash
Status	integer	Não	O status efetivo da regra de mascaramento de dados. Valores válidos: 0: Inativo. 1: Ativo.	1
SceneIds	array	Sim	Os cenários de mascaramento de dados de nível 2.
	integer	Não	O ID do cenário de mascaramento de dados de nível 2. O cenário de mascaramento de dados de nível 2 especificado aqui não deve ter uma regra de mascaramento de dados configurada para o tipo de campo sensível especificado pelo parâmetro DataType. Você pode chamar a operação DsgSceneQuerySceneListByName para consultar o ID do cenário de mascaramento de dados.	123
Owner	string	Sim	O proprietário da regra de mascaramento de dados.	test_user
CheckWatermark	boolean	Não	Especifica se deve ser adicionada uma marca d'água. Valores válidos: true: Sim. false: Não.	true
DesensPlan	object	Sim	O plano de mascaramento de dados.
DesensPlanType	string	Sim	O método de mascaramento de dados configurado no plano de mascaramento de dados. Valores válidos: hash: Hashing. mapping: Pseudonimização. mask: Mascaramento. charreplacement: Substituição de caracteres. intervalselect: Transformação de intervalo. decimalpoint: Arredondamento. emptydesens: Nulificação.	hash
ExtParam	object	Não	Os parâmetros do plano de mascaramento de dados.
	any	Não	As configurações de parâmetros do plano de mascaramento de dados. Adicione diferentes parâmetros com base na regra de mascaramento de dados que você deseja configurar. Para mais informações, consulte os exemplos a seguir.	{ "algo": "MD5", "salt":6 }
emptyNotDesens	boolean	Não	Especifica se os valores nulos devem ser mantidos sem mascaramento. Um valor true indica que os valores nulos não são mascarados. Um valor false indica que os valores nulos são processados com base na regra.
columns	array<object>	Não	A lista de colunas associadas à regra de mascaramento de dados.
	object	Não
dbType	string	Sim	O tipo de fonte de dados.	ODPS.ODPS
project	string	Sim	O nome do espaço de trabalho.	test_dev
table	string	Sim	O nome da tabela.	test_table_dev
column	string	Sim	O nome da coluna.	test_col_dev

ExtParam é um parâmetro dinâmico. A configuração varia com base na regra de mascaramento de dados. Consulte os exemplos a seguir:

Hashing:
{
    "algo": "MD5",
    "salt": 6
}
Pseudonimização:
{
    "charset": "Aa",
    "salt": 6
}
Mascaramento:
{
    "before": 3,
    "after": 4
}
Mascaramento personalizado:
{
    "separatorList": [
        {
            "desens": true,
            "left": 3
        },
        {
            "desens": false,
            "left": 6
        },
        {
            "desens": true,
            "left": -99
        }
    ]
}
Substituição de caracteres por valor de amostra:
{
    "library": "test_library",
    "position": 3
}
Substituição de caracteres por valor fixo:
{
    "replace": "repData",
    "position": 3
}
Substituição de caracteres aleatória:
{
    "replace": "repData"
}
Substituição de caracteres personalizada:
{
    "separatorList": [
        {
            "desensParam": {
                "replace": "repData"
            },
            "left": 3
        },
        {
            "desensParam": {
                "library": "test_library"
            },
            "left": 6
        },
        {
            "desensParam": {
            },
            "left": 99
        }
    ]
}
Transformação de intervalo:
{
    "intervalselects": [
        {
            "desens": "1",
            "interval": [
                "1",
                "100"
            ]
        }
    ]
}
Arredondamento:
{
"point":3
}
Nulificação:
{}

Para mais informações sobre os métodos de mascaramento de dados suportados e regras relacionadas, você pode chamar a operação DsgQueryDefaultTemplates.

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	OpenApiResultModel
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.	1029030003
ErrorMessage	string	A mensagem de erro.	param error
HttpStatusCode	integer	O código de status HTTP.	400
Data	boolean	O resultado da execução da operação de criação ou atualização.	true
RequestId	string	O ID da solicitação. Você pode usar o ID para localizar logs e solucionar problemas.	102400001

Exemplos

Resposta de sucesso

JSON formato

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

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	PARAMS.ERROR	param error.	O parâmetro é inválido.
400	DESENSPLAN.DATATYPE.ERROR	Sensitive type already has a desensitization rule.	Uma regra de mascaramento de dados já foi configurada para o tipo sensível.
400	DESENSPLAN.DATATYPENOTEXIST.ERROR	Sensitive type not exist.	O tipo sensível não existe.
400	DESENSPLAN.ID.ERROR	Desensitization rule ID does not exist.	O ID da regra de mascaramento de dados não existe.
400	DESENSPLAN.PAGESIZE.ERROR	Page size is too large, maximum of 100.	O tamanho da página excede o limite. O valor máximo é 100.
400	DESENSPLAN.PARAM.ERROR	Desensitization rule parameter error.	O parâmetro da regra de mascaramento de dados é inválido.
400	DESENSPLAN.SCENECODE.ERROR	Scene code does not exist.	O código do cenário não existe.
400	DESENSPLAN.SCENEID.ERROR	Scene ID does not exist.	O ID do cenário não existe.
400	DESENSPLAN.SCENEIDLEVEL.ERROR	The scene is not a secondary scene.	O cenário não é um cenário de nível 2.
400	DESENSPLAN.SIZE.ERROR	The number of desens plan exceeds the limit.	O número de regras de mascaramento de dados excede o limite.
500	UNKNOWN.ERROR	unknown error.	Ocorreu um erro desconhecido.
403	PERMISSION.DENIED.ERROR	Permission denied	Você não tem permissões suficientes.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.