DescribeRestoreTaskList - Data Management

Mengambil daftar pekerjaan pemulihan Database Backup Service (DBS).

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

dbs:DescribeRestoreTaskList

get

*全部资源

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
BackupPlanId	string	No	ID jadwal backup. Catatan Tentukan salah satu dari BackupPlanId atau RestoreTaskId.	dbs1hvb0wwwXXXXX
RestoreTaskId	string	No	ID pekerjaan pemulihan. Anda dapat menentukan beberapa ID. Pisahkan dengan koma (,). Anda dapat memanggil operasi CreateRestoreTask untuk mendapatkan parameter ini. Catatan Tentukan salah satu dari RestoreTaskId atau BackupPlanId. Jika Anda menentukan keduanya, sistem akan mengembalikan error.	s102h7rf5anq
PageSize	integer	No	Jumlah entri yang dikembalikan per halaman. Nilai yang valid: 1 hingga 100. Catatan Nilai default adalah 30.	30
PageNum	integer	No	Nomor halaman. Nilainya harus berupa bilangan bulat yang lebih besar dari atau sama dengan 0. Nilai default adalah 0.	1
ClientToken	string	No	Token klien yang digunakan untuk memastikan idempotensi permintaan.	ETnLKlblzczshOTUbOCzxxxxxxx
StartTimestamp	integer	No	Waktu mulai backup.	1570701361528
EndTimestamp	integer	No	Waktu akhir backup.	1570701361528

Elemen respons

Element	Type	Description	Example
	object	Detail parameter yang dikembalikan.
HttpStatusCode	integer	Kode status HTTP.	200
PageNum	integer	Nomor halaman.	1
RequestId	string	ID permintaan.	9C397502-B4F2-4E22-AD97-C81F0049F3F3
ErrCode	string	Kode kesalahan.	Param.NotFound
Success	boolean	Menunjukkan apakah permintaan berhasil.	true
ErrMessage	string	Pesan kesalahan.	The specified parameter %s value is not valid.
TotalPages	integer	Jumlah total halaman.	1
TotalElements	integer	Jumlah total pekerjaan pemulihan.	1
PageSize	integer	Jumlah entri pada halaman saat ini.	30
Items	object
RestoreTaskDetail	array<object>	Detail pekerjaan pemulihan.
	object
RestoreStatus	string	Status pekerjaan pemulihan. Nilai yang valid: init: Pekerjaan belum dimulai atau pemeriksaan awal gagal. running: Pekerjaan sedang berjalan. stop: Pekerjaan gagal. pause: Pekerjaan dijeda. check_pass: Pemeriksaan awal berhasil.	running
FullStruAfterRestoreProgress	integer	Kemajuan tugas struktur penuh pasca-pemulihan.	100
CrossRoleName	string	Nama role Resource Access Management (RAM) yang digunakan untuk backup lintas akun.	test123
RestoreDir	string	Jalur pemulihan.	100.X.X.10:33204
CrossAliyunId	string	UID Akun Alibaba Cloud yang digunakan untuk backup lintas akun.	2xxx7778xxxxxxxxxx
RestoreObjects	string	Objek yang akan dipulihkan.	[ { \"DBName\":\"test\" } ]
BackupPlanId	string	ID jadwal backup.	dbs1hvb0wXXXX
DestinationEndpointRegion	string	Wilayah database.	cn-hangzhou
RestoreTaskCreateTime	integer	Waktu pembuatan pekerjaan pemulihan. Ini merupakan stempel waktu UNIX. Satuan: milidetik. Contoh: 1554560477000.	1554560477000
DestinationEndpointUserName	string	Akun database.	test
RestoreTaskFinishTime	integer	Waktu penyelesaian pekerjaan pemulihan. Ini merupakan stempel waktu UNIX. Satuan: milidetik. Contoh: 1554560477000.	1554560477000
DestinationEndpointIpPort	string	Titik akhir database.	100.X.X.10:33204
DestinationEndpointDatabaseName	string	Nama database.	test
DestinationEndpointInstanceType	string	Lokasi database. Nilai yang valid: RDS ECS Express: Database yang terhubung melalui jalur sewa, Gateway VPN, atau Smart Access Gateway. agent: Database yang terhubung melalui gateway cadangan. dds: ApsaraDB for MongoDB. other: Database yang terhubung melalui internet.	RDS
DestinationEndpointOracleSID	string	System ID (SID) Oracle.	test
FullStruforeRestoreProgress	integer	Kemajuan tugas struktur penuh pra-pemulihan.	0
ErrMessage	string	Pesan kesalahan.	NULL
RestoreTaskId	string	ID pekerjaan pemulihan.	s1XXXXXX
FullDataRestoreProgress	integer	Kemajuan pemulihan data penuh.	100
ContinuousRestoreProgress	integer	Kemajuan pemulihan log inkremental.	100
DestinationEndpointInstanceID	string	ID instansiasi basis data.	rm-bp1p8c2947XXX
BackupSetId	string	ID set cadangan penuh yang digunakan untuk pemulihan.	1ibh2f5uXXX
BackupGatewayId	integer	ID gateway cadangan.	324234332
RestoreTaskName	string	Nama pekerjaan pemulihan.	test
RestoreTime	integer	Waktu tujuan pemulihan database. Ini merupakan stempel waktu UNIX. Satuan: milidetik. Contoh: 1554560477000.	1554560477000

Contoh

Respons sukses

JSONformat

{
  "HttpStatusCode": 200,
  "PageNum": 1,
  "RequestId": "9C397502-B4F2-4E22-AD97-C81F0049F3F3",
  "ErrCode": "Param.NotFound",
  "Success": true,
  "ErrMessage": "The specified parameter %s value is not valid. ",
  "TotalPages": 1,
  "TotalElements": 1,
  "PageSize": 30,
  "Items": {
    "RestoreTaskDetail": [
      {
        "RestoreStatus": "running",
        "FullStruAfterRestoreProgress": 100,
        "CrossRoleName": "test123",
        "RestoreDir": "100.X.X.10:33204",
        "CrossAliyunId": "2xxx7778xxxxxxxxxx",
        "RestoreObjects": "[     {         \\\"DBName\\\":\\\"test\\\"       } ]",
        "BackupPlanId": "dbs1hvb0wXXXX",
        "DestinationEndpointRegion": "cn-hangzhou",
        "RestoreTaskCreateTime": 1554560477000,
        "DestinationEndpointUserName": "test",
        "RestoreTaskFinishTime": 1554560477000,
        "DestinationEndpointIpPort": "100.X.X.10:33204",
        "DestinationEndpointDatabaseName": "test",
        "DestinationEndpointInstanceType": "RDS",
        "DestinationEndpointOracleSID": "test",
        "FullStruforeRestoreProgress": 0,
        "ErrMessage": "NULL",
        "RestoreTaskId": "s1XXXXXX",
        "FullDataRestoreProgress": 100,
        "ContinuousRestoreProgress": 100,
        "DestinationEndpointInstanceID": "rm-bp1p8c2947XXX",
        "BackupSetId": "1ibh2f5uXXX",
        "BackupGatewayId": 324234332,
        "RestoreTaskName": "test",
        "RestoreTime": 1554560477000
      }
    ]
  }
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
403	Request.Forbidden	Have no Permissions

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.