DescribeTenantEncryption - ApsaraDB for OceanBase (Deprecated)

Mengkueri informasi enkripsi 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:DescribeTenantEncryption

get

*全部资源

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	ID Kluster OceanBase.	ob317v4uif****
TenantId	string	No	ID penyewa.	t4louaeei****
TenantName	string	No	Nama penyewa. Panjang nama harus 2 hingga 20 karakter dan dapat berisi huruf, angka, dan garis bawah (). Nama bersifat case-sensitive dan harus diawali dengan huruf atau garis bawah (). Nama tidak dapat diatur ke sys.	forMySQLTenant
PageNumber	integer	No	Nomor halaman untuk kueri berhalaman. - Nilai minimum: 1. - Nilai default: 1.	1
PageSize	integer	No	Jumlah entri per halaman. Nilai default: 10.	10

Elemen respons

Element	Type	Description	Example
	object	Parameter tanggapan.
RequestId	string	ID permintaan.	EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C
TotalCount	integer	Jumlah total entri. Parameter ini berlaku pada kueri berhalaman dengan paging diaktifkan.	8
TenantEncryptions	array<object>	Informasi mengenai daftar skenario yang mendukung enkripsi.
	object	Daftar skenario yang mendukung enkripsi.
TenantId	string	ID penyewa.	t4louaeei****
TenantMode	string	Mode penyewa. Nilai valid: Oracle: Mode Oracle. MySQL: Mode MySQL.	MySQL
TenantName	string	Nama penyewa.	forMySQLTenant
EnableEncryption	boolean	Apakah enkripsi diaktifkan. Nilai valid: true false.	false
TenantStatus	string	Status penyewa.	ONLINE
Status	string	Status yang menunjukkan apakah enkripsi diaktifkan untuk penyewa.	OPEN
EncryptionType	string	Tipe enkripsi.	INTERNAL
EncryptionKeyId	string	ID kunci yang digunakan untuk enkripsi KMS.	xxx

Contoh

Respons sukses

JSONformat

{
  "RequestId": "EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C",
  "TotalCount": 8,
  "TenantEncryptions": [
    {
      "TenantId": "t4louaeei****",
      "TenantMode": "MySQL",
      "TenantName": "forMySQLTenant",
      "EnableEncryption": false,
      "TenantStatus": "ONLINE",
      "Status": "OPEN",
      "EncryptionType": "INTERNAL",
      "EncryptionKeyId": "xxx"
    }
  ]
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
500	InternalError	The request processing has failed due to some unknown error.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.