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

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 requisição

Esta operação não possui cabeçalhos específicos e utiliza apenas os cabeçalhos comuns. Para mais informações, consulte a seção "Cabeçalhos de requisição comuns" no tópico "Parâmetros comuns".

Sintaxe

GET /openapi/instances/{InstanceId} HTTP/1.1

Parâmetros da requisição

Parâmetro	Tipo	Posição	Obrigatório	Exemplo	Descrição
InstanceId	String	Path	Sim	es-cn-3h4k3axh33th9****	ID da instância N.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
RequestId	String	5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****	ID da requisição.
Result	Object		Parâmetros de resposta.
advancedDedicateMaster	Boolean	true	Indica se o cluster contém nós mestres dedicados. Valores válidos: true: o cluster contém nós clientes. false: o cluster não contém nós clientes.
protocol	String	HTTP	Protocolo de comunicação. Valores válidos: HTTP e HTTPS.
enableKibanaPublicNetwork	Boolean	true	Indica se o acesso ao Kibana pela Internet está ativado. Valores válidos: true: ativado false: desativado
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.
enableKibanaPrivateNetwork	Boolean	false	Indica se o acesso ao Kibana por rede interna está ativado. Valores válidos: true: ativado false: desativado
vpcInstanceId	String	vpc-bp1uag5jj38c****	ID da VPC.
port	Integer	9200	Número da porta usada para acessar o cluster.
enablePublic	Boolean	true	Indica se o acesso ao cluster pela Internet está ativado. Valores válidos: true: ativado false: desativado
dedicateMaster	Boolean	false	Indica se o cluster contém nós mestres dedicados. Este parâmetro foi descontinuado.
kibanaPort	Integer	5601	Número da porta usada para acessar o Kibana.
esConfig	Map		Configuração do arquivo YML do cluster.
resourceGroupId	String	rg-aekzvowej3i****	ID do grupo de recursos ao qual a instância ALB pertence.
paymentType	String	postpaid	Método de faturamento do cluster. Valores válidos: prepaid: assinatura postpaid: pagamento conforme o uso
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: congelado devido a pagamento em atraso
esVersion	String	6.3.2_with_X-Pack	Versão da instância.
haveKibana	Boolean	true	Indica se o cluster contém nós do Kibana. Valores válidos: true: o cluster contém nós do Kibana. false: o cluster não contém nós do Kibana.
isNewDeployment	Boolean	true	Indica se o cluster está implantado na nova arquitetura.
warmNode	Boolean	true	Indica se os nós warm estão ativados para o cluster. Valores válidos: true: ativado false: desativado
updatedAt	String	2018-07-13T03:58:07.253Z	Horário da última atualização da instância.
instanceId	String	es-cn-3h4k3axh33th9****	ID da instância.
zoneCount	Integer	2	Quantidade de zonas.
publicDomain	String	es-cn-3h4k3axh33th9****.elasticsearch.aliyuncs.com	Endpoint público do cluster.
status	String	active	Status da instância. Valores válidos: active: o cluster está em estado normal. activating: o cluster está sendo inicializado. 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.
serviceVpc	Boolean	true	Indica se a VPC pertence à conta de serviço do Elasticsearch.
publicPort	Integer	9200	Número da porta usada para acessar o cluster pela Internet.
haveClientNode	Boolean	true	Indica se o cluster contém nós clientes. Valores válidos: true: o cluster contém nós clientes. false: o cluster não contém nós clientes.
domain	String	es-cn-3h4k3axh33th9****.elasticsearch.aliyuncs.com	Endpoint interno do cluster.
description	String	es-cn-abc	Nome da instância.
kibanaDomain	String	es-cn-3h4k3axh33th9****.kibana.elasticsearch.aliyuncs.com	Endpoint do Kibana.
dictList	Array of DictList		Configurações dos dicionários IK.
fileSize	Long	2782602	Tamanho do arquivo de dicionário. Unidade: bytes.
sourceType	String	ORIGIN	Tipo de source do arquivo de dicionário. Valores válidos: OSS: OSS. Certifique-se de que a ACL do bucket OSS relacionado seja de leitura pública. ORIGIN: Elasticsearch open source. UPLOAD: arquivo enviado.
name	String	SYSTEM_MAIN.dic	Nome do arquivo de dicionário.
type	String	MAIN	Tipo do dicionário. Valores válidos: STOP: lista de stopwords MAIN: dicionário principal SYNONYMS: dicionário de sinônimos ALI_WS: dicionário da Alibaba Cloud
synonymsDicts	Array of SynonymsDicts		Configurações dos dicionários de sinônimos.
fileSize	Long	2782602	Tamanho do arquivo de dicionário. Unidade: byte.
sourceType	String	ORIGIN	Tipo de source.
name	String	SYSTEM_MAIN.dic	Nome do arquivo de dicionário.
type	String	STOP	Tipo do dicionário. Valores válidos: STOP: lista de stopwords MAIN: dicionário principal SYNONYMS: dicionário de sinônimos ALI_WS: dicionário da Alibaba Cloud
zoneInfos	Array of ZoneInfo		Informações sobre a zona.
status	String	NORMAL	Status da zona. Valores válidos: ISOLATION: desativado NORMAL: normal
zoneId	String	cn-hangzhou-b	ID da zona.
aliwsDicts	Array of Dict		Configurações dos dicionários IK da Alibaba Cloud.
fileSize	Long	2782602	Tamanho do arquivo de dicionário. Unidade: byte.
sourceType	String	OSS	Tipo de source do arquivo de dicionário. Valores válidos: OSS: OSS. Certifique-se de que a ACL do bucket OSS relacionado seja de leitura pública. ORIGIN: Elasticsearch open source. UPLOAD: arquivo enviado.
name	String	aliws_ext_dict.txt	Nome do arquivo de dicionário.
type	String	ALI_WS	Tipo do dicionário. Valores válidos: STOP: lista de stopwords MAIN: dicionário principal SYNONYMS: dicionário de sinônimos ALI_WS: dicionário da Alibaba Cloud
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.
esIPWhitelist	Array of String	[ "0.0.0.0/0" ]	Lista de permissões de endereços IP privados. Este parâmetro foi descontinuado.
extendConfigs	Array of Object	[{ "configType": "aliVersion","aliVersion": "ali1.3.0" }]	Configurações estendidas da instância.
privateNetworkIpWhiteList	Array of String	0.0.0.0/0	Lista de permissões de endereços IP da instância.
publicIpWhitelist	Array of String	[ "0.0.0.0/0" ]	Lista de permissões de acesso ao endpoint público da instância.
kibanaPrivateIPWhitelist	Array of String	["192.168.XX.XX"]	Lista de endereços IP privados na lista de permissões do Kibana.
esIPBlacklist	Array of String	[ "0.0.0.0/0" ]	Lista de bloqueios de acesso à rede privada (descontinuada).
kibanaIPWhitelist	Array of String	[ "0.0.0.0/0" ]	Lista de permissões de acesso ao endpoint público do Kibana.
nodeSpec	Object		Configurações dos nós de dados.
spec	String	elasticsearch.n4.small	Categoria da especificação. Para mais informações, consulte Especificações do produto.
disk	Integer	0	Capacidade de armazenamento. Unidade: GB.
diskEncryption	Boolean	true	Indica se a criptografia de disco está ativada. Valores válidos: true: ativado false: desativado
diskType	String	cloud_ssd	Categoria do disco do nó. Valores válidos: cloud_ssd: SSD padrão cloud_efficiency: disco ultra
performanceLevel	String	PL1	Nível de desempenho (PL) do ESSD. Este parâmetro é retornado se o valor de diskType for cloud_essd. Valores válidos: PL1, PL2 e PL3.
specInfo	String	1C 2G	Descrição das especificações do nó.
networkConfig	Object		Tipo de rede.
vpcId	String	vpc-abc	ID da Virtual Private Cloud (VPC).
vsArea	String	cn-hangzhou-b	Zona onde o cluster reside.
type	String	vpc	Tipo de rede. Apenas VPC é suportada.
vswitchId	String	vsw-abc	ID do vSwitch.
whiteIpGroupList	Array of whiteIpGroupList		Lista de grupos de permissões.
whiteIpType	String	PRIVATE_ES	Tipo da lista de permissões. Valores válidos: PRIVATE_ES: lista de permissões de endereços IP privados para Elasticsearch PUBLIC_ES: lista de permissões de endereços IP públicos para Elasticsearch PRIVATE_KIBANA: lista de permissões de endereços IP privados para Kibana PUBLIC_KIBANA: lista de permissões de endereços IP públicos para Kibana
groupName	String	default	Nome do grupo da lista de permissões. Por padrão, o grupo de permissões padrão está incluído.
ips	Array of String	["0.0.0.0", "127.0.XX.XX"]	Endereços IP na lista de permissões.
kibanaConfiguration	Object		Configurações dos nós do Kibana.
amount	Integer	1	Quantidade de nós.
spec	String	elasticsearch.n4.small	Categoria da especificação. Para mais informações, consulte Especificações do produto.
disk	Integer	20	Capacidade de armazenamento de cada nó. Unidade: GB.
specInfo	String	1C 2G	Descrição das especificações do nó.
masterConfiguration	Object		Configurações dos nós mestres dedicados.
spec	String	elasticsearch.n4.small	Categoria da especificação. Para mais informações, consulte Especificações do produto.
amount	Integer	3	Quantidade de nós.
disk	Integer	40	Capacidade de armazenamento. Unidade: GB.
diskType	String	cloud_ssd	Tipo de armazenamento. Apenas cloud_ssd é suportado.
specInfo	String	1C 2G	Descrição das especificações do nó.
clientNodeConfiguration	Object		Configurações dos nós clientes.
spec	String	elasticsearch.n4.small	Categoria da especificação. Para mais informações, consulte Especificações do produto.
amount	Integer	3	Quantidade de nós.
disk	Integer	40	Capacidade de armazenamento. Unidade: GB.
diskType	String	cloud_efficiency	Tipo de armazenamento. Apenas cloud_efficiency é suportado.
specInfo	String	1C 2G	Descrição das especificações do nó.
warmNodeConfiguration	Object		Configurações dos nós warm.
amount	Integer	6	Quantidade de nós.
spec	String	elasticsearch.n4.small	Categoria da especificação. Para mais informações, consulte Especificações do produto.
disk	Integer	500	Capacidade de armazenamento. Unidade: GB.
diskEncryption	Boolean	true	Indica se a criptografia de disco está ativada. Valores válidos: true: ativado false: desativado
diskType	String	cloud_efficiency	Tipo de armazenamento. Apenas cloud_efficiency é suportado.
specInfo	String	1C 2G	Descrição das especificações do nó.
advancedSetting	Object		Configurações avançadas.
gcName	String	CMS	Nome do coletor de lixo (GC). Valores válidos: CMS e G1.
elasticDataNodeConfiguration	Object		Configurações dos nós elásticos.
amount	Integer	3	Quantidade de nós.
spec	String	elasticsearch.sn2ne.large	Categoria da especificação. Para mais informações, consulte Especificações do produto.
disk	Integer	20	Capacidade de armazenamento. Unidade: GB.
diskEncryption	Boolean	true	Indica se a criptografia de disco está ativada. Valores válidos: true: ativado false: desativado
diskType	String	cloud_ssd	Tipo de armazenamento. Valores válidos: cloud_ssd: SSD padrão cloud_essd: Enhanced SSD (ESSD) cloud_efficiency: disco ultra.
specInfo	String	1C 2G	Descrição das especificações do nó.
ikHotDicts	Array of ikHotDicts		Configurações de atualizações contínuas para dicionários IK.
type	String	MAIN	Tipo do dicionário a ser atualizado. Valores válidos: MAIN: dicionário principal IK STOP: lista de stopwords IK
sourceType	String	OSS	Tipo de source do arquivo de dicionário. Valores válidos: OSS ORIGIN
fileSize	Integer	6	Tamanho do arquivo de dicionário. Unidade: bytes.
name	String	deploy_0.dic	Nome do arquivo de dicionário.
instanceCategory	String	advanced	Edição do cluster Elasticsearch. Valores retornados: x-pack: Edição Standard advanced/IS: Edição Enhanced community: Edição Basic
endtime	Long	1715826092044	Horário de expiração da instância de reserva de cache.
archType	String	public	Modo de implantação e tipo de arquitetura: exclusive: gerenciamento básico public: novo controle nativo da nuvem
kibanaPrivateDomain	String	es-cn-x0r3*********.elasticsearch.aliyuncs.com	Endpoint privado do Kibana.
kibanaPrivatePort	String	5601	Porta privada do Kibana.

