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

Obtiene una lista de instancias.

Descripción de la operación

Método

GET

URI

/openapi/ha3/instances

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

get

*Instance.

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

Ninguna

Sintaxis de la solicitud

GET /openapi/ha3/instances HTTP/1.1

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
pageNumber	integer	No	Especifica el número de página. Valor predeterminado: 1.	1
pageSize	integer	No	Especifica el número de entradas por página. Valor predeterminado: 10. Valores válidos: 1 a 50.	10
instanceId	string	No	El ID de la instancia.	ha-cn-pl32rf0****
description	string	No	Filtra instancias por descripción. Se admite la coincidencia aproximada.	searchengine instance
resourceGroupId	string	No	El ID del grupo de recursos.	rg-aekzgpiswzbksdi
edition	string	No	La edición de la instancia. Valores válidos: vector (Edición de índice vectorial) y engine (Edición de motor de recuperación).	vector
tags	array<object>	No	Las etiquetas.
	object	No	Las etiquetas de la instancia.
key	string	No	La clave de la etiqueta.	opensearch
value	string	No	El valor de la etiqueta.	opensearch
catalog	string	No	El ID del catálogo de datos de DLF.
database	string	No	El nombre de la base de datos de DLF.
table	string	No	El nombre de la tabla de origen de datos.
dataSourceType	string	No	El tipo de origen de datos.

Parámetro	Tipo	Obligatorio	Descripción
status	String	No	Filtra las instancias por estado de la instancia. Valores válidos: Running, Ready, Initializing y Starting.
expiredTime	Long	No	La hora de vencimiento utilizada para el filtrado. El valor es una marca de tiempo UNIX en segundos. Si el valor es mayor que la hora actual, se devuelven las instancias que están a punto de vencer. Las instancias vencidas no se incluyen.

Ejemplos

Ejemplo de solicitud

GET /openapi/ha3/instances?name=test&instanceId=abc&page=1&size=10

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Esquema de la respuesta.
result	array<object>	El resultado de la respuesta.
	array<object>	InstanceItemType.
description	string	La descripción de la instancia.	test
resourceGroupId	string	El ID del grupo de recursos.	ha-cn-pl32rf0****
expiredTime	string	La hora de vencimiento. El valor es una marca de tiempo UNIX en segundos.	1634885083
commodityCode	string	El código de producto.	opensearch_ha3post_public_cn
status	string	El estado.	READY
instanceId	string	El ID del recurso principal.	ha-cn-pl32rf0****
createTime	string	La hora de creación.	2022-06-04T02:03:21Z
lockMode	string	El estado de bloqueo.	Unlock
chargeType	string	El método de facturación.	POSTPAY
updateTime	string	La hora de actualización.	2018-12-06T11:17:49.0
inDebt	boolean	Indica si la instancia tiene un pago vencido.	false
network	object	La información de red de la instancia del motor de búsqueda.
vSwitchId	string	El ID del vSwitch.	vsw-bp11ldcf59q2n****
vpcId	string	El ID de la VPC.	vpc-wz9axk41d9vff****
endpoint	string	El endpoint de la puerta de enlace.	ha-cn-35t3r****.ha.aliyuncs.com
publicEndpoint	string	El nombre de dominio público.	ha-cn-35t3ni****.public.ha.aliyuncs.com
allow	string	La lista blanca para nombres de dominio públicos.	127.0.0.1
tags	array<object>	Las etiquetas.
	object	Las etiquetas.
key	string	La clave de la etiqueta.	opensearch
value	string	El valor de la etiqueta.	opensearch
edition	string	La edición de la instancia. Valores válidos: vector: Edición de búsqueda vectorial. engine: Edición de motor de recuperación.	vector
userName	string	El nombre de usuario.	admin
version	string	El número de versión del motor.	ha3_3.10.0
noQrs	boolean	Indica si la instancia es una instancia de un solo nodo.	false
spec	object	Las especificaciones del nodo.
qrsResource	object	Las especificaciones del nodo de consulta.
category	string	La familia de la instancia. Valores válidos: local_ssd: SSD local. cloud: Disco en la nube.	local_ssd
cpu	integer	El número de núcleos de CPU.	1
mem	integer	El tamaño de la memoria. Unidad: GB.	10
disk	integer	El tamaño del espacio de almacenamiento del nodo. Unidad: GB.	100
nodeCount	integer	El número de nodos.	3
searchResource	object	Las especificaciones del nodo de datos.
category	string	La familia de la instancia. Valores válidos: local_ssd: SSD local. cloud: Disco en la nube.	local_ssd
cpu	integer	El número de núcleos de CPU.	1
mem	integer	El tamaño de la memoria. Unidad: GB.	10
disk	integer	El tamaño del espacio de almacenamiento del nodo. Unidad: GB.	100
nodeCount	integer	El número de nodos.	3
dataSourceDetails	array<object>	Los detalles de los orígenes de datos asociados con la instancia.
	array<object>
