Ringkasan DescribeBackupPlanList API - Data Management

Operasi ini memungkinkan Anda melihat daftar backup plan DBS.

Deskripsi operasi

Sebelum menggunakan operasi ini, pastikan Object Storage Service (OSS) telah diaktifkan. Untuk informasi selengkapnya, lihat Object Storage Service.

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

get

*BackupPlan

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

None

Parameter permintaan

Parameter	Type	Required	Description	Example
BackupPlanId	string	No	ID backup plan. Untuk menampilkan beberapa backup plan, pisahkan ID dengan koma.	dbstooi01exXXXX
Region	string	No	Wilayah DBS. Panggil DescribeRegions untuk melihat wilayah yang didukung.	cn-hangzhou
PageSize	integer	No	Jumlah catatan per halaman. Nilai yang valid: 1 hingga 100. Catatan Nilai default: 30.	30
PageNum	integer	No	Nomor halaman. Nilai yang valid: bilangan bulat lebih besar dari atau sama dengan 0 dan kurang dari atau sama dengan nilai maksimum integer. Nilai default: 0.	1
BackupPlanName	string	No	Nama backup plan.	test123
BackupPlanStatus	string	No	Status backup plan. Nilai yang valid: wait: Belum dikonfigurasi. init: Belum dimulai (precheck gagal). running: Berjalan. stop: Gagal. pause: Dijeda. locked: Terkunci. check_pass: Precheck berhasil.	wait
ClientToken	string	No	Token client yang digunakan untuk memastikan idempotensi dan mencegah permintaan duplikat.	ASDASDASDSADASFCZXVZ
ResourceGroupId	string	No	ID grup resource.	rg-aekzecovzti****

Elemen respons

Element	Type	Description	Example
	object	Parameter respons dijelaskan di bawah ini.
HttpStatusCode	integer	Kode status HTTP.	200
PageNum	integer	Nomor halaman.	1
RequestId	string	ID permintaan.	4F1888AC-1138-4995-B9FE-D2734F61C058
ErrCode	string	Kode error.	InvalidParameterValid
Success	boolean	Menunjukkan apakah permintaan berhasil.	true
ErrMessage	string	Pesan error.	The specified parameter %s value is not valid.
TotalPages	integer	Total jumlah halaman.	4
TotalElements	integer	Total jumlah backup plan.	100
PageSize	integer	Jumlah catatan per halaman.	30
Items	object
BackupPlanDetail	array<object>	Detail backup plan.
	object	Nilai respons.
