Gunakan DescribeRestoreTaskList untuk kueri pekerjaan restore DBS-Data Management-Alibaba Cloud - Data Management

Mengkueri pekerjaan pemulihan di 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

*BackupPlan

acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}

None

Parameter permintaan

Parameter	Type	Required	Description	Example
BackupPlanId	string	No	ID dari rencana pencadangan (backup plan). Catatan Anda harus menentukan parameter ini atau `RestoreTaskId`.	dbs1hvb0wwwXXXXX
RestoreTaskId	string	No	ID dari tugas pemulihan. Anda dapat menentukan beberapa ID yang dipisahkan dengan koma. Anda dapat memanggil operasi CreateRestoreTask untuk memperoleh ID tugas pemulihan. Catatan Anda harus menentukan parameter ini atau `BackupPlanId`. Menentukan kedua parameter akan menghasilkan kesalahan.	s102h7rf5anq
PageSize	integer	No	Jumlah entri yang dikembalikan pada setiap halaman. Nilai yang valid: 1 hingga 100. Catatan Nilai default: 30.	30
PageNum	integer	No	Nomor halaman. Nilai harus berupa bilangan bulat yang lebih besar dari atau sama dengan 0. Nilai default: 0.	1
ClientToken	string	No	Token klien yang digunakan untuk memastikan idempotensi permintaan. Anda dapat menggunakan klien untuk menghasilkan token, tetapi Anda harus memastikan bahwa token tersebut unik di antara permintaan yang berbeda.	ETnLKlblzczshOTUbOCzxxxxxxx
StartTimestamp	integer	No	Awal dari rentang waktu untuk mengkueri tugas pemulihan. Tentukan waktu sebagai UNIX timestamp dalam milidetik.	1570701361528
EndTimestamp	integer	No	Akhir dari rentang waktu untuk mengkueri tugas pemulihan. Tentukan waktu sebagai UNIX timestamp dalam milidetik.	1570701361528

Elemen respons

Element	Type	Description	Example
	object	Parameter respons.
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 yang dikembalikan.	1
TotalElements	integer	Jumlah total pekerjaan pemulihan.	1
PageSize	integer	Jumlah entri yang dikembalikan per halaman.	30
Items	object
RestoreTaskDetail	array<object>	Detail dari pekerjaan pemulihan.
	object
RestoreStatus	string	The status of the restore job. Valid values: init: The job is not started or the precheck failed. running: The job is running. stop: The job failed. pause: The job is paused. check_pass: The precheck is passed.	running
FullStruAfterRestoreProgress	integer	The progress of post-restore structure restoration.	100
CrossRoleName	string	The name of the RAM role used for cross-account backup.	test123
RestoreDir	string	The restore path.	/home/test
CrossAliyunId	string	The UID of the Alibaba Cloud account used for cross-account backup.	2xxx7778xxxxxxxxxx
RestoreObjects	string	The restore objects.	[ { \"DBName\":\"test\" } ]
BackupPlanId	string	The ID of the backup plan.	dbsxxxx
DestinationEndpointRegion	string	The region of the database.	cn-hangzhou
RestoreTaskCreateTime	integer	The time when the restore job was created. This value is a UNIX timestamp. Unit: milliseconds.	1554560477000
DestinationEndpointUserName	string	The database account.	testUser
RestoreTaskFinishTime	integer	The time when the restore job was completed. This value is a UNIX timestamp. Unit: milliseconds.	1554560477000
DestinationEndpointIpPort	string	The database endpoint.	100.X.X.10:33204
DestinationEndpointDatabaseName	string	The database name.	test
DestinationEndpointInstanceType	string	The location of the database. Valid values: RDS ECS Express: A database connected over a leased line, VPN Gateway, or Smart Access Gateway. agent: A database connected using a backup gateway. dds: An ApsaraDB for MongoDB instance. other: A database connected over the internet.	RDS
DestinationEndpointOracleSID	string	The Oracle system ID (SID).	test
FullStruforeRestoreProgress	integer	The progress of pre-restore structure restoration.	100
ErrMessage	string	The error message.	NULL
RestoreTaskId	string	The ID of the restore job.	1iyixxxxxx
FullDataRestoreProgress	integer	The progress of full data restoration.	100
ContinuousRestoreProgress	integer	The progress of incremental log restoration.	100
DestinationEndpointInstanceID	string	The ID of the database instance.	rm-bp1p8c2947XXX
BackupSetId	string	The ID of the full backup set used for the restoration.	urjlfmxxxxx
BackupGatewayId	integer	The ID of the backup gateway.	324234332
RestoreTaskName	string	The name of the restore job.	dbsr1g3xxxx_Restore_Task_1775009514575
RestoreTime	integer	The restore time. This value is a UNIX timestamp. Unit: milliseconds.	1554560477000
DestinationEndpointHost	string		127.0.0.1
DestinationEndpointPort	string		3306
DestinationEndpointEnableSsl	string		true
BackupGatewayIdentifier	string		TESTGATEWAY
BackupSourceOssRegion	string		cn-beijing
RestoreDestinationMode	string		EXIST_INSTANCE
PhysicalFullBackupRecoverProgress	integer		100
PhysicalFullAndIncrementBackupRecoverProgress	integer		100
PhysicalIncrementBackupRecoverProgress	integer		100
PhysicalDatabaseOnlineProgress	integer		100
PhysicalBackupRecoverProgress	integer		100

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": "/home/test",
        "CrossAliyunId": "2xxx7778xxxxxxxxxx",
        "RestoreObjects": "[ { \\\"DBName\\\":\\\"test\\\" } ]",
        "BackupPlanId": "dbsxxxx",
        "DestinationEndpointRegion": "cn-hangzhou",
        "RestoreTaskCreateTime": 1554560477000,
        "DestinationEndpointUserName": "testUser",
        "RestoreTaskFinishTime": 1554560477000,
        "DestinationEndpointIpPort": "100.X.X.10:33204",
        "DestinationEndpointDatabaseName": "test",
        "DestinationEndpointInstanceType": "RDS",
        "DestinationEndpointOracleSID": "test",
        "FullStruforeRestoreProgress": 100,
        "ErrMessage": "NULL",
        "RestoreTaskId": "1iyixxxxxx",
        "FullDataRestoreProgress": 100,
        "ContinuousRestoreProgress": 100,
        "DestinationEndpointInstanceID": "rm-bp1p8c2947XXX",
        "BackupSetId": "urjlfmxxxxx",
        "BackupGatewayId": 324234332,
        "RestoreTaskName": "dbsr1g3xxxx_Restore_Task_1775009514575",
        "RestoreTime": 1554560477000,
        "DestinationEndpointHost": "127.0.0.1",
        "DestinationEndpointPort": "3306",
        "DestinationEndpointEnableSsl": "true",
        "BackupGatewayIdentifier": "TESTGATEWAY",
        "BackupSourceOssRegion": "cn-beijing",
        "RestoreDestinationMode": "EXIST_INSTANCE",
        "PhysicalFullBackupRecoverProgress": 100,
        "PhysicalFullAndIncrementBackupRecoverProgress": 100,
        "PhysicalIncrementBackupRecoverProgress": 100,
        "PhysicalDatabaseOnlineProgress": 100,
        "PhysicalBackupRecoverProgress": 100
      }
    ]
  }
}

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.