DescribeDataBackupSet - ApsaraDB for OceanBase (Deprecated)

Mengkueri informasi set cadangan kluster OceanBase.

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

none

*全部资源

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	ID kluster OceanBase.	ob317v4uif****
Status	string	No	Mengkueri set cadangan berdasarkan status.	DONE
BackupObjectType	string	No	Mengkueri set cadangan berdasarkan tipe objek cadangan.	tenant
StartTime	string	No	Waktu mulai. format: yyyy-MM-ddTHH:mm:ssZ (UTC).	2022-12-27T16:00:00Z
EndTime	string	No	Waktu akhir set cadangan.	2023-01-06T15:59:59Z
PageNumber	integer	No	Nomor halaman.	1
PageSize	integer	No	Jumlah entri per halaman. Nilai default: 10.	10

Elemen respons

Element	Type	Description	Example
	object	Parameter tanggapan.
TotalCount	integer	Jumlah total rekaman.	2
RequestId	string	ID permintaan.	EE205C00-30E4-**-**-87E3A8A2AA0C
Data	array<object>	Detail set cadangan.
	array<object>	Detail set cadangan.
EndTime	string	Waktu akhir cadangan.	2023-04-13T03:38:10Z
Status	string	Status set cadangan.	RUNNING
Type	string	Tipe cadangan.	manual
StartTime	string	Waktu mulai cadangan.	2020-05-22T17:04:18
DataSize	integer	Ukuran data set cadangan.	31457280
Policy	string	Kebijakan cadangan.	automated
SetId	string	ID set cadangan.	imm-test-set-cb**ee-b7d7-11ed-956f-**3e10bd70
Method	string	Metode cadangan.	logical
Checkpoint	string	Waktu checkpoint.	2023-05-15T07:11:08Z
DataVersion	integer	Nomor versi data.	1678847020352
BackupObjectType	string	Tipe objek cadangan.	cluster
BackupObjects	array<object>	Daftar objek cadangan.
	array<object>	Detail set cadangan.
ClusterName	string	The name of the cluster.	test-****way
TenantName	string	The name of the tenant.	ob2mr3oae0****
DatabaseTablesList	array<object>	The databases and tables in the backup set.
	object	The details of databases and tables in the backup set.
Database	string	The name of the database.	sms_pre
Tables	array	The tables.
	string	The details of tables.	{'Tables': []}
BackupResults	array<object>	Hasil cadangan.
	array<object>	Detail hasil cadangan.
ClusterName	string	The name of the cluster.	container-opa-****-02
TenantName	string	The name of the tenant.	ob2mr3oae0****
TableBackupResults	array<object>	The table backup results.
	object	The details of table backup results.
Database	string	The name of the database.	order_ce****_online
Table	string	The name of the table.	tr_sale_order_****
Status	string	The backup status.	RUNNING
Message	string	The error description.	Create tag success
DownloadTaskStatus	string	Status tugas cadangan yang sesuai dengan set cadangan.	not_exist
DownloadTaskId	integer	ID tugas cadangan yang sesuai dengan set cadangan.	100***012
Validity	string	Masa berlaku. Parameter ini dapat kosong.	VALID
Progress	string	Progres cadangan.	52
StorageClass	string	Tipe set cadangan. Nilai valid: standard: cadangan utama. archive: cadangan terarsip (sekunder).	standard

Contoh

Respons sukses

JSONformat

{
  "TotalCount": 2,
  "RequestId": "EE205C00-30E4-****-****-87E3A8A2AA0C",
  "Data": [
    {
      "EndTime": "2023-04-13T03:38:10Z",
      "Status": "RUNNING",
      "Type": "manual",
      "StartTime": "2020-05-22T17:04:18",
      "DataSize": 31457280,
      "Policy": "automated",
      "SetId": "imm-test-set-cb****ee-b7d7-11ed-956f-****3e10bd70",
      "Method": "logical",
      "Checkpoint": "2023-05-15T07:11:08Z",
      "DataVersion": 1678847020352,
      "BackupObjectType": "cluster",
      "BackupObjects": [
        {
          "ClusterName": "test-****way",
          "TenantName": "ob2mr3oae0****",
          "DatabaseTablesList": [
            {
              "Database": "sms_pre",
              "Tables": [
                "{'Tables': []}"
              ]
            }
          ]
        }
      ],
      "BackupResults": [
        {
          "ClusterName": "container-opa-****-02",
          "TenantName": "ob2mr3oae0****\n",
          "TableBackupResults": [
            {
              "Database": "order_ce****_online",
              "Table": "tr_sale_order_****",
              "Status": "RUNNING",
              "Message": "Create tag success"
            }
          ]
        }
      ],
      "DownloadTaskStatus": "not_exist",
      "DownloadTaskId": 0,
      "Validity": "VALID",
      "Progress": "52",
      "StorageClass": "standard"
    }
  ]
}

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.