CrossRoleName	string	Nama Peran RAM untuk backup cross-account.	test123
SourceEndpointInstanceType	string	Lokasi database. Nilai yang valid: rds ecs express: Database yang terhubung melalui leased line, Gateway VPN, atau Smart Access Gateway. agent: Database yang terhubung melalui gateway cadangan. dds: ApsaraDB for MongoDB. other: Database yang terhubung langsung melalui alamat IP dan port.	rds
BackupSetDownloadDir	string	Direktori server untuk mengunduh set cadangan.	*/test/test123
SourceEndpointIpPort	string	Titik akhir database.	100...10:33204
CrossAliyunId	string	ID pengguna untuk backup cross-account.	2xxx7778xxxxxxxxxx
DuplicationArchivePeriod	integer	Jumlah hari penyimpanan cadangan di cold storage arsip.	365
BackupPlanId	string	ID backup plan.	dbstooi01eXXXX
EndTimestampForRestore	integer	Timestamp akhir rentang waktu saat Anda dapat memulihkan database.	1554560477000
BackupPlanStatus	string	Status backup plan. Nilai yang valid: wait: Belum dikonfigurasi. init: Belum dimulai (precheck gagal). running: Berjalan. stop: Gagal. pause: Dijeda. locked: Terkunci. check_pass: Precheck berhasil.	init
BackupSetDownloadFullDataFormat	string	Format data penuh untuk set cadangan yang diunduh. Nilai yang valid: Native SQL CSV JSON	SQL
BackupRetentionPeriod	integer	Jumlah hari penyimpanan data cadangan. Nilai yang valid: 0 hingga 1825.	365
OSSBucketRegion	string	Wilayah Bucket OSS.	cn-hangzhou
SourceEndpointOracleSID	string	Nama Oracle system ID (SID).	test
BackupStorageType	string	Tipe penyimpanan bawaan. Nilai yang valid: Kosong (default): Data cadangan disimpan di Bucket OSS Anda. system: Data cadangan disimpan di Bucket OSS bawaan DBS.	system
BackupMethod	string	Metode pencadangan. Nilai yang valid: logical: Cadangan logis. physical: Cadangan fisik. duplication: Cadangan duplikat.	logical
SourceEndpointRegion	string	Wilayah database.	cn-hangzhou
BackupPeriod	string	Jadwal cadangan penuh. Nilai yang valid: Monday Tuesday Wednesday Thursday Friday Saturday Sunday	Monday
SourceEndpointDatabaseName	string	Nama database.	test
BackupSetDownloadGatewayId	integer	ID gateway cadangan untuk mengunduh set cadangan.	123123
BackupPlanCreateTime	integer	Timestamp pembuatan backup plan.	1582527713000
InstanceClass	string	Spesifikasi instans. Nilai yang valid: micro: Tingkat pemula. small: Spesifikasi rendah. medium: Spesifikasi menengah. large: Spesifikasi tinggi. xlarge: Spesifikasi tinggi (tanpa batas trafik).	micro
BackupSetDownloadTargetType	string	Tipe target untuk mengunduh set cadangan. Catatan Hanya nilai yang valid: agent. Menunjukkan bahwa gateway cadangan telah diinstal.	agent
DuplicationInfrequentAccessPeriod	integer	Jumlah hari sebelum cadangan dipindahkan ke penyimpanan Infrequent Access.	180
BackupStartTime	string	Waktu mulai untuk cadangan penuh. Format: HH:mm.	14:22
ErrMessage	string	Pesan error precheck.	can not connect to oracle instance orcl with user dbs
BackupObjects	string	Objek yang dicadangkan.	[ { \"DBName\":\"待备份库名\", \"SchemaName\":\"待备份 Schema 名\", \"TableIncludes\":[{ \"TableName\":\"待备份表表名\" }], \"TableExcludes\":[{ \"TableName\":\"待备份库名不需要备份表的表名\" }] } ]
BeginTimestampForRestore	integer	Timestamp awal rentang waktu saat Anda dapat memulihkan database.	1554560477000
SourceEndpointInstanceID	string	ID instans database.	test
OpenBackupSetAutoDownload	boolean	Menunjukkan apakah unduhan otomatis set cadangan diaktifkan.	true
BackupPlanName	string	Nama backup plan.	dbstooi01e****
OSSBucketName	string	Nama Bucket OSS.	dbs-backup-1857XXXXX489
BackupGatewayId	integer	ID gateway cadangan.	827362187368736
SourceEndpointUserName	string	Akun database.	test
BackupSetDownloadIncrementDataFormat	string	Format data inkremental untuk set cadangan yang diunduh. Nilai yang valid: Native SQL CSV JSON	SQL
EnableBackupLog	boolean	Menunjukkan apakah cadangan log inkremental diaktifkan. Nilai yang valid: true: Diaktifkan. false: Dinonaktifkan.	true
ResourceGroupId	string	ID grup resource.	rg-aekzecovzti****
DatabaseType	string	Tipe database.	MySQL
BackupPlanRegion	string		cn-beijing
SourceEndpointHost	string		127.0.0.1
InstanceChargeType	string		PREPAY
InstanceExpiredTimestamp	integer		1764051253000
SourceEndpointEnableSsl	string		true
StorageEncryptMethod	string		encrypted
SourceEndpointPort	string		3306
IncrementBackupRetentionPeriod	string		365
IncrementDuplicationInfrequentAccessPeriod	string		365
IncrementDuplicationArchivePeriod	string		365
LogBackupRetentionPeriod	string		365
LogDuplicationInfrequentAccessPeriod	string		365
LogDuplicationArchivePeriod	string		365
BackupGatewayIdentifier	string		TESTGATEWAY
EnableMysqlPhysicalBackupBinLog	boolean

Contoh

Respons sukses

JSONformat

{
  "HttpStatusCode": 200,
  "PageNum": 1,
  "RequestId": "4F1888AC-1138-4995-B9FE-D2734F61C058",
  "ErrCode": "InvalidParameterValid",
  "Success": true,
  "ErrMessage": "The specified parameter %s value is not valid.     ",
  "TotalPages": 4,
  "TotalElements": 100,
  "PageSize": 30,
  "Items": {
    "BackupPlanDetail": [
      {
        "CrossRoleName": "test123",
        "SourceEndpointInstanceType": "rds",
        "BackupSetDownloadDir": "*/test/test123",
        "SourceEndpointIpPort": "100.*.*.10:33204",
        "CrossAliyunId": "2xxx7778xxxxxxxxxx",
        "DuplicationArchivePeriod": 365,
        "BackupPlanId": "dbstooi01eXXXX",
        "EndTimestampForRestore": 1554560477000,
        "BackupPlanStatus": "init",
        "BackupSetDownloadFullDataFormat": "SQL",
        "BackupRetentionPeriod": 365,
        "OSSBucketRegion": "cn-hangzhou",
        "SourceEndpointOracleSID": "test",
        "BackupStorageType": "system",
        "BackupMethod": "logical",
        "SourceEndpointRegion": "cn-hangzhou",
        "BackupPeriod": "Monday",
        "SourceEndpointDatabaseName": "test",
        "BackupSetDownloadGatewayId": 123123,
        "BackupPlanCreateTime": 1582527713000,
        "InstanceClass": "micro",
        "BackupSetDownloadTargetType": "agent",
        "DuplicationInfrequentAccessPeriod": 180,
        "BackupStartTime": "14:22",
        "ErrMessage": "  can not connect to oracle instance orcl with user dbs",
        "BackupObjects": "[     {         \\\"DBName\\\":\\\"待备份库名\\\",         \\\"SchemaName\\\":\\\"待备份 Schema 名\\\",         \\\"TableIncludes\\\":[{             \\\"TableName\\\":\\\"待备份表表名\\\"         }],         \\\"TableExcludes\\\":[{             \\\"TableName\\\":\\\"待备份库名不需要备份表的表名\\\"         }]     } ]",
        "BeginTimestampForRestore": 1554560477000,
        "SourceEndpointInstanceID": "test",
        "OpenBackupSetAutoDownload": true,
        "BackupPlanName": "dbstooi01e****",
        "OSSBucketName": "dbs-backup-1857XXXXX489",
        "BackupGatewayId": 827362187368736,
        "SourceEndpointUserName": "test",
        "BackupSetDownloadIncrementDataFormat": "SQL",
        "EnableBackupLog": true,
        "ResourceGroupId": "rg-aekzecovzti****",
        "DatabaseType": "MySQL",
        "BackupPlanRegion": "cn-beijing",
        "SourceEndpointHost": "127.0.0.1",
        "InstanceChargeType": "PREPAY",
        "InstanceExpiredTimestamp": 1764051253000,
        "SourceEndpointEnableSsl": "true",
        "StorageEncryptMethod": "encrypted",
        "SourceEndpointPort": "3306",
        "IncrementBackupRetentionPeriod": "365",
        "IncrementDuplicationInfrequentAccessPeriod": "365",
        "IncrementDuplicationArchivePeriod": "365",
        "LogBackupRetentionPeriod": "365",
        "LogDuplicationInfrequentAccessPeriod": "365",
        "LogDuplicationArchivePeriod": "365",
        "BackupGatewayIdentifier": "TESTGATEWAY",
        "EnableMysqlPhysicalBackupBinLog": false
      }
    ]
  }
}

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.