UpdateWhiteIps - Elasticsearch Private Network Whitelist API - Elasticsearch: Central de Documentação do Alibaba Cloud

Observações de uso

Não é possível atualizar a lista de permissões quando a instância está no estado Activating, Invalid ou Inactive.
Há dois métodos de atualização mutuamente exclusivos. Além de InstanceId e clientToken, cada método usa parâmetros diferentes:
- Lista de permissões de endereços IP: esIPWhitelist
- Grupo da lista de permissões de endereços IP: modifyMode e whiteIpGroup
As listas de permissões de rede pública e privada não podem conter os endereços IP uma da outra.

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura e gera códigos de exemplo do SDK para esta operação.

Cabeçalhos da solicitação

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

Sintaxe da solicitação

PATCHPOST /openapi/instances/{InstanceId}/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-npk2154oi000b****	ID da instância.
clientToken	String	Query	Não	5A2CFF0E-5718-45B5-9D4D-70B3FF****	Token exclusivo com até 64 caracteres ASCII para garantir a idempotência da solicitação.
modifyMode	String	Query	Não	Cover	Método de modificação. Valores válidos: Cover (padrão): substitui a lista de permissões pelos IPs especificados. Append: adiciona os IPs especificados à lista de permissões existente. Delete: remove os IPs especificados da lista de permissões. Pelo menos um endereço IP deve permanecer.
	Object	Body	Não		Corpo da solicitação.
esIPWhitelist	Array of String	Body	Não	["10,61.xx.xx", "106,11.xx.xx”]	Lista de permissões de endereços IP. Disponível apenas quando whiteIpGroup estiver vazio. Atualize o grupo de lista de permissões Default. Importante Não configure esIPWhitelist e whiteIpGroup simultaneamente.
whiteIpGroup	Object	Body	Não		Grupo da lista de permissões a ser atualizado. Apenas um grupo por solicitação. Importante Não configure esIPWhitelist 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	["10,2.xx.xx", "10,3.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 de lista de permissões. Valor fixo: PRIVATE_ES (acesso à rede privada).

Importante

Para adicionar ou excluir grupos da lista de permissões, defina modifyMode como Cover. Os modos Append e Delete modificam apenas os IPs dentro de um grupo:

Cover: se ips estiver vazio, o sistema exclui o grupo. Se groupName não existir, o sistema cria um novo grupo.
Delete: pelo menos um endereço IP deve permanecer no grupo.
Append: o groupName especificado já deve existir. Caso contrário, o sistema retorna um erro NotFound.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
RequestId	String	8D58B014-BBD7-4D80-B219-00B9D5C6860C	ID da solicitação.
Result	Object		Dados retornados.
esIPWhitelist	Array of String	["106,11.xx.xx", "10,61.xx.xx"]	Lista de permissões atualizada.
networkConfig	Object		Configuração de rede.
whiteIpGroupList	Array of whiteIpGroupList		Grupos da lista de permissões.
groupName	String	test_group	Nome do grupo. Um grupo padrão está sempre presente.
ips	Array of String	["10,2.xx.xx", "10,3.xx.xx"]	Endereços IP no grupo da lista de permissões.
whiteIpType	String	PRIVATE_ES	Tipo de lista de permissões. Valor: PRIVATE_ES.

Nota

O exemplo de resposta inclui apenas os parâmetros da tabela de resposta. Outros parâmetros servem apenas como referência. Todos os parâmetros estão documentados em

ListInstance

.

Exemplo

Exemplo de solicitação

PATCH /openapi/instances/es-cn-npk2154oi000b****/white-ips HTTP/1.1
Host:elasticsearch.aliyuncs.com
Content-Type:application/json
{
    "esIPWhitelist": [
        "110.0.XX.XX/8"
    ]
}
or
{
    "whiteIpGroup": {
        "groupName": "test_group_name", 
        "ips": [
            "0.0.0.0", 
            "10.2.XX.XX"
        ],
        "whiteIpType" : "PRIVATE_ES"
    }
}

Exemplos de respostas de sucesso

Formato JSON

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

{
  "Result" : {
    "instanceId" : "es-cn-xxx",
    "domain" : "es-cn-xxx.elasticsearch.aliyuncs.com",
    "description" : "aliyunes_name_test",
    "nodeAmount" : 3,
    "paymentType" : "postpaid",
    "status" : "active",
    "port" : 9200,
    "esVersion" : "5.5.3_with_X-Pack",
    "esConfig" : {
      "action.destructive_requires_name" : "true",
      "xpack.security.audit.outputs" : "index",
      "xpack.watcher.enabled" : "false",
      "xpack.security.audit.enabled" : "true",
      "action.auto_create_index" : "+.*,-*"
    },
    "esIPWhitelist" : [ "192.168.xx.xx/24" ],
    "esIPBlacklist" : [ ],
    "privateNetworkIpWhiteList" : [ "192.168.xx.xx/24" ],
    "kibanaIPWhitelist" : [ "0.0.0.0/0", "::/0" ],
    "publicIpWhitelist" : [ ],
    "kibanaDomain" : "es-cn-xxx.kibana.elasticsearch.aliyuncs.com",
    "kibanaPort" : 5601,
    "enablePublic" : false,
    "nodeSpec" : {
      "spec" : "elasticsearch.n4.small",
      "disk" : 20,
      "diskType" : "cloud_ssd"
    },
    "networkConfig" : {
      "vpcId" : "vpc-bp1uag5jj38ccmwn1****",
      "vswitchId" : "vsw-bp1knt7m4cyn5k3a7****",
      "vsArea" : "cn-hangzhou-b",
      "type" : "vpc",
      "whiteIpGroupList" : [ {
        "groupName" : "default",
        "ips" : [ "0.0.0.0", "10.2.xx.xx" ]
      }, {
        "groupName" : "test_group_name",
        "ips" : [ "10.2.xx.xx" ]
      } ]
    },
    "createdAt" : "2019-01-17T09:22:45.888Z",
    "updatedAt" : "2019-03-15T13:21:20.728Z",
    "inited" : true,
    "dedicateMaster" : false,
    "advancedDedicateMaster" : false,
    "masterConfiguration" : { },
    "haveClientNode" : false,
    "warmNode" : false,
    "warmNodeConfiguration" : { },
    "clientNodeConfiguration" : { },
    "kibanaConfiguration" : {
      "spec" : "elasticsearch.n4.small",
      "amount" : 1,
      "disk" : 0
    },
    "commodityCode" : "elasticsearch",
    "endTime" : 4703414400000,
    "dictList" : [ {
      "name" : "SYSTEM_MAIN",
      "fileSize" : 3058510,
      "type" : "MAIN",
      "sourceType" : "ORIGIN"
    }, {
      "name" : "SYSTEM_STOPWORD",
      "fileSize" : 164,
      "type" : "STOP",
      "sourceType" : "ORIGIN"
    } ],
    "synonymsDicts" : [ ],
    "ikHotDicts" : [ {
      "name" : "test",
      "fileSize" : 8,
      "type" : "MAIN",
      "sourceType" : "ORIGIN"
    } ],
    "clusterTasks" : [ ],
    "vpcInstanceId" : "es-cn-xxx-worker"
  },
  "RequestId" : "C82758DD-282F-4D48-934F-92170A3388FA"
}

Códigos de erro

Visite a Central de Erros da API.