Todos os produtos
Search

Este produto

    PolarDB:ModifyMaskingRules

    Central de documentação

    PolarDB:ModifyMaskingRules

    Última atualização: Jun 28, 2026

    Modifica ou cria regras 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

    polardb:ModifyMaskingRules

    update

    *DBCluster

    acs:polardb:{#regionId}:{#accountId}:{#resource-type}/{#resource-id}

    		 Nenhuma Nenhuma

    Parâmetros da solicitação

    Parâmetro

    Tipo

    Obrigatório

    Descrição

    Exemplo
    DBClusterId

    string

    Sim

    O ID do cluster.

    Nota

    Você pode chamar a operação DescribeDBClusters para consultar os detalhes de todos os clusters em sua conta, incluindo IDs de cluster.

    pc-*****************
    RuleName

    string

    Não

    O nome da regra de mascaramento de dados. Você pode especificar apenas um nome de regra por vez.

    Nota

    • Você pode chamar a operação DescribeMaskingRules para consultar os detalhes de todas as regras de mascaramento de dados no cluster de destino, incluindo nomes de regras.

    • Se uma regra com o nome especificado não existir, o sistema criará uma nova com base no RuleConfig fornecido.

    testrule
    RuleConfig

    string

    Não

    Uma string JSON que especifica a configuração da regra. Exemplo: {"auto": {"databases": ["db1"], "tables": ["tb1"], "columns": ["c1,c2"] }, "description": "This rule will be applied to the columns c1 and c2 in table t1", "enabled": true, "applies_to": ["user"]}. A string JSON inclui os seguintes campos:

    • "auto": Obrigatório. O objeto que contém a configuração do algoritmo de mascaramento dinâmico de dados.

    • "databases": Opcional. Os bancos de dados aos quais a regra se aplica. Separe vários nomes de banco de dados com uma vírgula (,). Se este parâmetro for omitido, a regra se aplica a todos os bancos de dados no cluster.

    • "tables": Opcional. As tabelas às quais a regra se aplica. Separe vários nomes de tabela com uma vírgula (,). Se este parâmetro for omitido, a regra se aplica a todas as tabelas no cluster.

    • "columns": Obrigatório. As colunas às quais a regra se aplica. Separe vários nomes de coluna com uma vírgula (,).

    • "description": Opcional. A descrição da regra, com até 64 caracteres de comprimento.

    • "enabled": Obrigatório. Especifica se a regra de mascaramento de dados está ativada. Valores válidos: true (ativada) e false (desativada).

    • "applies_to": As contas de banco de dados às quais a regra se aplica. Separe vários nomes de conta com uma vírgula (,).

    • "exempted": As contas de banco de dados isentas da regra. Separe vários nomes de conta com uma vírgula (,).

    Nota

    • Se você especificar o parâmetro RuleName, também deverá especificar o parâmetro RuleConfig.

    • Você deve especificar "applies_to" ou "exempted".

    {"auto": {"databases": ["db1"], "tables": ["tb1"], "columns": ["c1,c2"] }, "description": "This rule will be applied to the columns c1 and c2 in table t1", "enabled": true, "applies_to": ["user"]}
    RuleNameList

    string

    Não

    Uma lista separada por vírgulas de nomes de regras de mascaramento de dados.

    Nota

    Você deve especificar o parâmetro RuleName ou RuleNameList.

    testrule
    Enable

    string

    Não

    Ativa ou desativa as regras de mascaramento de dados especificadas. Valores válidos:

    • true: ativa as regras especificadas.

    • false: desativa as regras especificadas.

    Nota

    Este parâmetro se aplica apenas quando o parâmetro RuleNameList é especificado.

    true
    RuleVersion

    string

    Não

    A versão da regra de mascaramento de dados. Valores válidos:

    • v1 (padrão)

    • v2

    v2
    InterfaceVersion

    string

    Não

    O tipo de regra a ser modificada. Valores válidos:

    v1: Modifica uma regra de mascaramento de dados. v2: Modifica uma regra de criptografia.

    v1
    MaskingAlgo

    string

    Não

    O algoritmo de mascaramento. Especifique um ou mais algoritmos e seus parâmetros. Formato: [{ "name": "algorithm_name", "params": {"key": "value"} }]

    [{ "name": "aes-128-gcm" }]
    DefaultAlgo

    string

    Não

    O algoritmo padrão.

    Nota

    Você deve especificar MaskingAlgo ou DefaultAlgo.

    aes-128-gcm

    Elementos de resposta

    Elemento

    Tipo

    Descrição

    Exemplo

    object

    RequestId

    string

    O ID da solicitação.

    99B355CE-526C-478B-B730-AD9D7C******
    Message

    string

    A mensagem de resposta.

    Nota

    Se a solicitação for bem-sucedida, Successful será retornado. Se a solicitação falhar, uma mensagem de erro será retornada.

    Message
    Success

    boolean

    Indica se a solicitação foi bem-sucedida. Valores válidos:

    • true

    • false

    true

    Exemplos

    Resposta de sucesso

    JSON formato

    {
  "RequestId": "99B355CE-526C-478B-B730-AD9D7C******",
  "Message": "Message",
  "Success": true
}

    Códigos de erro

    Código de status HTTP

    Código de erro

    Mensagem de erro

    Descrição
    404 InvalidDBClusterId.Malformed The specified parameter DBClusterId is not valid. The specified DBClusterId parameter is invalid.

    Consulte Códigos de Erro para uma lista completa.

    Notas de versão

    Consulte Notas de Versão para uma lista completa.