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

Obtiene los detalles de una instancia especificada por su ID de instancia.

Descripción de la operación

Método

GET

URI

/openapi/ha3/instances/{instanceId}

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

get

*Instance.

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

Ninguna

Sintaxis de la solicitud

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

Ejemplo de solicitud

GET /openapi/ha3/instances/ha3-cn-xxxxxx

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Esquema de la respuesta.
result	object	El resultado.
description	string	La descripción de la instancia.	test
resourceGroupId	string	El ID del grupo de recursos.	rg-aekzjvw24****
expiredTime	string	La hora de vencimiento. El formato es AAAA-MM-DD HH:mm:ss.S.	024-05-21 16:49:31.0
commodityCode	string	El código de producto.	opensearch_ha3post_public_cn
instanceId	string	El ID del recurso principal.	ha-cn-pl32rf0****
createTime	string	La hora de creación.	2022-06-17T02:01:26Z
lockMode	string	El estado de bloqueo.	Unlock
chargeType	string	El método de facturación.	POSYPAY
updateTime	string	La hora de actualización. El formato es AAAA-MM-DD HH:mm:ss.S.	024-05-21 16:49:31.0
inDebt	boolean	Indica si la instancia tiene un pago vencido.	false
status	string	La fase del estado de la instancia. Valores válidos: INIT: Inicialización. WAIT_CONFIG: Configuración pendiente. CONFIG_UPDATING: Configuración en proceso de aplicación. READY: Normal.	INIT
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
bsVersion	string	La versión de BS.	bs_3.13.2
noQrs	boolean	Indica si la instancia es una instancia de un solo nodo.	false
newMode	boolean	Indica si se utiliza la nueva versión de la consola.	true
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 el nombre de dominio público.	127.0.0.1
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.	2
mem	integer	El tamaño de la memoria. Unidad: GB.	10
disk	integer	El espacio de almacenamiento del nodo. Unidad: GB.	100
nodeCount	integer	El número de nodos.	1
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.	2
mem	integer	El tamaño de la memoria. Unidad: GB.	10
disk	integer	El espacio de almacenamiento del nodo. Unidad: GB.	100
nodeCount	integer	El número de nodos.	1
zoneCount	integer	El número de zonas.	1
requestId	string	El ID de la solicitud.	E7B7D598-B080-5C8E-AA35-D43EC0D5F886

Ejemplos de respuesta

Ejemplo de respuesta exitosa

{
    "result":
    {
        "inDebt": false,
        "lockMode": "Unlock",
        "trFreeUrl": "",
        "chargeType": "POSTPAY",
        "edition": "vector",
        "description": "ha-cn-vkl3rgrfc01",
        "updateTime": "2024-05-30 10:52:00.0",
        "userName": "admin",
        "version": "vector_service_1.2.2",
        "spec":
        {
            "qrsResource":
            {
                "category": "local_ssd",
                "cpu": 2,
                "mem": 8,
                "disk": 100,
                "nodeCount": 0
            },
            "searchResource":
            {
                "category": "local_ssd",
                "cpu": 2,
                "mem": 16,
                "disk": 100,
                "nodeCount": 1
            }
        },
        "network":
        {
            "vSwitchId": "vsw-bp16qw5mbrzx66lv4n0m2",
            "vpcId": "vpc-bp1956duqqe2lm2lvqjf1",
            "endpoint": "ha-cn-vkl3rgrfc01.ha.aliyuncs.com"
        },
        "tags":
        [
            {
                "value": "rg-acfmv2hk2jpsxia",
                "key": "acs:rm:rgId"
            }
        ],
        "noQrs": true,
        "instanceId": "ha-cn-vkl3rgrfc01",
        "createTime": "2024-05-30 10:50:33.0",
        "commodityCode": "opensearch_ha3post_public_cn",
        "resourceGroupId": "rg-acfmv2hk2jpsxia",
        "newMode": true,
        "status": "READY"
    },
    "requestId": "B916FBC8-DF19-1D12-A72F-61AFFDD871AD"
}

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": "rg-aekzjvw24****",
    "expiredTime": "024-05-21 16:49:31.0",
    "commodityCode": "opensearch_ha3post_public_cn",
    "instanceId": "ha-cn-pl32rf0****",
    "createTime": "2022-06-17T02:01:26Z",
    "lockMode": "Unlock",
    "chargeType": "POSYPAY",
    "updateTime": "024-05-21 16:49:31.0",
    "inDebt": false,
    "status": "INIT",
    "tags": [
      {
        "key": "opensearch",
        "value": "opensearch"
      }
    ],
    "edition": "vector",
    "userName": "admin",
    "version": "ha3_3.10.0",
    "bsVersion": "bs_3.13.2",
    "noQrs": false,
    "newMode": true,
    "network": {
      "vSwitchId": "vsw-bp11ldcf59q2n****\n",
      "vpcId": "vpc-wz9axk41d9vff****\n",
      "endpoint": "ha-cn-35t3r****.ha.aliyuncs.com\n",
      "publicEndpoint": "ha-cn-35t3ni****.public.ha.aliyuncs.com\n",
      "allow": "127.0.0.1\n"
    },
    "spec": {
      "qrsResource": {
        "category": "local_ssd",
        "cpu": 2,
        "mem": 10,
        "disk": 100,
        "nodeCount": 1
      },
      "searchResource": {
        "category": "local_ssd",
        "cpu": 2,
        "mem": 10,
        "disk": 100,
        "nodeCount": 1
      }
    },
    "zoneCount": 1
  },
  "requestId": "E7B7D598-B080-5C8E-AA35-D43EC0D5F886"
}

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.