Ambil Database Instans dengan API ListDatabases - Hologres - Alibaba Cloud - Hologres

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:ListDatabases

list

*All Resource

*

None

Sintaks permintaan

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

Path Parameters

Parameter	Type	Required	Description	Example
instanceId	string	No	ID Instans.	hgpostcn-cn-jfj3zckut008

Parameter permintaan

Parameter	Type	Required	Description	Example
external	boolean	No	Apakah akan hanya menampilkan daftar tabel eksternal saja. Nilai valid: true: Hanya tabel eksternal yang ditampilkan. false: Semua tabel ditampilkan. Nilai default: false.	false

Elemen respons

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	0C4935F5-6217-569A-902F-931B2F3E28BA
DatabaseList	array<object>	The list of databases.
	object	The list of databases.
Name	string	The database name.	my_db
PermissionModel	string	The permission model. For more information, see Hologres permission models.	SPM
Privilege	string	The permission.	developer
External	boolean	Indicates whether the table is a foreign table. `true`: The table is a foreign table. `false`: The table is not a foreign table.	false
Success	string	Indicates whether the request was successful.	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": "0C4935F5-6217-569A-902F-931B2F3E28BA",
  "DatabaseList": [
    {
      "Name": "my_db",
      "PermissionModel": "SPM",
      "Privilege": "developer",
      "External": false
    }
  ],
  "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.