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

Obtiene una lista de instancias.

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

hologram:ListInstances

list

*Instancia.

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

Ninguna

Sintaxis de la solicitud

POST /api/v1/instances HTTP/1.1

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
body	object	No	El cuerpo de la solicitud.
resourceGroupId	string	No	El ID del grupo de recursos.	rg-acfmvscak73zmby
tag	array<object>	No	Las etiquetas de la instancia.
	object	No	Los detalles de la etiqueta.
key	string	No	La clave de la etiqueta.	mietiqueta
value	string	No	El valor de la etiqueta.	valor
cmsInstanceType	string	No	El tipo de instancia de CloudMonitor. Valores válidos: standard follower mc-acceleration warehouse high-memory serverless Nota Esto es para CloudMonitor.	standard

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
RequestId	string	El ID de la solicitud.	D1303CD4-AA70-5998-8025-F55B22C50840
InstanceList	array<object>	La lista de instancias.
	array<object>	Los detalles de la instancia.
CommodityCode	string	El código de producto, que es el mismo que el código de detalle del producto en el Centro de usuario.	hologram_postpay_public_cn
CreationTime	string	La hora de creación. La hora está en UTC y en formato ISO 8601.	2022-12-16T02:24:05Z
ExpirationTime	string	La hora de expiración. La hora está en UTC y en formato ISO 8601.	2023-05-04T16:00:00.000Z
InstanceId	string	El ID de la instancia.	hgpostcn-cn-aaab9ad2d8fb
InstanceName	string	El nombre de la instancia.	test_instance
InstanceStatus	string	El estado de la instancia. Valores válidos: Creating : En creación. Running : En ejecución normal. Suspended : Suspendida. Allocating : En proceso.	Running
InstanceType	string	El tipo de instancia. Valores válidos: Warehouse : Tipo de grupo de cómputo. Follower : Instancia seguidora de solo lectura. Standard : Tipo estándar. Serverless : Tipo serverless. Shared : Tipo compartido.	Standard
Tags	array<object>	La lista de etiquetas.
	object	Los detalles de la etiqueta.
Key	string	La clave de la etiqueta.	tag
Value	string	El valor de la etiqueta.	valor
InstanceChargeType	string	El método de facturación de la instancia. Valores válidos: PostPaid : Pago por uso. PrePaid : Suscripción.	PrePaid
LeaderInstanceId	string	El ID de la instancia principal.	hgprecn-cn-2r42sqvxm006
SuspendReason	string	El motivo de la suspensión.	Manual
EnableHiveAccess	string	Indica si la aceleración de Data Lakehouse Edition está habilitada. Valores válidos: true : Habilitado. false : Deshabilitado.	true
Version	string	La versión de la instancia.	1.3.37
ResourceGroupId	string	El ID del grupo de recursos.	rg-acfmvscak73zmby
Endpoints	array<object>	La lista de endpoints.
	object	Los detalles del endpoint.
Endpoint	string	El endpoint.	hgpostcn-cn-aaab9ad2d8fb-cn-hangzhou-internal.hologres.aliyuncs.com:80
Type	string	El tipo de red. Valores válidos: VPCSingleTunnel : VPC. Intranet : Red interna. VPCAnyTunnel : Ya no se admite para instancias nuevas. Internet : Internet.	Internet
Enabled	boolean	Indica si el endpoint está habilitado. Valores válidos: true : Habilitado. false : Deshabilitado.	true
VSwitchId	string	El ID del vSwitch.	vsw-wz9oap28raidjevhuszg4
VpcId	string	El ID de la VPC.	vpc-uf6mrahzyu7uorlqqpz5f
VpcInstanceId	string	El ID de la instancia conectada a la VPC.	hgpostcn-cn-wwo3665tx004-frontend-st
RegionId	string	El ID de la región.	cn-hangzhou
ZoneId	string	El ID de la zona.	cn-hangzhou-h
StorageType	string	El tipo de almacenamiento. Valores válidos: redundant: despliegue en tres zonas. local: despliegue en una sola zona.	redundant
EnableSSL	string	Indica si SSL está habilitado.	true
Success	string	Indica si la llamada a la API se realizó correctamente.	true
ErrorCode	string	El código de error.	null
ErrorMessage	string	El mensaje de error.	null
HttpStatusCode	string	El código de estado HTTP.	200

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "D1303CD4-AA70-5998-8025-F55B22C50840",
  "InstanceList": [
    {
      "CommodityCode": "hologram_postpay_public_cn",
      "CreationTime": "2022-12-16T02:24:05Z",
      "ExpirationTime": "2023-05-04T16:00:00.000Z",
      "InstanceId": "hgpostcn-cn-aaab9ad2d8fb",
      "InstanceName": "test_instance",
      "InstanceStatus": "Running",
      "InstanceType": "Standard",
      "Tags": [
        {
          "Key": "tag",
          "Value": "value"
        }
      ],
      "InstanceChargeType": "PrePaid",
      "LeaderInstanceId": "hgprecn-cn-2r42sqvxm006",
      "SuspendReason": "Manual",
      "EnableHiveAccess": "true",
      "Version": "1.3.37",
      "ResourceGroupId": "rg-acfmvscak73zmby",
      "Endpoints": [
        {
          "Endpoint": "hgpostcn-cn-aaab9ad2d8fb-cn-hangzhou-internal.hologres.aliyuncs.com:80",
          "Type": "Internet",
          "Enabled": true,
          "VSwitchId": "vsw-wz9oap28raidjevhuszg4",
          "VpcId": "vpc-uf6mrahzyu7uorlqqpz5f",
          "VpcInstanceId": "hgpostcn-cn-wwo3665tx004-frontend-st"
        }
      ],
      "RegionId": "cn-hangzhou",
      "ZoneId": "cn-hangzhou-h",
      "StorageType": "redundant",
      "EnableSSL": "true"
    }
  ],
  "Success": "true",
  "ErrorCode": "null",
  "ErrorMessage": "null",
  "HttpStatusCode": "200"
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
403	NoPermission	RAM user permission is insufficient, please grant AliyunHologresReadOnlyAccess permission.

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.