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

Mengkueri informasi daftar penyewa pada Kluster OceanBase tertentu.

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

get

*全部资源

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	ID Kluster OceanBase.	ob317v4uif****
TenantName	string	No	Nama penyewa. Nama harus terdiri dari 2 hingga 20 karakter, dan dapat berisi huruf, angka, dan garis bawah (). Nama bersifat case-sensitive dan harus diawali dengan huruf atau garis bawah (). Tidak dapat diatur ke sys.	pay_online
PageSize	integer	No	Jumlah baris per halaman untuk kueri terpaginasi. Nilai maksimum: 100 Nilai default: 10.	10
PageNumber	integer	No	Nomor halaman untuk kueri terpaginasi. Nilai awal: 1. Nilai default: 1.	1
TenantId	string	No	ID penyewa.	ob2mr3oae0****
SearchKey	string	No	Kata kunci filter untuk mengkueri daftar.	pay

Elemen respons

Element	Type	Description	Example
	object	Hasil tanggapan dari permintaan.
TotalCount	integer	Jumlah total penyewa pada Kluster OceanBase yang ditentukan.	1
RequestId	string	ID permintaan.	EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C
Tenants	array<object>	Daftar informasi penyewa.
	object	Daftar informasi penyewa.
VpcId	string	ID virtual private cloud (VPC). Jika tidak ada VPC yang sesuai tersedia, buat VPC dengan mengikuti petunjuk di layar. Untuk informasi lebih lanjut, lihat Apa itu VPC.	vpc-bp1d2q3mhg9i23ofi****
Status	string	Status penyewa. PENDING_CREATE: sedang dibuat. RESTORE: sedang memulihkan. ONLINE: Berjalan. SPEC_MODIFYING: spesifikasi sedang diubah. ALLOCATING_INTERNET_ADDRESS: alamat IP publik sedang dialokasikan. PENDING_OFFLINE_INTERNET_ADDRESS: alamat IP publik sedang dinonaktifkan. PRIMARY_ZONE_MODIFYING: zona utama sedang dialihkan. PARAMETER_MODIFYING: parameter sedang diubah. WHITE_LIST_MODIFYING: daftar putih sedang diubah.	ONLINE
PrimaryZone	string	Zona utama penyewa.	cn-hangzhou-i
DeployType	string	Tipe penerapan penyewa. multiple: multi-IDC. single: single-IDC. dual: dual-IDC.	multiple
DeployMode	string	Mode replika data penyewa. Untuk Edisi Ketersediaan tinggi: mode adalah N-N-N untuk tiga zona, dan N-N untuk dua zona dan zona tunggal. Untuk Edisi Dasar: mode adalah N. Catatan N adalah jumlah node dalam satu zona.	1-1-1
CreateTime	string	Pengatur waktu pembuatan penyewa.	2021-09-17 15:52:17.0
TenantName	string	Nama penyewa.	pay_online
Mem	integer	Ukuran memori total penyewa. Unit: GB.	20
Cpu	integer	Jumlah total core CPU penyewa. Unit: core.	10
Description	string	Deskripsi penyewa.	paycore database
TenantMode	string	Mode penyewa. Mode yang saat ini didukung: Oracle: mode Oracle. MySQL: mode MySQL.	Oracle
TenantId	string	ID penyewa.	t33h8y08k****
UnitCpu	integer	Jumlah core CPU per unit penyewa. Unit: core.	5
UnitMem	integer	Ukuran memori per unit penyewa. Unit: GB.	10
UnitNum	integer	Jumlah unit penyewa.	2
UsedDiskSize	number	Ukuran disk yang digunakan penyewa.	10
Charset	string	Set karakter.	utf8mb4
Collation	string	Aturan pengurutan.	utf8mb4_general_ci
EnableReadOnlyReplica	boolean
ParameterTemplate	string	Template parameter.	express_oltp
Iops	integer		10000

Contoh

Respons sukses

JSONformat

{
  "TotalCount": 1,
  "RequestId": "EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C",
  "Tenants": [
    {
      "VpcId": "vpc-bp1d2q3mhg9i23ofi****",
      "Status": "ONLINE",
      "PrimaryZone": "cn-hangzhou-i",
      "DeployType": "multiple",
      "DeployMode": "1-1-1",
      "CreateTime": "2021-09-17 15:52:17.0",
      "TenantName": "pay_online",
      "Mem": 20,
      "Cpu": 10,
      "Description": "paycore database",
      "TenantMode": "Oracle",
      "TenantId": "t33h8y08k****",
      "UnitCpu": 5,
      "UnitMem": 10,
      "UnitNum": 2,
      "UsedDiskSize": 10,
      "Charset": "utf8mb4",
      "Collation": "utf8mb4_general_ci",
      "EnableReadOnlyReplica": true,
      "ParameterTemplate": "express_oltp",
      "Iops": 10000
    }
  ]
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.