UpdateKibanaWhiteIps - Elasticsearch: Central de Documentação do Alibaba Cloud

Observações de uso

Antes de chamar esta operação, verifique se a instância não está nos estados de ativação, inválido ou inativo.
É possível atualizar a lista de permissões de duas formas: por lista de endereços IP ou por grupo de listas de permissões. Não utilize os dois métodos simultaneamente. Além dos parâmetros InstanceId e clientToken, cada método aceita parâmetros diferentes, conforme descrito abaixo:
- Lista de endereços IP permitidos: kibanaIPWhitelist
- Grupos de listas de permissões de endereços IP: modifyMode e whiteIpGroup
Listas de permissões de acesso à rede pública não aceitam endereços IP privados. Listas de permissões de acesso à rede privada não aceitam endereços IP públicos.

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Recomendamos chamar esta operação no OpenAPI Explorer para maior conveniência. A ferramenta gera dinamicamente códigos de exemplo da operação para diferentes SDKs.

Cabeçalhos da solicitação

Esta operação utiliza apenas cabeçalhos de solicitação comuns. Para mais informações, consulte Cabeçalhos de solicitação comuns.

Sintaxe da solicitação

PATCH|POST /openapi/instances/{InstanceId}/kibana-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-tl329rbpc0001****	ID da instância.
clientToken	String	Query	Não	5A2CFF0E-5718-45B5-9D4D-70B3FF****	Token de cliente usado para garantir a idempotência da solicitação. Gere o valor com o cliente, mas garanta que seja único entre diferentes solicitações. O token pode conter apenas caracteres ASCII e não deve exceder 64 caracteres.
modifyMode	String	Query	Não	Cover	Método de modificação. Valores válidos: Cover (padrão): substitui a lista original de permissões de endereços IP pelo valor do parâmetro ips. Append: adiciona os endereços IP informados no parâmetro ips à lista original de permissões de endereços IP. Delete: remove os endereços IP informados no parâmetro ips da lista original de permissões de endereços IP. Mantenha pelo menos um endereço IP.
	Object	Body	Não		Corpo da solicitação.
kibanaIPWhitelist	Array of String	Body	Não	["110.0.XX.XX/8"]	Lista de permissões de endereços IP. Este parâmetro estará disponível se whiteIpGroup estiver vazio. O valor deste parâmetro atualiza as configurações da lista de permissões de endereços IP no grupo de listas de permissões padrão. Não configure kibanaIPWhitelist e whiteIpGroup simultaneamente.
whiteIpGroup	Object	Body	Não		Use um grupo de listas de permissões para atualizar a configuração de uma lista de permissões do Kibana. É possível atualizar apenas um grupo de listas de permissões por vez. Não configure kibanaIPWhitelist e whiteIpGroup simultaneamente.
groupName	String	Body	Não	test_group_name	Nome do grupo de listas de permissões. Este parâmetro é obrigatório se o parâmetro whiteIpGroup for especificado.
whiteIpType	String	Body	Não	PUBLIC_KIBANA	Tipo da lista de permissões. Apenas PUBLIC_KIBANA (lista de permissões de rede pública) é compatível.
ips	Array of String	Body	Não	["0.0.0.0", "10.2.XX.XX"]	Lista de endereços IP no grupo de listas de permissões. Este parâmetro é obrigatório se o parâmetro whiteIpGroup for especificado.

Importante

A adição e a exclusão de grupos de listas de permissões ocorrem ao definir modifyMode como Cover. Os modos Delete e Append não permitem adicionar ou remover grupos de listas de permissões simultaneamente; eles servem apenas para modificar a lista de endereços IP dentro de um grupo existente. Observe os seguintes pontos:

Se o parâmetro modifyMode estiver definido como Cover, o grupo de listas de permissões será excluído caso ips esteja vazio. Se groupName não constar na lista de nomes de grupos existentes, um novo grupo será criado.
Quando modifyMode estiver definido como Delete, mantenha pelo menos um endereço IP após a remoção dos valores em ips.
Caso modifyMode esteja definido como Append, certifique-se de que o nome do grupo de listas de permissões já foi criado. Caso contrário, a mensagem de erro NotFound será exibida.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
RequestId	String	E5EF11F1-DBAE-4020-AC24-DFA6C4345CAE	ID da solicitação.
Result	Object		Retorna os detalhes da instância Elasticsearch correspondente.
kibanaPrivateIPWhitelist	Array of String	[ "192.168.XX.XX/24" ]	Lista de permissões de acesso à rede privada do Kibana.
kibanaIPWhitelist	Array of String	["0.0.XX.XX", "10.2.XX.XX", "110.0.XX.XX/9"]	Lista de permissões de acesso ao Kibana.
networkConfig	Object		Informações de configuração de rede.
vpcId	String	vpc-bp1jy348ibzulk6hn****	ID da Virtual Private Cloud (VPC).
vswitchId	String	vsw-bp1a0mifpletdd1da****	ID do vSwitch ao qual a instância está conectada.
vsArea	String	cn-hangzhou-h	ID da região onde você deseja criar a instância.
type	String	vpc	Tipo de rede da instância. Valores válidos:
whiteIpGroupList	Array of whiteIpGroupList		Lista de permissões.
groupName	String	test_group_name	Nome do grupo de listas de permissões.
ips	Array of String	["0.0.0.0", "10.2.XX.XX"]	Lista de endereços IP no grupo de listas de permissões.
whiteIpType	String	PUBLIC_KIBANA	Tipo da lista de permissões.

Nota

No exemplo de retorno a seguir, este documento garante apenas a inclusão dos parâmetros listados nos dados de resposta. Os parâmetros não mencionados servem apenas como referência e o programa não deve depender obrigatoriamente da obtenção desses valores.

