All Products
Search
Document Center

Hologres:ListInstances

Last Updated:Mar 03, 2024

Queries a list of instances.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
hologram:ListInstancesList
  • Instance
    acs:hologram:*:{#accountId}:instance/*
    none
none

Request syntax

POST /api/v1/instances

Request parameters

ParameterTypeRequiredDescriptionExample
bodyobjectNo

The request body.

resourceGroupIdstringNo

The ID of the resource group.

rg-acfmvscak73zmby
tagobject []No

The tags to add to the resource.

keystringNo

The tag key.

mytag
valuestringNo

The tag value.

value

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

D1303CD4-AA70-5998-8025-F55B22C50840
InstanceListobject []

The list of queried instances.

CommodityCodestring

The commodity code, which is the same as that on the Billing Management page.

hologram_postpay_public_cn
CreationTimestring

The time when the cluster was created.

2022-12-16T02:24:05Z
ExpirationTimestring

The time when the cluster expires.

2023-05-04T16:00:00.000Z
InstanceIdstring

The instance ID.

hgpostcn-cn-aaab9ad2d8fb
InstanceNamestring

The name of the instance.

test_instance
InstanceStatusstring

The status of the instance.

Valid values:

  • Creating

  • Running

  • Suspended

  • Allocating

Running
InstanceTypestring

The type of the instance.

Valid values:

  • Follower

    :

    read-only secondary instance

    .

  • Standard

    :

    normal instance

    .

Standard
Tagsobject []

The tags that are added to the resource.

Keystring

The tag key.

tag
Valuestring

The tag value.

value
InstanceChargeTypestring

The billing method of the instance. Valid values:

Valid values:

  • PostPaid

    :

    pay-as-you-go

    .

  • PrePaid

    :

    subscription

    .

PrePaid
LeaderInstanceIdstring

The ID of the primary instance.

hgprecn-cn-2r42sqvxm006
SuspendReasonstring

The reason for the suspension.

Manual
EnableHiveAccessstring

Indicates whether lakehouse acceleration is enabled.

Valid values:

  • true

  • false

true
Versionstring

The version of the cluster.

1.3.37
ResourceGroupIdstring

The ID of the resource group.

rg-acfmvscak73zmby
Endpointsobject []

The list of endpoints.

Endpointstring

The endpoint.

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

The network type.

Valid values:

  • VPCSingleTunnel

    :

    virtual private cloud (VPC)

    .

  • Intranet

    :

    internal network

  • VPCAnyTunnel

    : This value is not supported by new instances

    .

  • Internet

    :

    Internet

    .

Internet
Enabledboolean

Indicates whether the endpoint is enabled.

Valid values:

  • true

  • false

true
VSwitchIdstring

The vSwitch ID.

vsw-wz9oap28raidjevhuszg4
VpcIdstring

The VPC ID.

vpc-uf6mrahzyu7uorlqqpz5f
VpcInstanceIdstring

The ID of the VPC to which the instance belongs.

hgpostcn-cn-wwo3665tx004-frontend-st
Successstring

Indicates whether the request was successful.

true
ErrorCodestring

The error code returned if the request failed.

404
ErrorMessagestring

The error message returned if the request failed.

Internal server error.
HttpStatusCodestring

The HTTP status code.

200

Examples

Sample success responses

JSONformat

{
  "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"
        }
      ]
    }
  ],
  "Success": "true",
  "ErrorCode": "404",
  "ErrorMessage": "Internal server error.",
  "HttpStatusCode": "200"
}

Error codes

HTTP status codeError codeError message
403NoPermissionRAM user permission is insufficient, please grant AliyunHologresReadOnlyAccess permission.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-07-19The Error code has changed. The response structure of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 403
Output ParametersThe response structure of the API has changed.
2023-06-20The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 403
2023-05-16The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Error Codes 403 change
2023-04-26The Error code has changed. The request parameters of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 403
Input ParametersThe request parameters of the API has changed.
    delete Input Parameters: RegionId