Ringkasan DescribeBackupPlanList API - Data Management - Alibaba Cloud - Data Management

Mengkueri rencana cadangan DBS.

Deskripsi operasi

Ensure Object Storage Service (OSS) is enabled before you use this operation. For more information, see 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 rencana cadangan. Anda dapat menentukan beberapa ID rencana cadangan, dipisahkan dengan koma.	dbstooi01exXXXX
Region	string	No	ID Wilayah tempat rencana cadangan berada. Anda dapat memanggil operasi DescribeRegions untuk mengkueri daftar Wilayah yang didukung.	cn-hangzhou
PageSize	integer	No	Jumlah entri per halaman. Nilai valid: 1 hingga 100. Catatan Nilai default adalah 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
BackupPlanName	string	No	Nama rencana cadangan.	test123
BackupPlanStatus	string	No	Status rencana cadangan. Nilai valid: wait: Rencana cadangan belum dikonfigurasi. init: Rencana cadangan tidak dimulai karena Pemeriksaan Awal gagal. running: Rencana cadangan sedang berjalan. stop: Rencana cadangan gagal. pause: Rencana cadangan dijeda. locked: Rencana cadangan terkunci. check_pass: Pemeriksaan Awal berhasil.	wait
ClientToken	string	No	Token yang dihasilkan Klien untuk memastikan idempotensi permintaan.	ASDASDASDSADASFCZXVZ
ResourceGroupId	string	No	ID kelompok sumber daya.	rg-aekzecovzti****
ShowStorageStrategyInfo	boolean	No	Apakah akan mengembalikan informasi tentang strategi penyimpanan dalam format respons. Nilai default: false.	false
ShowBackupStrategyInfo	boolean	No	Apakah akan mengembalikan informasi tentang strategi cadangan dalam format respons. Nilai default: false.	false
ShowRecoverTimeRange	boolean	No	Apakah akan mengembalikan Rentang pengatur waktu pemulihan. Nilai default: false.	false
BackupMethod	string	No	Metode cadangan.	logical

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.	4F1888AC-1138-4995-B9FE-D2734F61C058
ErrCode	string	The error code.	InvalidParameterValid
Success	boolean	Indicates whether the request was successful.	true
ErrMessage	string	The error message.	The specified parameter %s value is not valid.
TotalPages	integer	The total number of pages.	4
TotalElements	integer	The total number of backup plans.	100
PageSize	integer	The number of entries per page.	30
Items	object	The response items.
BackupPlanDetail	array<object>	A list of the backup plans.
	object	The details of a backup plan.
CrossRoleName	string	RAM role name for cross-account backups.	test123
SourceEndpointInstanceType	string	Database location. Valid values: rds ecs express: Database connected through a leased line, VPN Gateway, or Smart Access Gateway. agent: Database connected through a backup gateway. dds: ApsaraDB for MongoDB. other: Database connected directly by IP address and port.	rds
BackupSetDownloadDir	string	Server directory for downloading backup sets.	*/test/test123
SourceEndpointIpPort	string	Database endpoint.	100...10:33204
CrossAliyunId	string	User ID for cross-account backups.	2xxx7778xxxxxxxxxx
DuplicationArchivePeriod	integer	The number of days to retain backups in archive cold storage.	365
BackupPlanId	string	Backup plan ID.	dbstooi01eXXXX
EndTimestampForRestore	integer	End timestamp of the time range during which you can restore the database.	1554560477000
BackupPlanStatus	string	Backup plan status. Valid values: wait: Not configured. init: Not started (precheck failed). running: Running. stop: Failed. pause: Paused. locked: Locked. check_pass: Precheck passed.	init
BackupSetDownloadFullDataFormat	string	Full data format for downloaded backup sets. Valid values: Native SQL CSV JSON	SQL
BackupRetentionPeriod	integer	Number of days to retain backup data. Valid values: 0 to 1825.	365
OSSBucketRegion	string	OSS bucket region.	cn-hangzhou
SourceEndpointOracleSID	string	Oracle system ID (SID) name.	test
BackupStorageType	string	Built-in storage type. Valid values: Empty (default): Backup data is stored in your OSS bucket. system: Backup data is stored in DBS's built-in OSS bucket.	system
BackupMethod	string	Backup method. Valid values: logical: Logical backup. physical: Physical backup. duplication: Duplicate backup.	logical
SourceEndpointRegion	string	Database region.	cn-hangzhou
BackupPeriod	string	Full backup schedule. Valid values: Monday Tuesday Wednesday Thursday Friday Saturday Sunday	Monday
SourceEndpointDatabaseName	string	Database name.	test
BackupSetDownloadGatewayId	integer	Backup gateway ID for downloading backup sets.	123123
BackupPlanCreateTime	integer	Backup plan creation timestamp.	1582527713000
InstanceClass	string	Instance specification. Valid values: micro: Entry-level. small: Low-spec. medium: Medium-spec. large: High-spec. xlarge: High-spec (no traffic limit).	micro
BackupSetDownloadTargetType	string	Target type for downloading backup sets. Catatan Only valid value: agent. Indicates that a backup gateway is installed.	agent
DuplicationInfrequentAccessPeriod	integer	Number of days before backups move to Infrequent Access storage.	180
BackupStartTime	string	Start time for full backups. Format: HH:mm.	14:22
ErrMessage	string	Precheck error message.	can not connect to oracle instance orcl with user dbs
BackupObjects	string	Backup objects.	[ { \"DBName\":\"待备份库名\", \"SchemaName\":\"待备份 Schema 名\", \"TableIncludes\":[{ \"TableName\":\"待备份表表名\" }], \"TableExcludes\":[{ \"TableName\":\"待备份库名不需要备份表的表名\" }] } ]
BeginTimestampForRestore	integer	Start timestamp of the time range during which you can restore the database.	1554560477000
SourceEndpointInstanceID	string	Database instance ID.	test
OpenBackupSetAutoDownload	boolean	Indicates whether automatic backup set download is enabled.	true
BackupPlanName	string	Backup plan name.	dbstooi01e****
OSSBucketName	string	OSS bucket name.	dbs-backup-1857XXXXX489
BackupGatewayId	integer	Backup gateway ID.	827362187368736
SourceEndpointUserName	string	Database account.	test
BackupSetDownloadIncrementDataFormat	string	Incremental data format for downloaded backup sets. Valid values: Native SQL CSV JSON	SQL
EnableBackupLog	boolean	Indicates whether incremental log backup is enabled. Valid values: true: Enabled. false: Disabled.	true
ResourceGroupId	string	Resource group ID.	rg-aekzecovzti****
DatabaseType	string	Database type.	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		false

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.