DescribeBackupPlanList - Database Backup - Alibaba Cloud Documentation Center

Queries backup schedules.

Operation Description

Before you call this operation, activate Object Storage Service (OSS). For more information, see What is OSS?

Authorization information

The following table is the authorization information corresponding to the API, which can be found in the RAM permission policy statement.Action Used in the element to grant the RAM user or RAM role permission to call this API. The specific instructions are as follows:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All resources is used in the Resource type column of the operation.
Condition keyword: refers to the condition keyword defined by the cloud product itself.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operate	access level	Resource type	conditional keyword	Association operation
dbs:DescribeBackupPlanList	List	DBS acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}	without	without

Request parameters

Parameter	Type	Required	Description	Example
BackupPlanId	string	No	The ID of the backup schedule. You can query multiple backup schedules. Separate multiple IDs with commas (,).	dbstooi01exXXXX
Region	string	No	The region in which Database Backup (DBS) is activated. You can call the DescribeRegions operation to query the regions in which DBS is supported.	cn-hangzhou
PageSize	integer	No	The number of entries to return on each page. Valid values: 30 50 100 NoteDefault value: 30.	30
PageNum	integer	No	The number of the page to return. The value must be an integer that is greater than or equal to 0. Default value: 0.	1
BackupPlanName	string	No	The name of the backup schedule.	test123
BackupPlanStatus	string	No	The status of the backup schedule. Valid values: wait: The backup schedule is not configured. init: The backup schedule is not started and fails to pass the precheck. running: The backup schedule is running. stop: The backup schedule fails. pause: The backup schedule is paused. locked: The backup schedule is locked. check_pass: The backup schedule passes the precheck.	wait
ClientToken	string	No	The client token that is used to ensure the idempotence of the request.	ASDASDASDSADASFCZXVZ
ResourceGroupId	string	No	The ID of the resource group.	rg-aekzecovzti****

Response parameters

Parameter	Type	Description	Example
	object
HttpStatusCode	integer	The HTTP status code.	200
PageNum	integer	The page number of the returned page.	1
RequestId	string	The ID of the request.	4F1888AC-1138-4995-B9FE-D2734F61C058
ErrCode	string	The error code returned if the request failed.	Param.NotFound
Success	boolean	Indicates whether the request is successful.	true
ErrMessage	string	The error message returned if the request failed.	The specified parameter %s value is not valid.
TotalPages	integer	The total number of returned pages.	4
TotalElements	integer	The total number of backup schedules.	100
PageSize	integer	The number of entries returned per page.	30
Items	array	The details of the backup schedules.
	object	The return value.
