Todos os produtos
Search

Este produto

    Elasticsearch:ListInstance

    Central de documentação

    Elasticsearch:ListInstance

    Última atualização: Jun 27, 2026

    Lista as instâncias do Elasticsearch.

    Depuração

    O OpenAPI Explorer calcula automaticamente o valor da assinatura. Recomendamos chamar esta operação no OpenAPI Explorer.

    Cabeçalhos da requisição

    Esta operação utiliza apenas cabeçalhos de requisição comuns, conforme descrito no tópico Parâmetros comuns.

    Sintaxe

    GET /openapi/instances HTTP/1.1

    Parâmetros da requisição

    Parâmetro

    Tipo

    Posição

    Obrigatório

    Exemplo

    Descrição
    page Integer Query Não. 1

    Número da página.

    Começa em 1. Padrão: 1.
    size Integer Query Não. 10

    Entradas por página. Máximo: 100. Padrão: 10.
    description String Query Não. aliyunes_test1

    Nome da instância. Aceita correspondência parcial. Por exemplo, a busca por abc retorna instâncias chamadas abc, abcde, xyabc e xabcy.
    instanceId String Query Não. es-cn-v641a0ta3000g****

    ID da instância.

    esVersion String Query Não. 6.7_with_X-Pack

    Versão da instância.

    resourceGroupId String Query Não. rg-aekzvowej3i****

    ID do grupo de recursos.
    tags String Query Não. [{"tagKey":"key1","tagValue":"value1"}]

    Tags da instância.
    vpcId String Query Não. vpc-bp16k1dvzxtmagcva****

    ID da VPC da instância.
    zoneId String Query Não. cn-hangzhou-i

    ID da zona da instância.

    paymentType String Query Não. postpaid

    Método de faturamento da instância. Valores válidos:

    • postpaid: pagamento conforme o uso
    • prepaid: assinatura
    instanceCategory String Query Não. advanced

    Edição do cluster Elasticsearch. Valores válidos:

    • x-pack: Standard Edition
    • advanced/IS: Enhanced Edition
    • community: Basic Edition

    Parâmetros de resposta

    Parâmetro

    Tipo

    Exemplo

    Descrição
    RequestId String 5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****

    ID da requisição.

    Headers Object

    Cabeçalhos da resposta.
    X-Total-Count Integer 10

    Número de entradas retornadas por página.

    Result Array of Instance

    Instâncias retornadas.
    advancedDedicateMaster Boolean false

    Indica se há nós mestres dedicados. Valores válidos:

    • true: O diretório contém arquivos armazenados na classe de armazenamento Archive.
    • false: O diretório não contém arquivos armazenados na classe de armazenamento Archive.
    nodeAmount Integer 2

    Quantidade de nós de dados.

    createdAt String 2018-07-13T03:58:07.253Z

    Horário de criação da instância.

    status String active

    Status da instância. Valores válidos:

    • active: O cluster está normal.
    • activating: O cluster está sendo ativado.
    • Inactive: O cluster está congelado.
    • invalid: O cluster não existe ou está inacessível. Nesse caso, alguns campos da resposta podem estar ausentes, como domain e kibanaDomain.
    • unknown: O cluster não existe ou está inacessível. Nesse caso, alguns campos da resposta podem estar ausentes, como domain e kibanaDomain.
    dedicateMaster Boolean false

    Indica se há nós mestres dedicados (obsoleto). Valores válidos:

    • true: O diretório contém arquivos armazenados na classe de armazenamento Archive.
    • false: O diretório não contém arquivos armazenados na classe de armazenamento Archive.
    serviceVpc Boolean true

    Indica se esta é uma VPC de serviço.
    paymentType String postpaid

    Método de faturamento do cluster. Valores válidos:

    • prepaid: anual e mensal
    • postpaid: pagamento conforme o uso
    resourceGroupId String rg-aekzvowej3i****

    ID do grupo de recursos.

    postpaidServiceStatus String active

    Status do serviço de pagamento conforme o uso para o cluster de assinatura. Valores válidos:

    • active: Normal
    • closed: fechado
    • indebt: O pagamento atrasado está congelado.
    description String es-cn-abc

    Nome da instância.

    esVersion String 6.7_with_X-Pack

    Versão da instância.

    isNewDeployment String true

    Indica se o cluster está implantado na nova arquitetura.

    updatedAt String 2018-07-18T10:10:04.484Z

    Horário da última atualização da instância.

    instanceId String es-cn-v641a0ta3000g****

    ID da instância.

    tags Array of Tag

    Tags da instância. Cada tag é um par chave-valor.

    tagKey String env

    Chave da tag.

    tagValue String dev

    Valor da tag.

    extendConfigs Array of Object [{ "configType": "aliVersion", "aliVersion": "ali1.3.0" }]

    Parâmetros de configuração estendidos.
    clientNodeConfiguration Object

    Configurações de nó cliente.
    spec String elasticsearch.sn2ne.large

    Especificação da instância. Especificações do produto.
    amount Integer 3

    Quantidade de nós.

    disk Integer 20

    Tamanho de armazenamento do nó. Unidade: GB.
    diskType String cloud_efficiency

    Tipo de armazenamento do nó. Apenas discos ultra (cloud_efficiency) são suportados.
    specInfo String 1C 2G

    Detalhes da especificação do nó.
    elasticDataNodeConfiguration Object

    Configurações de nó elástico.
    spec String elasticsearch.sn2ne.large

    Especificação da instância. Especificações do produto.
    amount Integer 3

    Quantidade de nós.

    disk Integer 20

    Tamanho de armazenamento do nó. Unidade: GB.
    diskEncryption Boolean true

    Indica se a criptografia de disco está ativada. Valores válidos:

    • true: Execute a etapa.
    • false: Não execute a etapa.
    diskType String cloud_ssd

    Tipo de armazenamento. Valores válidos:

    • cloud_ssd: SSD
    • cloud_essd: ESSD
    • cloud_efficiency: disco ultra
    specInfo String 1C 2G

    Detalhes da especificação do nó.
    kibanaConfiguration Object

    Configurações de nó Kibana.
    spec String elasticsearch.n4.small

    Especificação da instância. Especificações do produto.
    amount Integer 1

    Quantidade de nós.

    disk Integer 20

    Tamanho de armazenamento do nó. Unidade: GB.
    diskType String cloud_ssd

    Tipo de armazenamento.

    specInfo String 1C 2G

    Detalhes da especificação do nó.
    masterConfiguration Object

    Configurações de nó mestre dedicado.
    spec String elasticsearch.sn2ne.large

    Especificação da instância. Especificações do produto.
    amount Integer 3

    Quantidade de nós.

    disk Integer 20

    Tamanho de armazenamento do nó. Unidade: GB.
    diskType String cloud_ssd

    Tipo de armazenamento. Apenas cloud_ssd é suportado.
    specInfo String 1C 2G

    Detalhes da especificação do nó.
    networkConfig Object

    Configuração de rede.
    vpcId String vpc-abc

    ID da VPC.

    vsArea String cn-hangzhou-e

    Zona onde o cluster reside.

    type String vpc

    Tipo de rede. Apenas VPC é suportada.
    vswitchId String vsw-def

    ID do vSwitch.

    whiteIpGroupList Array of whiteIpGroupList

    Listas de permissões de IP para acesso à rede pública e privada.
    groupName String default

    Nome da lista de permissões de IP.

    whiteIpType String PUBLIC_KIBANA

    Tipo de rede. Valores válidos: PRIVATE_ES (rede privada Elasticsearch), PUBLIC_ES (rede pública Elasticsearch), PRIVATE_KIBANA (rede privada Kibana), PUBLIC_KIBANA (rede pública Kibana).
    ips Array of String ["0.0.0.0", "127.0.XX.XX"]

    Lista de permissões de IP.
    nodeSpec Object

    Configurações de nó de dados.
    spec String elasticsearch.n4.small

    Especificação da instância. Especificações do produto.
    disk Integer 50

    Capacidade de armazenamento do nó. Unidade: GB.
    diskEncryption Boolean false

    Indica se a criptografia de disco está em uso. Valores válidos:

    • true: O modo de formato nativo é usado.
    • false: O modo de formato nativo não é usado.
    diskType String cloud_ssd

    Tipo de armazenamento. Valores válidos:

    • cloud_ssd: SSD padrão
    • cloud_efficiency: disco ultra
    performanceLevel String PL1

    Nível de desempenho (PL) do ESSD. Retornado apenas quando diskType é cloud_essd. Valores válidos: PL1, PL2 e PL3.
    specInfo String 1C 2G

    Detalhes da especificação do nó.
    vpcInstanceId String vpc-bp1uag5jj38c****

    ID da VPC.

    kibanaIPWhitelist Array of String "0.0.0.0/0"

    Lista de permissões de IP público do Kibana.
    kibanaPrivateIPWhitelist Array of String ["192.168.XX.XX"]

    Lista de permissões de IP privado do Kibana.
    publicIpWhitelist Array of String [ "0.0.0.0/0" ]

    Lista de permissões de rede pública do Elasticsearch.
    privateNetworkIpWhiteList Array of String ["192.168.XX.XX/25"]

    Lista de permissões de rede privada do Elasticsearch.
    endTime Long 1715826092044

    Horário de expiração da instância de reserva de cache.

    archType String public

    Arquitetura de implantação.

    exclusive: gerenciamento básico

    public: novo controle nativo da nuvem
    domain String es-cn-nif1q8auz0005****.elasticsearch.aliyuncs.com

    Endpoint interno do cluster.

    Nota

    O exemplo a seguir inclui a maioria dos parâmetros de resposta. As respostas reais podem variar. Não crie dependências codificadas rigidamente em parâmetros específicos.

    Exemplos

    Exemplo de requisição

    GET /openapi/instances?esVersion=6.7_with_X-Pack&resourceGroupId=rg-aekzvowej3i****&tags=[{"tagKey":"key1","tagValue":"value1"}]&vpcId=vpc-bp16k1dvzxtmagcva****&zoneId=cn-hangzhou-i HTTP/1.1
