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

A operação ListInstanceIndices aplica-se apenas a clusters Elasticsearch com o Indexing Service ativado. Recomendamos usar uma API do Elasticsearch para consultar informações dos índices. Para mais detalhes, consulte cat indices API.

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Para sua conveniência, recomendamos chamar esta operação no OpenAPI Explorer. O OpenAPI Explorer 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 de requisição específicos e utiliza apenas os cabeçalhos comuns. Para mais informações, consulte a seção "Common request headers" do tópico "Common parameters".

Sintaxe da requisição

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

Parâmetros da requisição

Parameter	Type	Position	Required	Example	Description
InstanceId	String	Path	Yes	es-cn-tl329rbpc0001****	ID do cluster.
all	Boolean	Query	No	false	Define se todos os índices devem ser consultados. Valores válidos: true: consulta todos os índices, incluindo os de sistema. false (padrão): consulta os índices, exceto os de sistema.
name	String	Query	No	log-0001	Nome do índice. Aceita correspondência aproximada.
isManaged	Boolean	Query	No	false	Indica se a consulta deve retornar apenas índices hospedados. Valores válidos: true false (padrão)
isOpenstore	Boolean	Query	No	false	Define se apenas os índices OpenStore na fase fria devem ser consultados. Valores válidos: true false (padrão)
page	Integer	Query	No	1	Número da página. A paginação começa em 1. Valor padrão: 1.
size	Integer	Query	No	15	Quantidade de entradas por página. Valor máximo: 100. Valor padrão: 20.

Parâmetros de resposta

Parameter	Type	Example	Description
RequestId	String	F99407AB-2FA9-489E-A259-40CF6DCC****	ID da requisição.
Headers	Object		Cabeçalho da resposta.
X-Managed-StorageSize	Long	18093942932	Tamanho total dos índices hospedados. Unidade: bytes.
X-Managed-Count	Integer	15	Número total de índices hospedados.
X-OSS-StorageSize	Long	9093942932	Tamanho total dos índices OpenStore na fase fria. Unidade: bytes.
X-OSS-Count	Integer	5	Quantidade total de índices OpenStore na fase fria.
Result	Array of Result		Os índices.
isManaged	String	false	Este parâmetro está obsoleto.
createTime	String	2021-01-11T05:49:41.114Z	Momento da consulta à lista de índices.
size	Long	49298589	Espaço total de armazenamento ocupado pelos índices. Unidade: bytes.
managedStatus	String	closing	Status de hospedagem do índice. Valores válidos: following: o índice está sendo hospedado. closing: a hospedagem está sendo cancelada. closed: o índice não está hospedado.
name	String	.kibana_task_manager_1	Nome do índice.
health	String	green	Status de execução do índice. Valores válidos: green: saudável yellow: em alerta red: anormal
phase	String	warm	Ciclo de vida de armazenamento. Valores válidos: warm cold hot exclua Nota Se este parâmetro estiver vazio, o índice não está hospedado.
ilmExplain	String	{ "indices": { ".ds-console-2021.08.18-000002": { "index": ".ds-console-2021.08.18-000002", "managed": true, "policy": "console", "lifecycle_date_millis": 1629277498775, "age": "2.64h", "phase": "hot", "phase_time_millis": 1629277450334, "action": "complete", "action_time_millis": 1629278605586, "step": "complete", "step_time_millis": 1629278605586, "phase_execution": { "policy": "console", "phase_definition": { "min_age": "0s", "actions": { "rollover": { "max_size": "1gb", "max_age": "1d", "max_docs": 10000 }, "set_priority": { "priority": 1000 } } }, "version": 1, "modified_date_in_millis": 1629277370953 } } } }	Status completo do ciclo de vida do índice.

Exemplos

Exemplos de requisições

GET /openapi/instances/es-cn-tl329rbpc0001****/indices?all=false&name=log-0001&isManaged=false&isOpenstore=false&page=1&size=15 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

{
  "RequestId" : "F99407AB-2FA9-489E-A259-40CF6DCC****",
  "Result" : [ {
    "name" : ".kibana_task_manager_1",
    "health" : "green",
    "size" : 4929858933232,
    "createTime" : "2021-01-11T05:49:41.114Z",
    "managedStatus" : "closing",
    "ilmExplain" : "{\n    \"indices\": {\n        \".kibana_task_manager_1\": {\n            \"index\": \".kibana_task_manager_1\",\n            \"managed\": false\n        }\n    }\n}"
  }, {
    "name" : ".ds-console-2021.08.18-000002",
    "health" : "yellow",
    "size" : 49298589,
    "createTime" : "2021-01-11T05:49:41.114Z",
    "managedStatus" : "following",
    "phase" : "warm",
    "ilmExplain" : "{\n  \"indices\": {\n    \".ds-console-2021.08.18-000002\": {\n      \"index\": \".ds-console-2021.08.18-000002\",\n      \"managed\": true,\n      \"policy\": \"console\",\n      \"lifecycle_date_millis\": 1629277498775,\n      \"age\": \"2.64h\",\n      \"phase\": \"hot\",\n      \"phase_time_millis\": 1629277450334,\n      \"action\": \"complete\",\n      \"action_time_millis\": 1629278605586,\n      \"step\": \"complete\",\n      \"step_time_millis\": 1629278605586,\n      \"phase_execution\": {\n        \"policy\": \"console\",\n        \"phase_definition\": {\n          \"min_age\": \"0s\",\n          \"actions\": {\n            \"rollover\": {\n              \"max_size\": \"1gb\",\n              \"max_age\": \"1d\",\n              \"max_docs\": 10000\n            },\n            \"set_priority\": {\n              \"priority\": 1000\n            }\n          }\n        },\n        \"version\": 1,\n        \"modified_date_in_millis\": 1629277370953\n      }\n    }\n  }\n}"
  } ],
  "Headers" : {
    "X-Managed-Count" : 15,
    "X-Managed-StorageSize" : 18093942932,
    "X-OSS-Count" : 5,
    "X-OSS-StorageSize" : 9093942932
  }
}

Códigos de erro

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