ModifyDBClusterAccessWhitelist - PolarDB: Central de Documentação do Alibaba Cloud

Cria ou modifica a whitelist de um cluster, incluindo a whitelist de IPs e grupos de segurança.

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

update

*dbcluster.

acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
DBClusterId	string	Sim	O ID do cluster.	pc-*************
SecurityIps	string	Não	Os endereços IP ou blocos CIDR no grupo de whitelist de IPs. Você pode adicionar até 1.000 endereços IP ou blocos CIDR em todos os grupos de whitelist de IPs. Separe vários endereços IP com vírgulas (,). Os dois formatos a seguir são suportados: Formato de endereço IP, como 10.23.12.24. Formato CIDR, como 10.23.12.24/24, onde 24 indica o comprimento do prefixo no endereço IP. O comprimento do prefixo varia de 1 a 32. Nota Este parâmetro entra em vigor apenas quando WhiteListType está definido como IP.	10.23.12.24
DBClusterIPArrayName	string	Não	O nome do grupo de whitelist de IPs. O nome deve ter de 2 a 120 caracteres e pode conter letras minúsculas e dígitos. O nome deve começar com uma letra e terminar com uma letra ou dígito. Se o nome do grupo de whitelist especificado não existir, um novo grupo de whitelist será criado. Se o nome do grupo de whitelist especificado já existir, o grupo de whitelist será modificado. Se este parâmetro não for especificado, o grupo padrão será modificado. Nota Um cluster suporta até 50 grupos de whitelist de IPs. Este parâmetro entra em vigor apenas quando WhiteListType está definido como IP.	default
DBClusterIPArrayAttribute	string	Não	O atributo do grupo de whitelist de IPs. Se você definir este parâmetro como hidden, o grupo não será exibido no console. Nota Grupos de whitelist de IPs que já estão exibidos no console não podem ser ocultados. Este parâmetro entra em vigor apenas quando WhiteListType está definido como IP.	hidden
WhiteListType	string	Não	O tipo da whitelist. Valores válidos: IP: Grupo de whitelist de IPs. SecurityGroup: Grupo de segurança. Valor padrão: IP.	IP
SecurityGroupIds	string	Não	Os IDs dos grupos de segurança. Separe vários IDs de grupos de segurança com vírgulas (,). Nota Um cluster suporta até 3 grupos de segurança. Este parâmetro entra em vigor apenas quando WhiteListType está definido como SecurityGroup.	sg-*********
ModifyMode	string	Não	O método usado para modificar a whitelist de IPs. Valores válidos: Cover: Substitui a whitelist de IPs original. Este é o valor padrão. Append: Adiciona endereços IP à whitelist de IPs. Delete: Remove endereços IP da whitelist de IPs. Nota Este parâmetro entra em vigor apenas quando WhiteListType está definido como IP.	Cover
PfsInstanceId	string	Não	O ID da instância do sistema de arquivos.	pfs-xxx

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação.	D0CEC6AC-7760-409A-A0D5-E6CD86******

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "D0CEC6AC-7760-409A-A0D5-E6CD86******"
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	NumberExceed.securityGroupIds	The number of SecurityGroupIds exceeds 10.	A operação falhou porque o número de grupos de segurança excedeu o limite superior de 10. Modifique a configuração e tente novamente.
400	InvalidSecurityIPList.Duplicate	Specified security IP list is not valid: Duplicate IP address in the list	A lista de IPs de segurança especificada é inválida: a lista contém endereços IP duplicados.
400	InvalidSecurityIPList.Format	Specified security IP list format is not valid.	O formato do endereço IP da lista de permissões especificado é inválido.
400	LockTimeout	The request processing has failed due to lock timeout.	O processamento da solicitação falhou devido a um tempo limite de bloqueio.
403	SecurityIPList.Duplicate	Specified same security IP already exists.	O endereço IP de segurança especificado já existe.
403	OperationDenied.LockMode	The operation is not permitted when the instance is locked.	A operação falhou porque a instância está em estado bloqueado e não suporta esta operação.
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	A operação falhou porque o ID da instância de cluster especificado não existe.
404	InvalidDBClusterId.NotFound	The DBInstanceId provided does not exist in our records.	O DBClusterId fornecido não existe nos registros atuais.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.