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

Descripción de la operación

Método

GET

URI

/openapi/ha3/instances/{instanceId}/tables

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

list

*Instance

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

Ninguna

Sintaxis de la solicitud

GET /openapi/ha3/instances/{instanceId}/tables 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
newMode	boolean	No	Especifica si la instancia de OpenSearch Vector Search Edition es de la nueva versión.	true

Solicitudes de ejemplo

GET /openapi/ha3/instances/{instanceId}/tables

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
requestId	string	El ID de la solicitud.	10D5E615-69F7-5F49-B850-00169ADE513C
result	array<object>	El resultado.
	object
name	string	El nombre del índice.	es_test_1b
indexStatus	string	El estado de la tabla de índices. Valores válidos: NEW, PUBLISH, IN_USE, NOT_USE, STOP_USE, RESTORE_USE y FAIL. Después de crear un índice en una instancia de OpenSearch Retrieval Engine Edition, el índice pasa al estado IN_USE. Si falla la creación del primer índice completo en una instancia de OpenSearch Vector Search Edition de la nueva versión, el índice se encuentra en el estado FAIL.	IN_USE
status	string	El estado de la tabla de índices. Valores válidos: NEW, PUBLISH, IN_USE, NOT_USE, STOP_USE, RESTORE_USE y FAIL. Después de crear un índice en una instancia de OpenSearch Retrieval Engine Edition, el índice pasa al estado IN_USE. Si falla la creación del primer índice completo en una instancia de OpenSearch Vector Search Edition de la nueva versión, el índice se encuentra en el estado FAIL.	IN_USE

Ejemplos

Respuesta exitosa

JSON Formato

{
  "requestId": "10D5E615-69F7-5F49-B850-00169ADE513C",
  "result": [
    {
      "name": "es_test_1b",
      "indexStatus": "IN_USE",
      "status": "IN_USE"
    }
  ]
}

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.