indexName	string	El nombre del índice.	test_api
type	string	El tipo de origen de datos.	odps
config	object	La configuración del origen de datos.
endpoint	string	El endpoint de servicio del origen de datos de MaxCompute.	http://service.cn-hangzhou.maxcompute.aliyun-inc.com/api
accessKey	string	El ID de AccessKey del origen de datos de MaxCompute.	L***p
project	string	El nombre del proyecto de MaxCompute.	tisplus_dev
partition	string	La partición de MaxCompute.	ds=20220713
table	string	El nombre de la tabla de SARO o MaxCompute.	dump_odps_demo
namespace	string	El espacio de nombres del origen de datos de SARO.	TEST_dump_demo_sj_na61hunbu2_share_holo
path	string	La ruta del archivo HDFS.	http://test_opensearch/sift_oss_test.data
ossPath	string	La ruta del archivo de OSS.	/test_opensearch/sift_oss_test.data
bucket	string	El nombre del bucket de OSS.	ha3test-oss
catalog	string	El ID del catálogo de datos de DLF.	clg-paimon-21cc136237a6457f8618f5f82d116d7e
database	string	El nombre de la base de datos de DLF.	dlf_test
tag	string	La etiqueta del origen de datos de DLF.	test_tag
totalCount	integer	El número total de registros.	5
requestId	string	El ID de la solicitud.	89B968E6-1E41-58DF-BB25-5F98ECC759CE

Ejemplos de respuesta

Ejemplo de respuesta correcta

{
    "result":
    [
        {
            "inDebt": false,
            "lockMode": "Unlock",
            "trFreeUrl": "",
            "chargeType": "POSTPAY",
            "edition": "engine",
            "description": "test",
            "updateTime": "2024-05-06 14:08:24.0",
            "userName": "admin",
            "version": "ha3_3.10.0",
            "spec":
            {
                "qrsResource":
                {
                    "category": "local_ssd",
                    "cpu": 2,
                    "mem": 8,
                    "disk": 100,
                    "nodeCount": 5
                },
                "searchResource":
                {
                    "category": "local_ssd",
                    "cpu": 2,
                    "mem": 16,
                    "disk": 100,
                    "nodeCount": 4
                }
            },
            "network":
            {
                "vSwitchId": "vsw-bp179zkffzyva26ua8xil",
                "vpcId": "vpc-bp1956duqqe2lm2lvqjf1",
                "endpoint": "ha-cn-35t3ni61z06.ha.aliyuncs.com",
                "publicEndpoint": "ha-cn-35t3ni61z06.public.ha.aliyuncs.com",
                "allow": "127.0.0.1"
            },
            "tags":
            [
                {
                    "value": "rg-acfmv2hk2jpsxia",
                    "key": "acs:rm:rgId"
                }
            ],
            "noQrs": false,
            "instanceId": "ha-cn-35t3ni61z06",
            "createTime": "2024-03-14 10:49:32.0",
            "commodityCode": "opensearch_ha3post_public_cn",
            "resourceGroupId": "rg-acfmv2hk2jpsxia",
            "status": "READY"
        }
    ],
    "requestId": "949FDF5E-6FF6-13B9-A196-59B25F143B7F",
    "totalCount": 1
}

Ejemplo de respuesta de error

{
  "requestId": "BD1EA715-DF6F-06C2-004C-C1FA0D3A9820",
  "httpCode": 404,
  "code": "App.NotFound",
  "message": "App not found"
}

Ejemplos

Respuesta exitosa

JSON Formato

{
  "result": [
    {
      "description": "test",
      "resourceGroupId": "ha-cn-pl32rf0****",
      "expiredTime": "1634885083",
      "commodityCode": "opensearch_ha3post_public_cn",
      "status": "READY",
      "instanceId": "ha-cn-pl32rf0****",
      "createTime": "2022-06-04T02:03:21Z",
      "lockMode": "Unlock",
      "chargeType": "POSTPAY",
      "updateTime": "2018-12-06T11:17:49.0",
      "inDebt": false,
      "network": {
        "vSwitchId": "vsw-bp11ldcf59q2n****",
        "vpcId": "vpc-wz9axk41d9vff****",
        "endpoint": "ha-cn-35t3r****.ha.aliyuncs.com",
        "publicEndpoint": "ha-cn-35t3ni****.public.ha.aliyuncs.com",
        "allow": "127.0.0.1"
      },
      "tags": [
        {
          "key": "opensearch",
          "value": "opensearch"
        }
      ],
      "edition": "vector",
      "userName": "admin",
      "version": "ha3_3.10.0",
      "noQrs": false,
      "spec": {
        "qrsResource": {
          "category": "local_ssd",
          "cpu": 1,
          "mem": 10,
          "disk": 100,
          "nodeCount": 3
        },
        "searchResource": {
          "category": "local_ssd",
          "cpu": 1,
          "mem": 10,
          "disk": 100,
          "nodeCount": 3
        }
      },
      "dataSourceDetails": [
        {
          "indexName": "test_api",
          "type": "odps",
          "config": {
            "endpoint": "http://service.cn-hangzhou.maxcompute.aliyun-inc.com/api",
            "accessKey": "L***p",
            "project": "tisplus_dev",
            "partition": "ds=20220713",
            "table": "dump_odps_demo",
            "namespace": "TEST_dump_demo_sj_na61hunbu2_share_holo",
            "path": "http://test_opensearch/sift_oss_test.data",
            "ossPath": "/test_opensearch/sift_oss_test.data",
            "bucket": "ha3test-oss",
            "catalog": "clg-paimon-21cc136237a6457f8618f5f82d116d7e",
            "database": "dlf_test",
            "tag": "test_tag"
          }
        }
      ]
    }
  ],
  "totalCount": 5,
  "requestId": "89B968E6-1E41-58DF-BB25-5F98ECC759CE"
}

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.