GetInstance - Hologres

Mengambil detail instance.

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

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
RequestId	string	ID permintaan.	865A02C2-B374-5DD4-9B34-0CA15DA1AEBD
Instance	object	Detail instans.
InstanceChargeType	string	Metode penagihan instans. Valid values: PostPaid : Pay-as-you-go PrePaid : Subscription	PrePaid
CommodityCode	string	Kode komoditas. Valid values: hologram_maxcomputeAccelerate_public_cn : Kluster bersama yang dijual di situs Tiongkok. hologram_combo_public_cn : Instans langganan di situs Tiongkok. hologram_prepay_public_intl : Instans langganan yang dijual di situs Internasional. hologram_storage_dp_cn : Paket penyimpanan yang dijual di situs Tiongkok. hologram_postpay_public_cn : Instans berbayar sesuai penggunaan yang dijual di situs Tiongkok. hologram_postpay_public_intl : Instans berbayar sesuai penggunaan yang dijual di situs Internasional. hologram_maxcomputeAccelerate_public_intl : Kluster bersama yang dijual di situs Internasional. hologram_cu_dp_cn : Paket komputasi yang dijual di situs Tiongkok.	hologram_combo_public_cn
Cpu	integer	Jumlah vCPU.	32
CreationTime	string	Waktu pembuatan.	2021-02-03T13:06:06Z
Disk	string	Ukuran penyimpanan standar. Satuan: GB.	500
Endpoints	array<object>	Daftar titik akhir.
	object	Detail titik akhir.
Endpoint	string	Titik akhir.	hgprecn-cn-uqm362o1b001-cn-hangzhou-internal.hologres.aliyuncs.com:80
Type	string	Jenis jaringan. Valid values: VPCSingleTunnel : VPC Intranet : Jaringan internal VPCAnyTunnel : (Tidak didukung untuk instans baru) Internet : Jaringan publik	Internet
Enabled	boolean	Menunjukkan apakah jaringan diaktifkan. Valid values: true : Jaringan diaktifkan. false : Jaringan dinonaktifkan.	true
VSwitchId	string	ID vSwitch.	vsw-bp1jqwp2ys6kp7tc9t983
VpcId	string	ID VPC.	vpc-uf66jjber3hgvwhki3wna
VpcInstanceId	string	ID instans VPC.	hgprecn-cn-uqm362o1b001-frontend-st
AlternativeEndpoints	string	Beberapa instans lama memiliki AnyTunnel dan SingleTunnel yang diaktifkan secara bersamaan. Saat Anda beralih dari AnyTunnel ke SingleTunnel, titik akhir keduanya tetap dipertahankan. Bidang ini digunakan untuk menyimpan titik akhir tambahan tersebut.	hgprecn-cn-uqm362o1b001-cn-hangzhou-internal.hologres.aliyuncs.com:80
ExpirationTime	string	Waktu kedaluwarsa. Instans pay-as-you-go tidak memiliki masa kedaluwarsa.	2021-02-03T13:06:06Z
InstanceId	string	ID instans.	hgpostcn-cn-tl32s6cgw00b
InstanceName	string	Nama instans.	test
InstanceType	string	Tipe instans. Valid values: Warehouse : Instans gudang virtual Follower : Instans secondary read-only Standard : Instans tujuan umum Serverless : Instans serverless Shared : Kluster bersama	Standard
Memory	integer	Ukuran memori. Satuan: GB.	128
InstanceOwner	string	Pemilik instans.	12345678900000
InstanceStatus	string	Status instans. Valid values: Creating : Instans sedang dibuat. Running : Instans sedang berjalan. Suspended : Instans dihentikan. Allocating : Instans sedang mengalokasikan resource.	Running
Version	string	Versi instans.	r1.3.37
SuspendReason	string	Alasan instans dihentikan. Valid values: Indebet : Pembayaran terlambat. Manual : Instans dihentikan secara manual. Overdue : Langganan telah kedaluwarsa.	Manual
Tags	array<object>	Tag instans.
	object	Detail tag.
Key	string	Kunci tag.	tag
Value	string	Nilai tag.	value
LeaderInstanceId	string	ID instans utama.	hgpostcn-cn-i7m2ncd6w002
EnableHiveAccess	string	Menunjukkan apakah akselerasi data lake diaktifkan.	true
ResourceGroupId	string	ID kelompok sumber daya.	rg-aekzuq7hpybze2i
ComputeNodeCount	integer	Jumlah node komputasi. Satu node memiliki 16 vCPU dan memori 32 GB.	2
ZoneId	string	ID zona.	cn-hangzhou-h
ColdStorage	integer	Kapasitas penyimpanan dingin. Satuan: GB. SSD adalah penyimpanan panas, yang juga merupakan penyimpanan standar. HDD adalah penyimpanan dingin.	800
AutoRenewal	string	Menunjukkan apakah perpanjangan otomatis diaktifkan. Valid values: true : Perpanjangan otomatis diaktifkan. false : Perpanjangan otomatis dinonaktifkan.	true
GatewayCount	integer	Jumlah node gerbang.	2
GatewayCpu	integer	Resource vCPU gerbang. Satuan: core.	4
GatewayMemory	integer	Resource memori gerbang. Satuan: GB.	16
RegionId	string	ID wilayah.	cn-hangzhou
ReplicaRole	string	Peran instans dalam pemulihan bencana. `Active`: instans utama. `Passive`: instans secondary. `PreActive`: instans utama yang belum mencapai status yang diinginkan.	Active
EnableServerless	boolean	Menunjukkan apakah Serverless Computing diaktifkan. Valid values: true : Serverless Computing diaktifkan. false : Serverless Computing dinonaktifkan.	true
StorageType	string	Kelas penyimpanan: redundant: Penyimpanan redundan antar-zona local: Penyimpanan redundan lokal	redundant
EnableSSL	boolean
Success	boolean	Hasil permintaan, yang menunjukkan apakah terjadi pengecualian. Parameter ini tidak terkait dengan logika bisnis.	true
ErrorCode	string	Kode kesalahan.	null
ErrorMessage	string	Pesan kesalahan.	null
HttpStatusCode	string	Kode status HTTP.	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": false
  },
  "Success": true,
  "ErrorCode": "null",
  "ErrorMessage": "null",
  "HttpStatusCode": "200"
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.