ListClusters - OpenSearch: Central de Documentação do Alibaba Cloud

Consulta clusters.

Descrição da operação

Método

GET

URI

/openapi/ha3/instances/{instanceId}/clusters

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

searchengine:ListClusters

list

*Instance

acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}

Nenhuma

Sintaxe da solicitação

GET /openapi/ha3/instances/{instanceId}/clusters HTTP/1.1

Parâmetros de caminho

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
instanceId	string	Sim	O ID da instância.	ha-cn-pl32rf0****

Parâmetros da solicitação

Parâmetro

Tipo

Obrigatório

Descrição

Exemplo

Nenhum parâmetro necessário.

Exemplos de solicitações

GET /openapi/ha3/instances/ha3_instance_name/clusters

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	The response parameters.
requestId	string	O ID da solicitação.	F43E8AB4-419C-5F4C-90D6-615590DFAA3C
result	array<object>	Os clusters.
	array<object>	A lista de clusters.
name	string	O nome do cluster.	hz_pre_vpc_domain_1
description	string	A descrição do cluster.	自定义描述
currentAdvanceConfigVersion	string	A versão efetiva da configuração avançada.	ha-cn-pl32rf0****_offline_adv_v1
latestAdvanceConfigVersion	string	A versão mais recente da configuração avançada.	ha-cn-pl32rf0****_offline_adv_v1
currentOnlineConfigVersion	string	A versão efetiva da configuração online.	ha-cn-pl32rf0****_offline_adv_v1
latestOnlineConfigVersion	string	A versão mais recente da configuração online.	ha-cn-pl32rf0****_offline_adv_v1
currentOnlineQueryConfigVersion	string	A versão efetiva da configuração de consulta.	ha-cn-pl32rf0****_offline_adv_v1
latestOnlineQueryConfigVersion	string	A versão mais recente da configuração de consulta.	ha-cn-pl32rf0****_offline_adv_v1
currentOfflineDictConfigVersion	string	A versão efetiva da configuração de dicionário.	ha-cn-pl32rf0****_offline_adv_v1
latestOfflineDictConfigVersion	string	A versão mais recente da configuração de dicionário.	ha-cn-pl32rf0****_offline_adv_v1
configUpdateTime	string	A hora em que a configuração foi atualizada.	2024-05-21 16:05:26
status	string	O status do cluster. Valores válidos: running: O cluster está em execução. starting: O cluster está sendo iniciado. stopping: O cluster está sendo parado. stopped: O cluster está parado.	running
queryNode	object	As informações sobre os workers do Query Result Searcher (QRS).
name	string	The name of the QRS worker.	ha-cn-pl32rf0****_qrs
number	integer	The number of QRS workers.	1
partition	integer	The ID of the partition that is stored on the QRS worker.	1
dataNode	object	As informações sobre os workers Searcher.
name	string	The name of the Searcher worker.	general
number	integer	The number of Searcher workers.	1
partition	integer	The ID of the partition that is stored on the Searcher worker.	1
createTime	string	A hora em que o cluster foi criado.	2024-05-21 16:05:26
config	object	As informações de configuração.
	object	As informações de configuração.
	object	As informações sobre os itens de configuração filho.
name	string	The configuration name.	ha-cn-pl32rf0****_offline_adv_v1
updateTime	string	The time when the configuration was updated.	2024-05-21 16:05:26
desc	string	The description of the configuration.	自定义描述

Exemplo de resposta

Resposta correta

{
  "requestId": "e1eef569-1ff7-4bf8-acf7-1cecca9894ce",
  "result": [
    {
      "name": "cluster1",
      "configUpdateTime": "2021-08-09 00:01:02",
      "currentAdvanceConfigVersion": "test_yyds_data1",
      "lastestAdvanceConfigVersion": "test_yyds_data1",
      "currentOnlineConfigVersion": "test_yyds_data1",
      "lastestOnlineConfigVersion": "test_yyds_data1",        
      "description": "airecpre",
      "queryNode": {
        "number": 1
      },
      "dataNode": {
        "number": 2,
        "partition": 1
      },      
    },
    {
      "name": "cluster2",
      "configUpdateTime": "2021-08-09 00:01:02",
      "currentAdvanceConfigVersion": "test_yyds_data2",
      "lastestAdvanceConfigVersion": "test_yyds_data2",
      "currentOnlineConfigVersion": "test_yyds_data1",
      "lastestOnlineConfigVersion": "test_yyds_data1",              
      "description": "this is descrition",
      "queryNode": {
        "number": 1
      },
      "dataNode": {
        "number": 2,
        "partition": 1
      }
    }
  ]
}

Exemplos

Resposta de sucesso

JSON formato

{
  "requestId": "F43E8AB4-419C-5F4C-90D6-615590DFAA3C",
  "result": [
    {
      "name": "hz_pre_vpc_domain_1",
      "description": "Custom description",
      "currentAdvanceConfigVersion": "ha-cn-pl32rf0****_offline_adv_v1",
      "latestAdvanceConfigVersion": "ha-cn-pl32rf0****_offline_adv_v1",
      "currentOnlineConfigVersion": "ha-cn-pl32rf0****_offline_adv_v1",
      "latestOnlineConfigVersion": "ha-cn-pl32rf0****_offline_adv_v1",
      "currentOnlineQueryConfigVersion": "ha-cn-pl32rf0****_offline_adv_v1",
      "latestOnlineQueryConfigVersion": "ha-cn-pl32rf0****_offline_adv_v1",
      "currentOfflineDictConfigVersion": "ha-cn-pl32rf0****_offline_adv_v1",
      "latestOfflineDictConfigVersion": "ha-cn-pl32rf0****_offline_adv_v1",
      "configUpdateTime": "2024-05-21 16:05:26",
      "status": "running",
      "queryNode": {
        "name": "ha-cn-pl32rf0****_qrs",
        "number": 1,
        "partition": 1
      },
      "dataNode": {
        "name": "general",
        "number": 1,
        "partition": 1
      },
      "createTime": "2024-05-21 16:05:26",
      "config": {
        "key": {
          "key": {
            "name": "ha-cn-pl32rf0****_offline_adv_v1",
            "updateTime": "2024-05-21 16:05:26",
            "desc": "自定义描述"
          }
        }
      }
    }
  ]
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.