All Products
Search

This Product

    Hologres:ListInstances

    Document Center

    Hologres:ListInstances

    Last Updated:Nov 27, 2025

    Retrieves a list of instances.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    hologram:ListInstances

    list

    *Instance

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

    None

    None

    Request syntax

    POST /api/v1/instances HTTP/1.1

    Request parameters

    Parameter

    Type

    Required

    Description

    Example

    body

    object

    No

    The request body.

    resourceGroupId

    string

    No

    The resource group ID.

    rg-acfmvscak73zmby

    tag

    array<object>

    No

    The instance tags.

    object

    No

    The tag details.

    key

    string

    No

    The tag key.

    mytag

    value

    string

    No

    The tag value.

    value

    cmsInstanceType

    string

    No

    The instance type. Valid values:

    • standard

    • follower

    • mc-acceleration

    • warehouse

    • high-memory

    • serverless

    Note

    This parameter is used for Cloud Monitor.

    standard

    Response elements

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    The request ID.

    D1303CD4-AA70-5998-8025-F55B22C50840

    InstanceList

    array<object>

    The list of instances.

    array<object>

    The details of the instance.

    CommodityCode

    string

    The commodity code

    hologram_postpay_public_cn

    CreationTime

    string

    The instance creation time.

    2022-12-16T02:24:05Z

    ExpirationTime

    string

    The instance expiration time.

    2023-05-04T16:00:00.000Z

    InstanceId

    string

    The instance ID.

    hgpostcn-cn-aaab9ad2d8fb

    InstanceName

    string

    The instance name.

    test_instance

    InstanceStatus

    string

    The instance status.

    Valid values:

    • Creating :

      The instance is being created.

    • Running :

      The instance is running.

    • Suspended :

      The instance is suspended.

    • Allocating :

      The instance is being allocated.

    Running

    InstanceType

    string

    The instance type.

    Valid values:

    • Warehouse :

      Virtual warehouse instance

    • Follower :

      Read-only secondary instance

    • Standard :

      General-purpose instance

    • Serverless :

      Serverless instance

    • Shared :

      Shared

    Standard

    Tags

    array<object>

    The tags.

    object

    The tag details.

    Key

    string

    The tag key.

    tag

    Value

    string

    The tag value.

    value

    InstanceChargeType

    string

    The billing method of the instance.

    Valid values:

    • PostPaid :

      Pay-as-you-go

    • PrePaid :

      Subscription

    PrePaid

    LeaderInstanceId

    string

    The ID of the primary instance.

    hgprecn-cn-2r42sqvxm006

    SuspendReason

    string

    The reason why the instance was suspended.

    Manual

    EnableHiveAccess

    string

    Indicates whether lakehouse acceleration is enabled.

    Valid values:

    • true :

      Lakehouse acceleration is enabled.

    • false :

      Lakehouse acceleration is disabled.

    true

    Version

    string

    The instance version.

    1.3.37

    ResourceGroupId

    string

    The resource group ID.

    rg-acfmvscak73zmby

    Endpoints

    array<object>

    The endpoints.

    object

    The endpoint details.

    Endpoint

    string

    The endpoint.

    hgpostcn-cn-aaab9ad2d8fb-cn-hangzhou-internal.hologres.aliyuncs.com:80

    Type

    string

    The network type.

    Valid values:

    • VPCSingleTunnel :

      VPC

    • Intranet :

      Internal network

    • VPCAnyTunnel :

      No longer supported for new instances

    • Internet :

      Internet

    Internet

    Enabled

    boolean

    Indicates whether the endpoint is enabled.

    Valid values:

    • true :

      The endpoint is enabled.

    • false :

      The endpoint is disabled.

    true

    VSwitchId

    string

    The vSwitch ID.

    vsw-wz9oap28raidjevhuszg4

    VpcId

    string

    The VPC ID.

    vpc-uf6mrahzyu7uorlqqpz5f

    VpcInstanceId

    string

    The VPC instance ID.

    hgpostcn-cn-wwo3665tx004-frontend-st

    RegionId

    string

    The region ID.

    cn-hangzhou

    ZoneId

    string

    The zone ID.

    cn-hangzhou-h

    StorageType

    string

    The storage class.

    • redundant: Zone-redundant storage

    • local: Locally redundant storage

    redundant

    EnableSSL

    string

    Success

    string

    Indicates whether the call was successful.

    true

    ErrorCode

    string

    The error code.

    null

    ErrorMessage

    string

    The error message.

    null

    HttpStatusCode

    string

    The HTTP status code.

    200

    Examples

    Success response

    JSON format

    {
  "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": ""
    }
  ],
  "Success": "true",
  "ErrorCode": "null",
  "ErrorMessage": "null",
  "HttpStatusCode": "200"
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description

    403

    NoPermission

    RAM user permission is insufficient, please grant AliyunHologresReadOnlyAccess permission.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.