GetCluster - OpenSearch - Centro de documentación de Alibaba Cloud

Consulta los detalles de un clúster específico.

Descripción de la operación

Método

GET

URI

/openapi/ha3/instance/{instanceId}/clusters/{clusterName}

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

searchengine:GetCluster

get

*Instance.

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

Ninguna

Sintaxis de la solicitud

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

Parámetros de ruta

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
instanceId	string	Sí	El ID de la instancia.	ha-cn-pl32rf0****
clusterName	string	No	El nombre del clúster.	bj_vpc_domain_2

Parámetros de la solicitud

Parámetro

Tipo

Obligatorio

Descripción

Ejemplo

Ejemplo de solicitud

GET /openapi/ha3/instance/ha_name_example/clusters/my_cluster

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	El esquema de la respuesta.
requestId	string	El ID de la solicitud.	E7B7D598-B080-5C8E-AA35-D43EC0D5F886
result	object	El resultado devuelto.
name	string	El nombre del clúster.	bj_vpc_domain_2
description	string	La descripción del clúster.	Custom description
currentAdvanceConfigVersion	string	La versión efectiva de la configuración avanzada.	ha-cn-pl32rf0****_offline_adv_v1
latestAdvanceConfigVersion	string	La versión más reciente de la configuración avanzada.	ha-cn-pl32rf0****_offline_adv_v1
currentOnlineConfigVersion	string	La versión efectiva de la configuración en línea.	ha-cn-pl32rf0****_online_adv_v1
latestOnlineConfigVersion	string	La versión más reciente de la configuración en línea.	ha-cn-pl32rf0****_online_adv_v1
configUpdateTime	string	La hora en que se actualizó el clúster. El formato es AAAA-MM-DD HH:mm:ss.	2021-08-09 00:01:02
status	string	El estado de creación del clúster. Valores válidos: NEW (en creación) y PUBLISH (creado).	NEW
queryNode	object	Las especificaciones del nodo de consulta.
name	string	El nombre del nodo.	ha-cn-pl32rf0****_qrs
number	integer	El número de nodos.	1
partition	integer	El número de réplicas.	2
dataNode	object	Las especificaciones del nodo de datos.
name	string	El nombre del nodo.	general
number	integer	El número de réplicas.	1
partition	integer	El número de fragmentos.	2
createTime	string	La hora de creación. El formato es AAAA-MM-DD HH:mm:ss.	2024-05-21 16:05:26
config	object	La información de configuración.
	object	La información del elemento de configuración secundario.
	object	La información del elemento de configuración secundario.
name	string	The configuration name.	ha-cn-pl32rf0****_offline_adv_v1
updateTime	string	La hora de actualización en el formato YYYY-MM-DD HH:mm:ss.	2024-05-21 16:05:26
desc	string	The description.	自定义描述

Ejemplo de respuesta

{
  "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": {
      "name":"ha-cn-0ju2iimcu07_qrs",
      "number": 1
    },
    "dataNode": {
      "name":"general",
      "number": 2,
      "partition": 1
    }    
  }
}

Ejemplos

Respuesta exitosa

JSON Formato

{
  "requestId": "E7B7D598-B080-5C8E-AA35-D43EC0D5F886",
  "result": {
    "name": "bj_vpc_domain_2",
    "description": "自定义描述",
    "currentAdvanceConfigVersion": "ha-cn-pl32rf0****_offline_adv_v1",
    "latestAdvanceConfigVersion": "ha-cn-pl32rf0****_offline_adv_v1",
    "currentOnlineConfigVersion": "ha-cn-pl32rf0****_online_adv_v1",
    "latestOnlineConfigVersion": "ha-cn-pl32rf0****_online_adv_v1",
    "configUpdateTime": "2021-08-09 00:01:02",
    "status": "NEW",
    "queryNode": {
      "name": "ha-cn-pl32rf0****_qrs",
      "number": 1,
      "partition": 2
    },
    "dataNode": {
      "name": "general",
      "number": 1,
      "partition": 2
    },
    "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 error

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.