DescribeRestorableTenants - ApsaraDB for OceanBase (Deprecated)

Kueri tenant OceanBase yang dapat dipulihkan.

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

get

*全部资源

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	ID kluster OceanBase.	ob317v4uif****
IsRemote	boolean	No	Untuk kompatibilitas dengan versi lama, ini dapat dibiarkan kosong.	true
SetId	string	No	ID set cadangan.	bak-xxxxx
RestoreMode	string	No	Mode pemulihan. Opsional. Diperlukan saat IsRemote=true.	from_time_point
Method	string	No	Tipe cadangan.	native_logical
IsOnline	boolean	No	Apakah kluster penguraian target sedang online. Catatan Untuk kompatibilitas dengan versi lama, ini dapat dibiarkan kosong. Jika tidak ditentukan, nilainya adalah kebalikan dari isRemote.	true
RestoreObjectType	string	No	Tipe objek pemulihan.	tenant

Elemen respons

Element	Type	Description	Example
	object	Hasil respons.
TotalCount	integer	Jumlah total.	6
RequestId	string	ID permintaan.	EE205C00-30E4-**-**-87E3A8A2AA0C
Tenants	array<object>	Informasi tenant.
	array<object>	Daftar informasi tenant.
TenantName	string	Nama tenant.	sbtest1
Method	string	Metode cadangan. Valid values: native_logical：库表逻辑备份 : physical：物理备份 : logical：逻辑备份（OB2276及以下） :	logical
TenantId	string	ID tenant.	ob317v4uif****
TimeIntervalList	array<object>	Daftar informasi interval waktu yang dapat dipulihkan untuk tenant.
	object	Informasi interval waktu yang dapat dipulihkan untuk tenant.
StartTime	string	The start time of the restorable period.	2023-01-20T16:00:00Z
EndTime	string	The end time of the restorable period.	2023-03-13T02:43:03Z
FromArchive	boolean	Indicates whether the restore is based on archiving.	true
StorageType	string	The storage type of backup data. Valid values: standard：标准存储 : archive：归档存储 :	standard
ClusterId	string	ID kluster.	objnf3b2****
ObRpmVersion	string	Nomor versi RPM OceanBase.	3.2.3.1-2022080510****
ObVersion	string	Nomor versi utama OceanBase.	3.2.3.1
SourceRegion	string	Wilayah kluster.	cn-hangzhou
TenantAlias	string	Alias tenant.	aaa
CpuNum	integer	Spesifikasi CPU tenant.	1
MemoryNum	integer	Spesifikasi penyimpanan tenant.	100
BackupBucketName	string	Nama direktori cadangan.	backup
ObTenantId	string	ID tenant.	tvd43v****
ClusterName	string	Nama kluster.	testCluster
BackupSets	array<object>	Daftar set cadangan.
	object	Informasi set cadangan.
Checkpoint	string	The checkpoint of the backup set.	2024-01-01'T'12:10:10.000'Z'
SetId	string	The ID of the backup set.	bak-xxxxx
BackupSetId	string	The ID of the full backup set used for restore.	bak-4n****gacpa8
TenantId	string	The ID of the tenant.	t5********
UsedDisk	integer	Ukuran disk tenant.	50
UnitNum	integer	Jumlah unit tenant.	2
TenantMode	string	Mode tenant.	Oracle
TenantDataBackupRemainDays	integer	Sisa hari berlaku untuk data cadangan tenant	7

Contoh

Respons sukses

JSONformat

{
  "TotalCount": 6,
  "RequestId": "EE205C00-30E4-****-****-87E3A8A2AA0C",
  "Tenants": [
    {
      "TenantName": "sbtest1",
      "Method": "logical",
      "TenantId": "ob317v4uif****",
      "TimeIntervalList": [
        {
          "StartTime": "2023-01-20T16:00:00Z",
          "EndTime": "2023-03-13T02:43:03Z",
          "FromArchive": true,
          "StorageType": "standard"
        }
      ],
      "ClusterId": "objnf3b2****",
      "ObRpmVersion": "3.2.3.1-2022080510****",
      "ObVersion": "3.2.3.1",
      "SourceRegion": "cn-hangzhou",
      "TenantAlias": "aaa",
      "CpuNum": 1,
      "MemoryNum": 100,
      "BackupBucketName": "backup",
      "ObTenantId": "tvd43v****",
      "ClusterName": "testCluster",
      "BackupSets": [
        {
          "Checkpoint": "2024-01-01'T'12:10:10.000'Z'",
          "SetId": "bak-xxxxx",
          "BackupSetId": "bak-4n****gacpa8",
          "TenantId": "t5********"
        }
      ],
      "UsedDisk": 50,
      "UnitNum": 2,
      "TenantMode": "Oracle",
      "TenantDataBackupRemainDays": 7
    }
  ]
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.