Nota

No exemplo de retorno a seguir, apenas os parâmetros listados nos dados retornados são garantidos; os demais servem apenas como referência. Não force o programa a depender da obtenção desses parâmetros não documentados.

Exemplos

Exemplos de requisições

GET /openapi/instances/es-cn-3h4k3axh33th9**** HTTP/1.1
Host:elasticsearch.aliyuncs.com
Content-Type:application/json

Exemplos de respostas de sucesso

Formato JSON

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

{
  "Result" : {
    "instanceId" : "es-cn-3h4k3axh33th9****",
    "domain" : "es-cn-3h4k3axh33th9****.elasticsearch.aliyuncs.com",
    "description" : "es-cn-3h4k3axh33th9****",
    "nodeAmount" : 2,
    "paymentType" : "postpaid",
    "status" : "active",
    "port" : 9200,
    "esVersion" : "6.3.2_with_X-Pack",
    "archType" : "exclusive",
    "instanceCategory" : "x-pack",
    "esConfig" : {
      "action.destructive_requires_name" : "true",
      "xpack.security.audit.outputs" : "index",
      "xpack.watcher.enabled" : "false",
      "xpack.security.audit.enabled" : "false",
      "action.auto_create_index" : "+.*,-*"
    },
    "esIPWhitelist" : [ "0.0.0.0/0" ],
    "esIPBlacklist" : [ ],
    "privateNetworkIpWhiteList" : [ "0.0.0.0/0" ],
    "kibanaIPWhitelist" : [ "0.0.0.0/0", "::/0" ],
    "publicIpWhitelist" : [ ],
    "kibanaDomain" : "es-cn-3h4k3axh33th9****.kibana.elasticsearch.aliyuncs.com",
    "kibanaPort" : 5601,
    "enablePublic" : false,
    "haveKibana" : true,
    "nodeSpec" : {
      "spec" : "elasticsearch.sn1ne.large",
      "disk" : 21,
      "diskType" : "cloud_ssd"
    },
    "serviceVpc" : true,
    "networkConfig" : {
      "vpcId" : "vpc-bp13n1j3fcv1cqfkg****",
      "vswitchId" : "vsw-bp12q2vrqvko0ilg8****",
      "vsArea" : "cn-hangzhou-h",
      "type" : "vpc",
      "whiteIpGroupList" : [ {
        "groupName" : "default",
        "whiteIpType" : "PRIVATE_ES",
        "ips" : [ "0.0.0.0", "127.0.XX.XX" ]
      } ]
    },
    "createdAt" : "2019-08-28T07:48:59.736Z",
    "updatedAt" : "2019-08-28T08:11:33.229Z",
    "inited" : true,
    "dedicateMaster" : false,
    "advancedDedicateMaster" : false,
    "masterConfiguration" : { },
    "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" : 4722681600000,
    "dictList" : [ {
      "name" : "SYSTEM_MAIN.dic",
      "fileSize" : 2782602,
      "type" : "MAIN",
      "sourceType" : "ORIGIN"
    }, {
      "name" : "SYSTEM_STOPWORD.dic",
      "fileSize" : 132,
      "type" : "STOP",
      "sourceType" : "ORIGIN"
    } ],
    "synonymsDicts" : [ ],
    "ikHotDicts" : [ ],
    "aliwsDicts" : [ ],
    "clusterTasks" : [ ],
    "vpcInstanceId" : "es-cn-3h4k3axh33th9****-worker",
    "resourceGroupId" : "rg-acfm3ghp32r****",
    "zoneCount" : 1,
    "protocol" : "HTTP",
    "haveGrafana" : false,
    "haveCerebro" : false,
    "zoneInfos" : [ {
      "zoneId" : "cn-hangzhou-h",
      "status" : "NORMAL"
    } ],
    "enableKibanaPublicNetwork" : true,
    "advancedSetting" : {
      "gcName" : "CMS"
    }
  },
  "RequestId" : "68104CC2-DA27-446D-8049-A024F0D4EFEC"
}

Códigos de erro

Para obter uma lista de códigos de erro, consulte Códigos de erro do serviço.