全部產品
Search

搜尋本產品

    Hologres：ListInstances - 擷取執行個體列表

    文件中心

    Hologres：ListInstances - 擷取執行個體列表

    更新時間：Mar 03, 2026

    擷取執行個體列表。

    調試

    您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

    調試

    授權資訊

    下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    hologram:ListInstances

    list

    *Instance

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

    		 無 無

    請求文法

    POST /api/v1/instances HTTP/1.1

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    body

    object

    否

    請求體。

    resourceGroupId

    string

    否

    資源群組 ID。

    rg-acfmvscak73zmby
    tag

    array<object>

    否

    執行個體標籤。

    object

    否

    標籤詳情。

    key

    string

    否

    標籤鍵。

    mytag
    value

    string

    否

    標籤值。

    value
    cmsInstanceType

    string

    否

    CloudMonitor執行個體類型。取值：

    • standard

    • follower

    • mc-acceleration

    • warehouse

    • high-memory

    • serverless

    說明

    這是CloudMonitor

    standard

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    RequestId

    string

    請求 ID。

    D1303CD4-AA70-5998-8025-F55B22C50840
    InstanceList

    array<object>

    執行個體列表。

    array<object>

    執行個體詳情。

    CommodityCode

    string

    商品 code，與費用中心產品明細 code 一致

    hologram_postpay_public_cn
    CreationTime

    string

    建立時間。

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

    string

    到期時間。

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

    string

    執行個體 ID。

    hgpostcn-cn-aaab9ad2d8fb
    InstanceName

    string

    執行個體名稱。

    test_instance
    InstanceStatus

    string

    執行個體狀態。

    枚舉值：

    • Creating :

      正在建立

    • Running :

      正常運行

    • Suspended :

      停機

    • Allocating :

      正在處理

    Running
    InstanceType

    string

    執行個體類型。

    枚舉值：

    • Warehouse :

      計算群組型

    • Follower :

      唯讀從執行個體

    • Standard :

      普通型

    • Serverless :

      Serverless 型

    • Shared :

      共用型

    Standard
    Tags

    array<object>

    標籤列表。

    object

    標籤詳情。

    Key

    string

    標籤鍵。

    tag
    Value

    string

    標籤值。

    value
    InstanceChargeType

    string

    執行個體付費類型。

    枚舉值：

    • PostPaid :

      隨用隨付

    • PrePaid :

      訂用帳戶

    PrePaid
    LeaderInstanceId

    string

    主執行個體 ID。

    hgprecn-cn-2r42sqvxm006
    SuspendReason

    string

    暫停原因。

    Manual
    EnableHiveAccess

    string

    是否啟用湖倉加速。

    枚舉值：

    • true :

      開啟

    • false :

      關閉

    true
    Version

    string

    執行個體版本。

    1.3.37
    ResourceGroupId

    string

    資源群組 id。

    rg-acfmvscak73zmby
    Endpoints

    array<object>

    網域名稱列表。

    object

    網域名稱詳情。

    Endpoint

    string

    網域名稱。

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

    string

    網路類型。

    枚舉值：

    • VPCSingleTunnel :

      專用網路

    • Intranet :

      內網

    • VPCAnyTunnel :

      新執行個體不再支援

    • Internet :

      公網

    Internet
    Enabled

    boolean

    是否啟用 Endpoint。

    枚舉值：

    • true :

      開啟

    • false :

      關閉

    true
    VSwitchId

    string

    虛擬交換器 ID。

    vsw-wz9oap28raidjevhuszg4
    VpcId

    string

    VPC ID。

    vpc-uf6mrahzyu7uorlqqpz5f
    VpcInstanceId

    string

    VPC 執行個體 ID。

    hgpostcn-cn-wwo3665tx004-frontend-st
    RegionId

    string

    地區 ID。

    cn-hangzhou
    ZoneId

    string

    可用性區域 ID

    cn-hangzhou-h
    StorageType

    string

    儲存類型：

    • redundant：3AZ

    • local：1AZ

    redundant
    EnableSSL

    string

    是否開啟 SSL。

    true
    Success

    string

    調用介面是否成功。

    true
    ErrorCode

    string

    錯誤碼。

    null
    ErrorMessage

    string

    錯誤資訊。

    null
    HttpStatusCode

    string

    http 狀態代碼。

    200

    樣本

    正常返回樣本

    JSON格式

    {
  "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"
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    403 NoPermission RAM user permission is insufficient, please grant AliyunHologresReadOnlyAccess permission.

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。