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

Descripción de la operación

Método

GET

URI

/openapi/ha3/instances/{instanceId}/node-config

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:GetNodeConfig

get

*Instance

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

Ninguna

Sintaxis de la solicitud

GET /openapi/ha3/instances/{instanceId}/node-config 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****

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
type	string	No	El tipo de nodo. Valores válidos: qrs: nodo de consulta search: nodo de datos index: nodo de índice cluster: clúster.	index
name	string	No	El nombre del nodo.	ha-cn-30174dhoz53_qrs
clusterName	string	No	El nombre del clúster.	vpc_sh_domain_2

Ejemplo de solicitud

GET /openapi/ha3/instances/{instanceId}/node-config?type=qrs&name=test&

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
requestId	string	El ID de la solicitud.	2AE63638-5420-56DC-BF59-37D8174039A0
result	object	El resultado devuelto.
dataFragmentNumber	integer	El número de fragmentos de datos.	1
dataDuplicateNumber	integer	El número de réplicas de datos.	1
minServicePercent	integer	El porcentaje mínimo de servicio.	50
published	boolean	Indica si el clúster está montado.	true
active	boolean	Indica si el índice está activo en línea.	true
flowRatio	integer	La proporción de tráfico.	100

Ejemplo de respuesta

Respuesta exitosa

{

  "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",

  "result": {

    "dataFragmentNumber":1,

    "dataDuplicateNumber":1,

    "minServicePercent":20,

    "published":true,

    "active": true  // Indica si el índice está activo en línea.

  }

}

Ejemplos

Respuesta exitosa

JSON Formato

{
  "requestId": "2AE63638-5420-56DC-BF59-37D8174039A0",
  "result": {
    "dataFragmentNumber": 1,
    "dataDuplicateNumber": 1,
    "minServicePercent": 50,
    "published": true,
    "active": true,
    "flowRatio": 100
  }
}

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.