ModifyWhiteIps - Update Elasticsearch IP address whitelist - Elasticsearch: Central de Documentação do Alibaba Cloud

Observações de uso

Não é possível chamar esta operação quando a instância está no estado Active (ativando), Invalid (inválido) ou Inactive (inativo).
Há dois métodos de atualização disponíveis, mas não podem ser combinados. Além de InstanceId e clientToken, cada método usa parâmetros diferentes:
- Lista de permissões de endereços IP: whiteIpList, nodeType e networkType
- Grupos de lista de permissões de endereços IP: modifyMode e whiteIpGroup
Listas de permissões de rede pública não podem conter endereços IP privados, e listas de permissões de rede privada não podem conter endereços IP públicos.

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Recomendamos usar o OpenAPI Explorer para chamar esta operação, pois ele gera dinamicamente códigos de exemplo para diferentes SDKs.

Cabeçalhos da solicitação

Esta operação usa apenas cabeçalhos de solicitação comuns.

Sintaxe da solicitação

PATCHPOST /openapi/instances/{InstanceId}/actions/modify-white-ips HTTP/1.1

Parâmetros da solicitação

Parâmetro	Tipo	Posição	Obrigatório	Exemplo	Descrição
InstanceId	String	Path	Sim	es-cn-0pp1jxvcl000z****	ID da instância.
clientToken	String	Query	Não	5A2CFF0E-5718-45B5-9D4D-70B3FF****	Token gerado pelo cliente para garantir idempotência. Deve ser único entre solicitações. Comprimento máximo: 64 caracteres ASCII.
	Object	Body	Não		Parâmetros do corpo da solicitação.
nodeType	String	Body	Não	WORKER	Tipo de nó. Obrigatório ao especificar whiteIpList. Valores válidos: WORKER: cluster Elasticsearch KIBANA: cluster Kibana
networkType	String	Body	Não	PUBLIC	Tipo de rede. Obrigatório ao especificar whiteIpList. Valores válidos: PRIVATE: rede privada PUBLIC: rede pública
modifyMode	String	Body	Não	Cover	Método de modificação. Valores válidos: Cover (padrão): substitui a lista de permissões pelos endereços IP especificados. Append: adiciona os endereços IP especificados à lista de permissões existente. Delete: remove os endereços IP especificados da lista de permissões. Pelo menos um endereço IP deve permanecer.
whiteIpList	Array of String	Body	Não	192.168.xx.xx	Lista de permissões de endereços IP. Disponível apenas quando whiteIpGroup não for especificado. Atualize o grupo de lista de permissões Default. Importante Não é possível configurar whiteIpList e whiteIpGroup simultaneamente.
whiteIpGroup	Object	Body	Não		Atualize as configurações da lista de permissões por grupo. Apenas um grupo pode ser atualizado por solicitação. Importante Não é possível configurar whiteIpList e whiteIpGroup simultaneamente.
groupName	String	Body	Não	test_group	Nome do grupo da lista de permissões. Obrigatório ao especificar whiteIpGroup.
ips	Array of String	Body	Não	192.168.xx.xx	Endereços IP no grupo da lista de permissões. Obrigatório ao especificar whiteIpGroup.
whiteIpType	String	Body	Não	PRIVATE_ES	Tipo da lista de permissões de endereços IP. Valores válidos: PRIVATE_KIBANA: lista de permissões de rede privada do Kibana PRIVATE_ES: lista de permissões de rede privada do Elasticsearch PUBLIC_ES: lista de permissões de rede pública do Elasticsearch PUBLIC_KIBANA: lista de permissões de rede pública do Kibana

Importante

Apenas o modo Cover pode adicionar ou excluir grupos de lista de permissões. Os modos Append e Delete só podem modificar endereços IP dentro de um grupo existente. Observação:

Cover: se ips estiver vazio, o sistema exclui o grupo da lista de permissões. Se groupName não corresponder a um grupo existente, o sistema cria um novo grupo.
Delete: pelo menos um endereço IP deve permanecer após a exclusão.
Append: o grupo da lista de permissões já deve existir. Caso contrário, o sistema retorna um erro NotFound.

Parâmetros de resposta

Parâmetro

Tipo

Exemplo

Descrição

Result

Boolean

true

Indica se a lista de permissões foi atualizada.

true: a lista de permissões foi atualizada.
false: falha na atualização da lista de permissões.

RequestId

String

5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1DERFG

ID da solicitação.

Exemplo

Exemplo de solicitação

PATCH /openapi/instances/es-cn-0pp1jxvcl000z****/actions/modify-white-ips HTTP/1.1
Host:elasticsearch.aliyuncs.com
Content-Type:application/json
{
    "nodeType" : "WORKER",
    "networkType" : "PUBLIC",
    "whiteIpList": [
        "110.0.XX.XX/8"
    ]
}
or
{
    "modifyMode": "cover",
    "whiteIpGroup": {
        "groupName": "test_group_name", 
        "ips": [
            "0.0.0.0", 
            "10.2.XX.XX"
        ],
        "whiteIpType" : "PRIVATE_ES"
    }
}

Exemplos de respostas de sucesso

Formato XML

HTTP/1.1 200 OK
Content-Type:application/xml

<ModifyWhiteIpsResponse>
    <Result>true</Result>
    <RequestId>5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1DERFG</RequestId>
</ModifyWhiteIpsResponse>

Formato JSON

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Result" : true,
  "RequestId" : "5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1DERFG"
}

Códigos de erro

Os códigos de erro estão listados na Central de Erros de API.