Host:elasticsearch.aliyuncs.com
Content-Type:application/json

    Exemplo de resposta

    Formato JSON

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

{
  "Result" : [ {
    "instanceId" : "es-cn-v641a0ta3000g****",
    "description" : "aliyunes_test1",
    "nodeAmount" : 3,
    "paymentType" : "postpaid",
    "status" : "active",
    "esVersion" : "6.7.0_with_X-Pack",
    "esConfig" : { },
    "esIPWhitelist" : [ ],
    "esIPBlacklist" : [ ],
    "privateNetworkIpWhiteList" : [ ],
    "kibanaIPWhitelist" : [ ],
    "publicIpWhitelist" : [ ],
    "serviceVpc" : true,
    "enablePublic" : false,
    "haveKibana" : true,
    "nodeSpec" : {
      "spec" : "elasticsearch.sn1ne.large",
      "disk" : 20,
      "diskType" : "cloud_ssd",
      "diskEncryption" : true
    },
    "networkConfig" : {
      "vpcId" : "vpc-bp1xk0naij7jx4ph1****",
      "vswitchId" : "vsw-bp1ogpdintii5qvyx****",
      "vsArea" : "cn-hangzhou-g",
      "type" : "vpc"
    },
    "createdAt" : "2019-08-26T08:18:06.652Z",
    "updatedAt" : "2019-08-26T08:19:49.448Z",
    "inited" : true,
    "tags" : [ {
      "tagKey" : "key1",
      "tagValue" : "value1"
    } ],
    "dedicateMaster" : false,
    "advancedDedicateMaster" : true,
    "masterConfiguration" : {
      "spec" : "elasticsearch.ic5.large",
      "amount" : 3,
      "diskType" : "cloud_ssd",
      "disk" : 20
    },
    "haveClientNode" : true,
    "warmNode" : true,
    "warmNodeConfiguration" : {
      "spec" : "elasticsearch.ic5.large",
      "amount" : 2,
      "diskType" : "cloud_efficiency",
      "disk" : 500,
      "diskEncryption" : true
    },
    "clientNodeConfiguration" : {
      "spec" : "elasticsearch.ic5.large",
      "amount" : 2,
      "diskType" : "cloud_efficiency",
      "disk" : 20
    },
    "kibanaConfiguration" : {
      "spec" : "elasticsearch.n4.small",
      "amount" : 1,
      "disk" : 0
    },
    "commodityCode" : "elasticsearch",
    "endTime" : 4722508800000,
    "dictList" : [ ],
    "synonymsDicts" : [ ],
    "ikHotDicts" : [ ],
    "aliwsDicts" : [ ],
    "clusterTasks" : [ ],
    "resourceGroupId" : "rg-acfmwriiikz****",
    "zoneCount" : 1,
    "protocol" : "HTTP",
    "haveGrafana" : false,
    "haveCerebro" : false,
    "zoneInfos" : [ {
      "zoneId" : "cn-hangzhou-g",
      "status" : "NORMAL"
    } ],
    "enableKibanaPublicNetwork" : false,
    "advancedSetting" : {
      "gcName" : "CMS"
    }
  }, {
    "instanceId" : "es-cn-v641920bh0006****",
    "description" : "aliyunes_test2",
    "nodeAmount" : 2,
    "paymentType" : "postpaid",
    "status" : "active",
    "esVersion" : "6.7.0_with_X-Pack",
    "archType" : "exclusive",
    "esConfig" : { },
    "esIPWhitelist" : [ ],
    "esIPBlacklist" : [ ],
    "privateNetworkIpWhiteList" : [ ],
    "kibanaIPWhitelist" : [ ],
    "publicIpWhitelist" : [ ],
    "enablePublic" : false,
    "haveKibana" : true,
    "nodeSpec" : {
      "spec" : "elasticsearch.sn2ne.2xlarge",
      "disk" : 20,
      "diskType" : "cloud_ssd",
      "diskEncryption" : false
    },
    "networkConfig" : {
      "vpcId" : "vpc-bp1op7luys63go2x5****",
      "vswitchId" : "vsw-bp1rusvg785q97ucp****",
      "vsArea" : "cn-hangzhou-i",
      "type" : "vpc"
    },
    "createdAt" : "2019-08-07T13:14:07.974Z",
    "updatedAt" : "2019-08-12T03:04:27.215Z",
    "inited" : true,
    "tags" : [ ],
    "dedicateMaster" : false,
    "advancedDedicateMaster" : false,
    "masterConfiguration" : { },
    "haveClientNode" : false,
    "warmNode" : false,
    "warmNodeConfiguration" : { },
    "clientNodeConfiguration" : { },
    "kibanaConfiguration" : {
      "spec" : "elasticsearch.n4.small",
      "amount" : 1,
      "disk" : 0
    },
    "commodityCode" : "elasticsearch",
    "endTime" : 4720867200000,
    "dictList" : [ ],
    "synonymsDicts" : [ ],
    "ikHotDicts" : [ ],
    "aliwsDicts" : [ ],
    "clusterTasks" : [ ],
    "resourceGroupId" : "rg-acfmwriiikz****",
    "zoneCount" : 1,
    "protocol" : "HTTP",
    "haveGrafana" : false,
    "haveCerebro" : false,
    "zoneInfos" : [ {
      "zoneId" : "cn-hangzhou-i",
      "status" : "NORMAL"
    } ],
    "enableKibanaPublicNetwork" : false,
    "advancedSetting" : {
      "gcName" : "CMS"
    }
  } ]
}

    Códigos de erro

    Códigos de erro do serviço.