Exemplos

Exemplos de solicitações

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

Exemplos de respostas

Formato JSON

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

{
  "Result" : {
    "instanceId" : "es-cn-tl329rbpc0001****",
    "version" : "7.10.0_with_X-Pack",
    "description" : "lrr",
    "nodeAmount" : 0,
    "paymentType" : "postpaid",
    "status" : "active",
    "privateNetworkIpWhiteList" : [ "11.22.XX.XX", "0.0.XX.XX/0" ],
    "enablePublic" : false,
    "nodeSpec" : { },
    "dataNode" : false,
    "networkConfig" : {
      "vpcId" : "vpc-bp1jy348ibzulk6hn****",
      "vswitchId" : "vsw-bp1a0mifpletdd1da****",
      "vsArea" : "cn-hangzhou-h",
      "whiteIpGroupList" : [ {
        "groupName" : "default",
        "ips" : [ "0.0.XX.XX/0", "11.22.XX.XX" ],
        "whiteIpType" : "PRIVATE_ES"
      }, {
        "groupName" : "default",
        "ips" : [ "110.0.XX.XX/9" ],
        "whiteIpType" : "PUBLIC_KIBANA"
      }, {
        "groupName" : "default",
        "ips" : [ "192.168.XX.XX/24" ],
        "whiteIpType" : "PRIVATE_KIBANA"
      }, {
        "groupName" : "test_group_name",
        "ips" : [ "0.0.XX.XX", "10.2.XX.XX" ],
        "whiteIpType" : "PUBLIC_KIBANA"
      } ],
      "type" : "vpc"
    },
    "createdAt" : "2021-07-21T01:29:38.510Z",
    "updatedAt" : "2021-07-21T06:12:12.370Z",
    "commodityCode" : "elasticsearch",
    "extendConfigs" : [ {
      "configType" : "usageScenario",
      "value" : "log"
    }, {
      "configType" : "maintainTime",
      "maintainStartTime" : "02:00Z",
      "maintainEndTime" : "06:00Z"
    }, {
      "configType" : "aliVersion",
      "aliVersion" : "ali1.4.0"
    }, {
      "configType" : "followCube",
      "followClusterEnabled" : true
    } ],
    "endTime" : 4782556800000,
    "clusterTasks" : [ ],
    "vpcInstanceId" : "es-cn-tl329rbpc0001****-worker",
    "resourceGroupId" : "rg-acfmxxkk2p7****",
    "zoneCount" : 1,
    "protocol" : "HTTP",
    "zoneInfos" : [ {
      "zoneId" : "cn-hangzhou-h",
      "status" : "NORMAL"
    } ],
    "instanceType" : "elasticsearch",
    "inited" : true,
    "tags" : [ {
      "tagKey" : "acs:rm:rgId",
      "tagValue" : "rg-acfmxxkk2p7****"
    } ],
    "serviceVpc" : true,
    "domain" : "es-cn-tl329rbpc0001****.elasticsearch.aliyuncs.com",
    "port" : 9200,
    "esVersion" : "7.10.0_with_X-Pack",
    "esConfig" : {
      "action.destructive_requires_name" : "true",
      "xpack.watcher.enabled" : "false",
      "action.auto_create_index" : "+.*,-*"
    },
    "esIPWhitelist" : [ "11.22.XX.XX", "0.0.XX.XX/0" ],
    "esIPBlacklist" : [ ],
    "kibanaProtocol" : "HTTPS",
    "kibanaIPWhitelist" : [ "0.0.0.0", "10.2.XX.XX", "110.0.XX.XX/9" ],
    "kibanaPrivateIPWhitelist" : [ "192.168.XX.XX/24" ],
    "publicIpWhitelist" : [ ],
    "kibanaDomain" : "es-cn-tl329rbpc0001****.kibana.elasticsearch.aliyuncs.com",
    "kibanaPort" : 5601,
    "kibanaPrivateDomain" : "es-cn-tl329rbpc0001****-kibana.internal.elasticsearch.aliyuncs.com",
    "kibanaPrivatePort" : 5601,
    "haveKibana" : true,
    "instanceCategory" : "IS",
    "dedicateMaster" : false,
    "advancedDedicateMaster" : false,
    "masterConfiguration" : { },
    "haveClientNode" : false,
    "warmNode" : true,
    "warmNodeConfiguration" : {
      "spec" : "elasticsearch.d1.2xlarge",
      "amount" : 3
    },
    "clientNodeConfiguration" : { },
    "kibanaConfiguration" : {
      "spec" : "elasticsearch.n4.small",
      "amount" : 1,
      "disk" : 0
    },
    "elasticDataNodeConfiguration" : { },
    "haveElasticDataNode" : false,
    "dictList" : [ {
      "name" : "SYSTEM_MAIN.dic",
      "fileSize" : 2782602,
      "sourceType" : "ORIGIN",
      "type" : "MAIN"
    }, {
      "name" : "SYSTEM_STOPWORD.dic",
      "fileSize" : 132,
      "sourceType" : "ORIGIN",
      "type" : "STOP"
    } ],
    "synonymsDicts" : [ ],
    "ikHotDicts" : [ ],
    "aliwsDicts" : [ ],
    "haveGrafana" : false,
    "haveCerebro" : false,
    "enableKibanaPublicNetwork" : true,
    "enableKibanaPrivateNetwork" : true,
    "advancedSetting" : {
      "gcName" : "CMS"
    },
    "enableMetrics" : true,
    "readWritePolicy" : {
      "writeHa" : false
    }
  },
  "RequestId" : "E815C5C9-E82D-4B10-BDE0-D25340C2ACEF"
}

Códigos de erro

Para obter uma lista de códigos de erro, visite a Central de Erros da API.