Hologres:ListInstances - Hologres - Alibaba Cloud - Hologres

Mengambil daftar 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:ListInstances

list

*Instans.

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

None

Sintaks permintaan

POST /api/v1/instances HTTP/1.1

Parameter permintaan

Parameter	Type	Required	Description	Example
body	object	No	Badan permintaan.
resourceGroupId	string	No	ID kelompok sumber daya.	rg-acfmvscak73zmby
tag	array<object>	No	Tag instans.
	object	No	Detail tag.
key	string	No	Kunci tag.	mytag
value	string	No	Nilai tag.	value
cmsInstanceType	string	No	Tipe instans CloudMonitor. Nilai valid: standard follower mc-acceleration warehouse high-memory arsitektur tanpa server Catatan Ini untuk CloudMonitor.	standard

Elemen respons

Element	Type	Description	Example
	object
RequestId	string	ID permintaan.	D1303CD4-AA70-5998-8025-F55B22C50840
InstanceList	array<object>	Daftar instans.
	array<object>	Detail instans.
CommodityCode	string	Kode komoditas, yang sama dengan kode detail produk di Pusat Pengguna.	hologram_postpay_public_cn
CreationTime	string	Waktu pembuatan. Pengatur waktu dalam UTC dan format ISO 8601.	2022-12-16T02:24:05Z
ExpirationTime	string	Waktu kedaluwarsa. Pengatur waktu dalam UTC dan format ISO 8601.	2023-05-04T16:00:00.000Z
InstanceId	string	ID instans.	hgpostcn-cn-aaab9ad2d8fb
InstanceName	string	Nama instans.	Instans
InstanceStatus	string	Status instans. Valid values: Creating : Sedang dibuat. Running : Berjalan normal. Suspended : Ditangguhkan. Allocating : Sedang diproses.	Running
InstanceType	string	Tipe instans. Valid values: Warehouse : Tipe kelompok komputasi. Follower : Instans pengikut hanya-baca. Standard : Jenis Penyimpanan Standar. Serverless : Tipe arsitektur tanpa server. Shared : Tipe bersama.	Jenis Penyimpanan Standar
Tags	array<object>	Daftar tag.
	object	Detail tag.
Key	string	Kunci tag.	tag
Value	string	Nilai tag.	value
InstanceChargeType	string	Metode penagihan instans. Valid values: PostPaid : Bayar sesuai pemakaian. PrePaid : Berlangganan.	PrePaid
LeaderInstanceId	string	ID instans utama.	hgprecn-cn-2r42sqvxm006
SuspendReason	string	Alasan penangguhan.	Manual
EnableHiveAccess	string	Apakah akselerasi Edisi danau data terpadu diaktifkan. Valid values: true : Diaktifkan. false : Dinonaktifkan.	true
Version	string	Versi instans.	1.3.37
ResourceGroupId	string	ID kelompok sumber daya.	rg-acfmvscak73zmby
Endpoints	array<object>	Daftar titik akhir.
	object	Detail titik akhir.
Endpoint	string	Titik akhir.	hgpostcn-cn-aaab9ad2d8fb-cn-hangzhou-internal.hologres.aliyuncs.com:80
Type	string	Jenis jaringan. Valid values: VPCSingleTunnel : VPC. Intranet : Jaringan internal. VPCAnyTunnel : Tidak lagi didukung untuk instans baru. Internet : Internet.	Internet
Enabled	boolean	Apakah titik akhir diaktifkan. Valid values: true : Diaktifkan. false : Dinonaktifkan.	true
VSwitchId	string	ID vSwitch.	vsw-wz9oap28raidjevhuszg4
VpcId	string	ID VPC.	vpc-uf6mrahzyu7uorlqqpz5f
VpcInstanceId	string	ID instans yang terhubung ke VPC.	hgpostcn-cn-wwo3665tx004-frontend-st
RegionId	string	ID wilayah.	cn-hangzhou
ZoneId	string	ID zona.	cn-hangzhou-h
StorageType	string	Tipe penyimpanan. Nilai valid: redundant: Penerapan tiga zona. local: Penerapan zona tunggal.	redundant
EnableSSL	string	Apakah SSL diaktifkan.	true
Success	string	Apakah pemanggilan API berhasil.	true
ErrorCode	string	Kode kesalahan.	null
ErrorMessage	string	Paket kesalahan.	null
HttpStatusCode	string	Kode status HTTP.	200

Contoh

Respons sukses

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"
        }
      ],
      "RegionId": "cn-hangzhou",
      "ZoneId": "cn-hangzhou-h",
      "StorageType": "redundant",
      "EnableSSL": "true"
    }
  ],
  "Success": "true",
  "ErrorCode": "null",
  "ErrorMessage": "null",
  "HttpStatusCode": "200"
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
403	NoPermission	RAM user permission is insufficient, please grant AliyunHologresReadOnlyAccess permission.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.