DescribeFullBackupList API: kueri rekaman backup penuh melalui OpenAPI-Data Management-Alibaba Cloud - Data Management

Operasi ini mencantumkan tugas cadangan penuh di Cadangan Basis Data (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:DescribeFullBackupList

get

*BackupPlan

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

None

Parameter permintaan

Parameter	Type	Required	Description	Example
BackupPlanId	string	Yes	ID rencana cadangan.	dbsr179qz******
PageSize	integer	No	Jumlah entri yang dikembalikan pada setiap halaman. Nilai valid: 30 50 100 Nilai default: 30.	30
PageNum	integer	No	Nomor halaman yang dikembalikan. Nilai harus berupa bilangan bulat yang lebih besar dari atau sama dengan 0. Nilai default: 0.	1
ClientToken	string	No	Token yang dapat Anda gunakan untuk memastikan idempotensi permintaan.	ETnLKlblzczshOTUbOCzxxxxxxx
ShowStorageType	boolean	No	Apakah akan mengembalikan kelas penyimpanan set cadangan.	true
BackupSetId	string	No	ID set cadangan.	1iukx5h******
StartTimestamp	integer	No	Awal rentang pengatur waktu yang akan dikueri. Nilai ini adalah Stempel waktu UNIX yang menyatakan jumlah detik yang telah berlalu sejak 1 Januari 1970, 00:00:00 UTC.	1676887100
EndTimestamp	integer	No	Akhir rentang pengatur waktu yang akan dikueri. Nilai ini adalah Stempel waktu UNIX yang menyatakan jumlah detik yang telah berlalu sejak 1 Januari 1970, 00:00:00 UTC.	1676887128
ShowProgress	string	No	Apakah akan mengembalikan informasi pengatur waktu nyata tentang kemajuan pencadangan.	true
BackupSetStatus	string	No	Status set cadangan. Anda dapat menggunakan parameter ini untuk memfilter set cadangan.	finish

Elemen respons

Element	Type	Description	Example
	object	The response parameters.
HttpStatusCode	integer	The HTTP status code.	200
PageNum	integer	The page number.	1
RequestId	string	The request ID.	636BC118-6080-4119-A6B5-C199CEC1037D
ErrCode	string	The error code.	Param.NotFound
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true
ErrMessage	string	The error message.	The specified parameter %s value is not valid.
TotalPages	integer	The total number of pages.	1
TotalElements	integer	The total number of full backup sets.	1
PageSize	integer	The number of entries per page.	10
Items	object	The details of the full backup sets.
FullBackupFile	array<object>	The details of the full backup sets.
	object	The details of a full backup set.
FinishTime	integer	The finish time of the job, in UNIX timestamp format.	1676887128000
BackupStatus	string	The status of the backup job. Valid values: schedule: initializing running: running finish: completed stop: failed pause: paused	finish
SourceEndpointIpPort	string	The database endpoint.	121.XXX.XXX.144:3306
CreateTime	integer	The start time of the job, in UNIX timestamp format.	1676886947000
ErrMessage	string	The error message.	NULL
BackupObjects	string	The backup objects.	[{\"DBName\":\"test\"}]
EndTime	integer	The end time of the backup, in UNIX timestamp format.	1676887128000
StartTime	integer	The time when the backup process started.	1676887100000
BackupSetExpiredTime	integer	The expiration time of the backup set, in UNIX timestamp format.	1677491900000
StorageMethod	string	The storage class. Valid values: Standard: Standard Storage IA: Infrequent Access Archive: Archive Storage UNKNOWN: Unknown. This value usually appears when the job is incomplete.	Standard
BackupSetId	string	The ID of the backup set.	1iukx5h******
BackupSize	integer	The size of the backup, in bytes.	580
SourceEndpointInstanceType	string		rds
SourceEndpointInstanceId	string		rm-testxx
SourceEndpointRegion	string		cn-beijing
SourceEndpointHost	string		127.0.0.1
StorageEncryptMethod	string		encrypted
CrossRoleName	string		ram-for-dbs
CrossAliyunId	string		2xxx7778xxxxxxxxxx
SourceEndpointEnableSsl	string		true
LogicalStructureBackupProgress	integer		100
LogicalFullBackupProgress	integer		100
BackupGatewayIdentifier	string		TESTGATEWAY
SourceEndpointUserName	string		dbs_backup
SourceEndpointPort	string		3306

Contoh

Respons sukses

JSONformat

{
  "HttpStatusCode": 200,
  "PageNum": 1,
  "RequestId": "636BC118-6080-4119-A6B5-C199CEC1037D",
  "ErrCode": "Param.NotFound",
  "Success": true,
  "ErrMessage": "The specified parameter %s value is not valid.     ",
  "TotalPages": 1,
  "TotalElements": 1,
  "PageSize": 10,
  "Items": {
    "FullBackupFile": [
      {
        "FinishTime": 1676887128000,
        "BackupStatus": "finish",
        "SourceEndpointIpPort": "121.XXX.XXX.144:3306",
        "CreateTime": 1676886947000,
        "ErrMessage": "NULL",
        "BackupObjects": "[{\\\"DBName\\\":\\\"test\\\"}]",
        "EndTime": 1676887128000,
        "StartTime": 1676887100000,
        "BackupSetExpiredTime": 1677491900000,
        "StorageMethod": "Standard",
        "BackupSetId": "1iukx5h******",
        "BackupSize": 580,
        "SourceEndpointInstanceType": "rds",
        "SourceEndpointInstanceId": "rm-testxx",
        "SourceEndpointRegion": "cn-beijing",
        "SourceEndpointHost": "127.0.0.1",
        "StorageEncryptMethod": "encrypted",
        "CrossRoleName": "ram-for-dbs",
        "CrossAliyunId": "2xxx7778xxxxxxxxxx",
        "SourceEndpointEnableSsl": "true",
        "LogicalStructureBackupProgress": 100,
        "LogicalFullBackupProgress": 100,
        "BackupGatewayIdentifier": "TESTGATEWAY",
        "SourceEndpointUserName": "dbs_backup",
        "SourceEndpointPort": "3306"
      }
    ]
  }
}

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.