CrossRoleName	string	The name of the RAM role that is used to perform backups across Alibaba Cloud accounts.	test123
SourceEndpointInstanceType	string	The location of the database. Valid values: rds ecs express: The database is connected to DBS by using Express Connect, VPN Gateway, or Smart Access Gateway. agent: The database is connected to DBS over a DBS backup gateway. dds: The database is an ApsaraDB for MongoDB database. other: The database is connected to DBS by using the IP address and port of the database.	rds
BackupSetDownloadDir	string	The server directory to which the backup set is downloaded.	*/test/test123
SourceEndpointIpPort	string	The endpoint that is used to connect to the database.	100...10:33204
CrossAliyunId	string	The unique ID (UID) of the Alibaba Cloud account to which the backup schedule belongs.	2xxx7778xxxxxxxxxx
DuplicationArchivePeriod	integer	The number of days after which the storage class of the backup data is changed to Archive.	365
BackupPlanId	string	The ID of the backup schedule.	dbstooi01eXXXX
EndTimestampForRestore	long	The end of the time range during which the database can be restored. The value is a timestamp.	1554560477000
BackupPlanStatus	string	The status of the backup schedule. Valid values: wait: The backup schedule is not configured. init: The backup schedule is not started and fails to pass the precheck. running: The backup schedule is running. stop: The backup schedule fails. pause: The backup schedule is paused. locked: The backup schedule is locked. check_pass: The backup schedule passes the precheck.	init
BackupSetDownloadFullDataFormat	string	The format in which the full backup set is downloaded. Native SQL CSV JSON	SQL
BackupRetentionPeriod	integer	The number of days for which the backup data is retained. Valid values: 0 to 1825.	365
OSSBucketRegion	string	The region in which the OSS bucket used to store backup files resides.	cn-hangzhou
SourceEndpointOracleSID	string	The system ID (SID) of the Oracle database.	test
BackupStorageType	string	The built-in storage type. Valid values: Empty: If this parameter is left empty, the system stores backup data in your OSS bucket. This is the default value. system: The system stores backup data in the built-in OSS bucket of DBS.	system
BackupMethod	string	The method that is used to generate the data backup file. Valid values: logical: logical backup physical: physical backup duplication: dump backup	logical
SourceEndpointRegion	string	The region in which the database that you want to back up resides.	cn-hangzhou
BackupPeriod	string	The day of each week when the full backup task runs. Valid values: Monday Tuesday Wednesday Thursday Friday Saturday Sunday	Monday
SourceEndpointDatabaseName	string	The name of the database.	test
BackupSetDownloadGatewayId	long	The ID of the backup gateway that is used to download the backup set.	123123
BackupPlanCreateTime	long	The timestamp that indicates when the backup schedule was created.	1582527713000
InstanceClass	string	The specifications of the backup schedule. Valid values: micro small medium large xlarge	micro
BackupSetDownloadTargetType	string	The type of the destination server to which the backup set is downloaded. NoteThe value is agent, which indicates a server on which a backup gateway is installed.	agent
DuplicationInfrequentAccessPeriod	integer	The number of days after which the storage class of the backup data is changed to Infrequent Access (IA).	180
BackupStartTime	string	The start time of the full backup task. Specify the time in the HH:mm format.	14:22
ErrMessage	string	The error message returned about the precheck.	can not connect to oracle instance orcl with user dbs
BackupObjects	string	The objects to be backed up.	\[ { \\"DBName\\":\\"Name of the database to be backed up\\", \\"SchemaName\\":\\"Name of the schema to be backed up\\", \\"TableIncludes\\":\[{ \\"TableName\\":\\"Name of the table to be backed up\\" }], \\"TableExcludes\\":\[{ \\"TableName\\":\\"Name of the table to be excluded during the backup\\" }] } ]
BeginTimestampForRestore	long	The beginning of the time range during which the database can be restored. Example: 1554560477000.	1554560477000
SourceEndpointInstanceID	string	The ID of the database instance.	test
OpenBackupSetAutoDownload	boolean	Indicates whether the automatic backup set download feature is enabled.	true
BackupPlanName	string	The name of the backup schedule.	dbstooi01e****
OSSBucketName	string	The name of the OSS bucket that is used to store backup files.	dbs-backup-1857XXXXX489
BackupGatewayId	long	The ID of the backup gateway.	827362187368736
SourceEndpointUserName	string	The account that is used to log on to the database.	test
BackupSetDownloadIncrementDataFormat	string	The format in which the incremental backup set is downloaded. Native SQL CSV JSON	SQL
EnableBackupLog	boolean	Indicates whether the incremental log backup feature is enabled. Valid values: true: The incremental log backup feature is enabled. false: The incremental log backup feature is disabled.	true
ResourceGroupId	string	The ID of the resource group.	rg-aekzecovzti****
DatabaseType	string	The database engine.	MySQL

Example

Normal return example

JSONFormat

{
  "HttpStatusCode": 200,
  "PageNum": 1,
  "RequestId": "4F1888AC-1138-4995-B9FE-D2734F61C058",
  "ErrCode": "Param.NotFound",
  "Success": true,
  "ErrMessage": "The specified parameter %s value is not valid.     ",
  "TotalPages": 4,
  "TotalElements": 100,
  "PageSize": 30,
  "Items": [
    {
      "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\\\\\":\\\\\"Name of the database to be backed up\\\\\", \\\\\"SchemaName\\\\\":\\\\\"Name of the schema to be backed up\\\\\", \\\\\"TableIncludes\\\\\":\\[{ \\\\\"TableName\\\\\":\\\\\"Name of the table to be backed up\\\\\" }], \\\\\"TableExcludes\\\\\":\\[{ \\\\\"TableName\\\\\":\\\\\"Name of the table to be excluded during the backup\\\\\" }] } ]\n",
      "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"
    }
  ]
}

Error codes

For a list of error codes, visit the API error center.