DescribeDatabases - ApsaraDB for OceanBase (Deprecated) - Alibaba Cloud Documentation Center

Mengkueri daftar database pada penyewa.

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

oceanbase:DescribeDatabases

get

*全部资源

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
TenantId	string	No	ID penyewa.	t4pnum****
PageNumber	integer	No	Nomor halaman kueri berhalaman. Nilai minimum: 1. Nilai default: 1.	1
PageSize	integer	No	Jumlah baris per halaman kueri berhalaman. Nilai maksimum: 100. Nilai default: 10.	10
DatabaseName	string	No	Nama database. Kata kunci tertentu seperti test dan mysql tidak dapat digunakan.	sms_pre
SearchKey	string	No	Kata kunci filter untuk daftar kueri.	pay
WithTables	boolean	No	Apakah akan mengembalikan informasi tabel dalam database. Nilai default: false. Catatan Jika jumlah tabel terlalu Tingkat Tinggi, operasi mungkin mengalami pengatur waktu.	true
InstanceId	string	No	ID kluster.	ob****n0abo9uo

Elemen respons

Element	Type	Description	Example
	object	Parameter tanggapan.
TotalCount	integer	Jumlah total database dalam penyewa.	1
Databases	array<object>	Daftar database dalam penyewa.
	array<object>	Daftar database dalam penyewa.
Status	string	Status database. Nilai valid: ONLINE: Berjalan. DELETING: Sedang dihapus.	ONLINE
Description	string	Deskripsi database.	test db
Encoding	string	Enkoding database. Enkoding yang didukung meliputi utf8mb4 dan gbk.	utf8mb4
DbType	string	Tipe database.	mysql
DatabaseName	string	Nama database.	sms_pre
CreateTime	string	Pengatur waktu pembuatan.	2022-02-21 15:41:06
Users	array<object>	Daftar akun yang telah diberikan izin pada database.
	object	Daftar akun yang telah diberikan izin pada database.
UserType	string	The type of the account. Valid values: Admin: the super administrator account. Normal: a general account.	Normal
Role	string	The role of the account. In MySQL mode, a role is a database-level role. Valid values: ReadWrite: a role that has the read and write privileges, namely ALL PRIVILEGES. ReadOnly: a role that has only the read-only privilege SELECT. DDL: a role that has the DDL privileges such as CREATE, DROP, ALTER, SHOW VIEW, and CREATE VIEW. DML: a role that has the DML privileges such as SELECT, INSERT, UPDATE, DELETE, and SHOW VIEW.	ReadOnly
UserName	string	The name of the account.	user_pay_ro
Privileges	string	If you have granted custom privileges on the database, this parameter indicates the custom privileges, separated by commas (,). Otherwise, no data is returned for this parameter.	select,delete,update
TenantId	string	ID penyewa.	t4pnum****
Tables	array<object>	Daftar tabel dalam database.
	object	Daftar tabel dalam database.
TableName	string	The name of the database table.	testTables
RequiredSize	number	Kapasitas yang diperlukan. Unit: GB.	5.67 GB
DataSize	number	Ukuran data aktual. Unit: GB. Penting Bidang ini tidak lagi dikembalikan oleh backend. Gunakan RequiredSize sebagai gantinya. .	5.67 GB
Collation	string	Aturan pengurutan.	utf8mb4_general_ci
InstanceId	string	ID kluster tempat database berada.	obsdh2f****
TenantName	string	Nama penyewa.	tenantABC
RequestId	string	ID permintaan.	EE205C00-30E4-**-**-87E3A8A2AA0C

Contoh

Respons sukses

JSONformat

{
  "TotalCount": 1,
  "Databases": [
    {
      "Status": "ONLINE",
      "Description": "test db",
      "Encoding": "utf8mb4",
      "DbType": "mysql",
      "DatabaseName": "sms_pre",
      "CreateTime": "2022-02-21 15:41:06",
      "Users": [
        {
          "UserType": "Normal",
          "Role": "ReadOnly",
          "UserName": "user_pay_ro",
          "Privileges": "select,delete,update"
        }
      ],
      "TenantId": "t4pnum****",
      "Tables": [
        {
          "TableName": "testTables"
        }
      ],
      "RequiredSize": 0,
      "DataSize": 0,
      "Collation": "utf8mb4_general_ci",
      "InstanceId": "obsdh2f****",
      "TenantName": "tenantABC"
    }
  ],
  "RequestId": "EE205C00-30E4-****-****-87E3A8A2AA0C"
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.