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

Descripción de la operación

Método

GET

URI

/openapi/ha3/instances/{instanceId}/data-sources/{dataSourceName}/schemas

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

list

*Instance

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

Ninguna

Sintaxis de la solicitud

GET /openapi/ha3/instances/{instanceId}/data-sources/{dataSourceName}/schemas 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****
dataSourceName	string	Sí	El nombre del origen de datos.	ha-cn-pl32rf0****_test_api

Parámetros de la solicitud

Parámetro

Tipo

Obligatorio

Descripción

Ejemplo

Solicitudes de ejemplo

GET /openapi/ha3/instances/ha3_instances_id/data-sources/my_data_source/schemas

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Los resultados devueltos.
requestId	string	El ID de la solicitud.	022F36C7-9FB4-5D67-BEBC-3D14B0984463
result	array<object>	Los resultados devueltos.
	array<object>	La información de esquema.
name	string	El nombre del campo.	id
custom	boolean	Indica si el campo es un campo personalizado. Valores válidos: true y false.	false
type	string	El tipo de campo.	STRING
attribute	boolean	Indica si el campo es un campo de atributo. Valores válidos: true y false.	false
summary	boolean	Indica si el campo se puede mostrar. Valores válidos: true y false.	false
primaryKey	object	El campo de clave primaria.
isPrimaryKey	boolean	Indica si el campo es la clave primaria. Valores válidos: true y false.	false
hasPrimaryKeyAttribute	boolean	Indica si el campo tiene el atributo de clave primaria. Valores válidos: true y false.	false
isPrimaryKeySorted	boolean	Indica si el campo se puede ordenar. Valores válidos: true y false.	false
addIndex	boolean	Indica si el campo tiene el atributo de índice. Valores válidos: true y false.	false

Respuestas de ejemplo.

Respuestas correctas

{
  "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",
  "result":[
    {
      "summary": false,
      "custom": false,
      "addIndex": false,
      "type": "INT64",
      "name": "id",
      "attribute": false,
      "primaryKey": {
        "hasPrimaryKeyAttribute": false,
        "primaryKeySorted": false,
        "primaryKey": false
      }
    },
    {
      "summary": false,
      "custom": false,
      "addIndex": false,
      "type": "STRING",
      "name": "fb_boolean",
      "attribute": false,
      "primaryKey": {
        "hasPrimaryKeyAttribute": false,
        "primaryKeySorted": false,
        "primaryKey": false
      }
    }
  ]
}

Ejemplos

Respuesta exitosa

JSON Formato

{
  "requestId": "022F36C7-9FB4-5D67-BEBC-3D14B0984463",
  "result": [
    {
      "name": "id",
      "custom": false,
      "type": "STRING",
      "attribute": false,
      "summary": false,
      "primaryKey": {
        "isPrimaryKey": false,
        "hasPrimaryKeyAttribute": false,
        "isPrimaryKeySorted": false
      },
      "addIndex": false
    }
  ]
}

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.