Ambil Database Instans melalui API DMS ListDatabases - Data Management - Alibaba Cloud - Data Management

Mengkueri detail database dalam instans dengan memanggil ListDatabases.

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

dms:ListDatabases

list

*全部资源

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
Tid	integer	No	ID penyewa. Catatan Anda dapat mencari ID penyewa dengan mengarahkan kursor ke ikon profil di pojok kanan atas Konsol. Untuk informasi lebih lanjut, lihat Lihat informasi penyewa.	3***
InstanceId	string	Yes	ID instans. Anda dapat memperoleh nilai ini dari informasi instans yang dikembalikan oleh operasi ListInstances. Ini bukan ID instans RDS.	12***
PageNumber	integer	No	Nomor halaman.	1
PageSize	integer	No	Jumlah entri per halaman.	10
SearchKey	string	No

Elemen respons

Element	Type	Description	Example
	object
TotalCount	integer	Jumlah total database dalam instans.	1
RequestId	string	ID permintaan.	5541CDA6-F674-435C-81BD-40C2FB926CE3
DatabaseList	object
Database	array<object>	Daftar detail database.
	array<object>
DatabaseId	string	The ID of the database.	1
Host	string	The endpoint of the instance to which the database belongs.	xxx.xxx.xxx.xxx
CatalogName	string	The name of the catalog to which the database belongs.	1
DbaName	string	The nickname of the Database administrator (DBA) to which the database belongs.	dba_user
State	string	The state of the database. Valid values: NORMAL: The database is normal. DISABLE: The database is disabled. OFFLINE: The database is unpublished. NOT_EXIST: The database does not exist.	NORMAL
DbaId	string	The ID of the DBA.	1
SchemaName	string	The name of the database.	test
InstanceId	string	The ID of the instance to which the database belongs.	1
Port	integer	The connection port of the instance to which the database belongs.	3306
EnvType	string	The type of the environment to which the database belongs.	dev
Sid	string	The system ID (SID) of the instance to which the database belongs.	test
OwnerIdList	object
OwnerIds	array	The IDs of the owners of the database.
	string	The ID of the owner of the database.	1
Encoding	string	The encoding format of the database.	utf-8
DbType	string	The type of the database engine.	mysql
OwnerNameList	object
OwnerNames	array	The nicknames of the database owners.
	string	The nickname of the database owner.	owner_name
SearchName	string	The name that is used for searching the database.	test@xxx.xxx.xxx.xxx:3306
ErrorCode	string	Kode kesalahan.	UnknownError
ErrorMessage	string	Paket kesalahan.	UnknownError
Success	boolean	Apakah permintaan berhasil.	true

Contoh

Respons sukses

JSONformat

{
  "TotalCount": 1,
  "RequestId": "5541CDA6-F674-435C-81BD-40C2FB926CE3",
  "DatabaseList": {
    "Database": [
      {
        "DatabaseId": "1",
        "Host": "xxx.xxx.xxx.xxx",
        "CatalogName": "1",
        "DbaName": "dba_user",
        "State": "NORMAL",
        "DbaId": "1",
        "SchemaName": "test",
        "InstanceId": "1",
        "Port": 3306,
        "EnvType": "dev",
        "Sid": "test",
        "OwnerIdList": {
          "OwnerIds": [
            "1"
          ]
        },
        "Encoding": "utf-8",
        "DbType": "mysql",
        "OwnerNameList": {
          "OwnerNames": [
            "owner_name"
          ]
        },
        "SearchName": "test@xxx.xxx.xxx.xxx:3306"
      }
    ]
  },
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.