All Products
Search

This Product

    Hologres:GetInstance

    Document Center

    Hologres:GetInstance

    Last Updated:Jun 10, 2026

    Mengambil detail instans.

    Coba sekarang

    Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

    Test

    RAM authorization

    Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

    • Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.

    • API: API yang dapat Anda panggil untuk melakukan aksi tersebut.

    • Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.

    • Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.

      • Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.

      • Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.

    • Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.

    • Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    hologram:GetInstance

    get

    *Instance

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

    		 None None

    Sintaks permintaan

    GET /api/v1/instances/{instanceId} HTTP/1.1

    Path Parameters

    Parameter

    Type

    Required

    Description

    Example
    instanceId

    string

    No

    ID instans. Wajib diisi.

    hgprecn-cn-i7m2v08uu00a

    Parameter permintaan

    Parameter

    Type

    Required

    Description

    Example

    Tidak ada parameter yang diperlukan.

    Elemen respons

    Element

    Type

    Description

    Example

    object

    The response parameters.

    RequestId

    string

    The request ID.

    865A02C2-B374-5DD4-9B34-0CA15DA1AEBD
    Instance

    object

    The instance details.

    InstanceChargeType

    string

    The billing method of the instance.

    Valid values:

    • PostPaid :

      Pay-as-you-go

    • PrePaid :

      Subscription

    PrePaid
    CommodityCode

    string

    The commodity code.

    Valid values:

    • hologram_maxcomputeAccelerate_public_cn :

      A shared cluster sold on the China site.

    • hologram_combo_public_cn :

      A subscription instance on the China site.

    • hologram_prepay_public_intl :

      A subscription instance sold on the International site.

    • hologram_storage_dp_cn :

      A storage plan sold on the China site.

    • hologram_postpay_public_cn :

      A pay-as-you-go instance sold on the China site.

    • hologram_postpay_public_intl :

      A pay-as-you-go instance sold on the International site.

    • hologram_maxcomputeAccelerate_public_intl :

      A shared cluster sold on the International site.

    • hologram_cu_dp_cn :

      A compute plan sold on the China site.

    hologram_combo_public_cn
    Cpu

    integer

    The number of vCPUs.

    32
    CreationTime

    string

    The creation time.

    2021-02-03T13:06:06Z
    Disk

    string

    The size of the standard storage. Unit: GB.

    500
    Endpoints

    array<object>

    The list of endpoints.

    object

    The endpoint details.

    Endpoint

    string

    The endpoint.

    hgprecn-cn-uqm362o1b001-cn-hangzhou-internal.hologres.aliyuncs.com:80
    Type

    string

    The network type.

    Valid values:

    • VPCSingleTunnel :

      VPC

    • Intranet :

      Internal network

    • VPCAnyTunnel :

      (Not supported for new instances)

    • Internet :

      Public network

    Internet
    Enabled

    boolean

    Indicates whether the network is enabled.

    Valid values:

    • true :

      The network is enabled.

    • false :

      The network is disabled.

    true
    VSwitchId

    string

    The vSwitch ID.

    vsw-bp1jqwp2ys6kp7tc9t983
    VpcId

    string

    The VPC ID.

    vpc-uf66jjber3hgvwhki3wna
    VpcInstanceId

    string

    The VPC instance ID.

    hgprecn-cn-uqm362o1b001-frontend-st
    AlternativeEndpoints

    string

    Some earlier instances have both AnyTunnel and SingleTunnel enabled. When you switch from AnyTunnel to SingleTunnel, the endpoints for both are retained. This field is used to store the extra endpoint.

    hgprecn-cn-uqm362o1b001-cn-hangzhou-internal.hologres.aliyuncs.com:80
    ExpirationTime

    string

    The expiration time. Pay-as-you-go instances do not expire.

    2021-02-03T13:06:06Z
    InstanceId

    string

    The instance ID.

    hgpostcn-cn-tl32s6cgw00b
    InstanceName

    string

    The name of the instance. The name must be 2 to 64 characters in length. Each letter or Chinese character is counted as a single character.

    test
    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 cluster

    Standard
    Memory

    integer

    The memory size. Unit: GB.

    128
    InstanceOwner

    string

    The instance owner.

    12345678900000
    InstanceStatus

    string

    The instance status.

    Valid values:

    • Creating :

      The instance is being created.

    • Running :

      The instance is running.

    • Suspended :

      The instance is stopped.

    • Allocating :

      The instance is allocating resources.

    Running
    Version

    string

    The instance version.

    r1.3.37
    SuspendReason

    string

    The reason why the instance was stopped.

    Valid values:

    • Indebet :

      The payment is overdue.

    • Manual :

      The instance was manually stopped.

    • Overdue :

      The subscription has expired.

    Manual
    Tags

    array<object>

    The tags of the instance.

    object

    The tag details.

    Key

    string

    The tag key.

    tag
    Value

    string

    The tag value.

    value
    LeaderInstanceId

    string

    The ID of the primary instance.

    hgpostcn-cn-i7m2ncd6w002
    EnableHiveAccess

    string

    Indicates whether data lake acceleration is enabled.

    true
    ResourceGroupId

    string

    The ID of the resource group.

    rg-aekzuq7hpybze2i
    ComputeNodeCount

    integer

    The number of compute nodes. A node has 16 vCPUs and 32 GB of memory.

    2
    ZoneId

    string

    The zone ID.

    cn-hangzhou-h
    ColdStorage

    integer

    The cold storage capacity. Unit: GB. SSD is hot storage, which is also standard storage. HDD is cold storage.

    800
    AutoRenewal

    string

    Indicates whether auto-renewal is enabled.

    Valid values:

    • true :

      Auto-renewal is enabled.

    • false :

      Auto-renewal is disabled.

    true
    GatewayCount

    integer

    The number of gateway nodes.

    2
    GatewayCpu

    integer

    The vCPU resources of the gateway. Unit: cores.

    4
    GatewayMemory

    integer

    The memory resources of the gateway. Unit: GB.

    16
    RegionId

    string

    The region ID.

    cn-hangzhou
    ReplicaRole

    string

    The role of instance in disaster recovery. Active: the primary instance. Passive: the secondary instance. PreActive: a primary instance that has not reached the desired state.

    Active
    EnableServerless

    boolean

    Indicates whether Serverless Computing is enabled.

    Valid values:

    • true :

      Serverless Computing is enabled.

    • false :

      Serverless Computing is disabled.

    true
    StorageType

    string

    The storage class:

    • redundant: Zone-redundant storage

    • local: Locally redundant storage

    redundant
    EnableSSL

    boolean

    Indicates whether SSL is enabled.

    true
    Success

    boolean

    The result of the request, which indicates whether an exception occurred. This parameter is not related to the business logic.

    true
    ErrorCode

    string

    The error code.

    null
    ErrorMessage

    string

    The error message.

    null
    HttpStatusCode

    string

    The HTTP status code.

    200

    Contoh

    Respons sukses

    JSONformat

    {
  "RequestId": "865A02C2-B374-5DD4-9B34-0CA15DA1AEBD",
  "Instance": {
    "InstanceChargeType": "PrePaid",
    "CommodityCode": "hologram_combo_public_cn",
    "Cpu": 32,
    "CreationTime": "2021-02-03T13:06:06Z",
    "Disk": "500",
    "Endpoints": [
      {
        "Endpoint": "hgprecn-cn-uqm362o1b001-cn-hangzhou-internal.hologres.aliyuncs.com:80",
        "Type": "Internet",
        "Enabled": true,
        "VSwitchId": "vsw-bp1jqwp2ys6kp7tc9t983",
        "VpcId": "vpc-uf66jjber3hgvwhki3wna",
        "VpcInstanceId": "hgprecn-cn-uqm362o1b001-frontend-st",
        "AlternativeEndpoints": "hgprecn-cn-uqm362o1b001-cn-hangzhou-internal.hologres.aliyuncs.com:80"
      }
    ],
    "ExpirationTime": "2021-02-03T13:06:06Z",
    "InstanceId": "hgpostcn-cn-tl32s6cgw00b",
    "InstanceName": "test",
    "InstanceType": "Standard",
    "Memory": 128,
    "InstanceOwner": "12345678900000",
    "InstanceStatus": "Running",
    "Version": "r1.3.37",
    "SuspendReason": "Manual",
    "Tags": [
      {
        "Key": "tag",
        "Value": "value"
      }
    ],
    "LeaderInstanceId": "hgpostcn-cn-i7m2ncd6w002",
    "EnableHiveAccess": "true",
    "ResourceGroupId": "rg-aekzuq7hpybze2i",
    "ComputeNodeCount": 2,
    "ZoneId": "cn-hangzhou-h",
    "ColdStorage": 800,
    "AutoRenewal": "true",
    "GatewayCount": 2,
    "GatewayCpu": 4,
    "GatewayMemory": 16,
    "RegionId": "cn-hangzhou",
    "ReplicaRole": "Active",
    "EnableServerless": true,
    "StorageType": "redundant",
    "EnableSSL": true
  },
  "Success": true,
  "ErrorCode": "null",
  "ErrorMessage": "null",
  "HttpStatusCode": "200"
}

    Kode kesalahan

    Lihat Error Codes untuk daftar lengkap.

    Catatan rilis

    Lihat Release Notes untuk daftar lengkap.