All Products
Search
Document Center

Database Backup:DescribeBackupPlanList

Last Updated:Dec 12, 2022

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.
Operateaccess levelResource typeconditional keywordAssociation operation
dbs:DescribeBackupPlanListList
  • DBS
    acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}
    without
without

Request parameters

ParameterTypeRequiredDescriptionExample
BackupPlanIdstringNo

The ID of the backup schedule. You can query multiple backup schedules. Separate multiple IDs with commas (,).

dbstooi01exXXXX
RegionstringNo

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
PageSizeintegerNo

The number of entries to return on each page. Valid values:

  • 30
  • 50
  • 100
NoteDefault value: 30.
30
PageNumintegerNo

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
BackupPlanNamestringNo

The name of the backup schedule.

test123
BackupPlanStatusstringNo

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
ClientTokenstringNo

The client token that is used to ensure the idempotence of the request.

ASDASDASDSADASFCZXVZ
ResourceGroupIdstringNo

The ID of the resource group.

rg-aekzecovzti****

Response parameters

ParameterTypeDescriptionExample
object
HttpStatusCodeinteger

The HTTP status code.

200
PageNuminteger

The page number of the returned page.

1
RequestIdstring

The ID of the request.

4F1888AC-1138-4995-B9FE-D2734F61C058
ErrCodestring

The error code returned if the request failed.

Param.NotFound
Successboolean

Indicates whether the request is successful.

true
ErrMessagestring

The error message returned if the request failed.

The specified parameter %s value is not valid.
TotalPagesinteger

The total number of returned pages.

4
TotalElementsinteger

The total number of backup schedules.

100
PageSizeinteger

The number of entries returned per page.

30
Itemsarray

The details of the backup schedules.

object

The return value.

CrossRoleNamestring

The name of the RAM role that is used to perform backups across Alibaba Cloud accounts.

test123
SourceEndpointInstanceTypestring

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
BackupSetDownloadDirstring

The server directory to which the backup set is downloaded.

*/test/test123
SourceEndpointIpPortstring

The endpoint that is used to connect to the database.

100.*.*.10:33204
CrossAliyunIdstring

The unique ID (UID) of the Alibaba Cloud account to which the backup schedule belongs.

2xxx7778xxxxxxxxxx
DuplicationArchivePeriodinteger

The number of days after which the storage class of the backup data is changed to Archive.

365
BackupPlanIdstring

The ID of the backup schedule.

dbstooi01eXXXX
EndTimestampForRestorelong

The end of the time range during which the database can be restored. The value is a timestamp.

1554560477000
BackupPlanStatusstring

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
BackupSetDownloadFullDataFormatstring

The format in which the full backup set is downloaded.

  • Native
  • SQL
  • CSV
  • JSON
SQL
BackupRetentionPeriodinteger

The number of days for which the backup data is retained. Valid values: 0 to 1825.

365
OSSBucketRegionstring

The region in which the OSS bucket used to store backup files resides.

cn-hangzhou
SourceEndpointOracleSIDstring

The system ID (SID) of the Oracle database.

test
BackupStorageTypestring

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
BackupMethodstring

The method that is used to generate the data backup file. Valid values:

  • logical: logical backup
  • physical: physical backup
  • duplication: dump backup
logical
SourceEndpointRegionstring

The region in which the database that you want to back up resides.

cn-hangzhou
BackupPeriodstring

The day of each week when the full backup task runs. Valid values:

  • Monday
  • Tuesday
  • Wednesday
  • Thursday
  • Friday
  • Saturday
  • Sunday
Monday
SourceEndpointDatabaseNamestring

The name of the database.

test
BackupSetDownloadGatewayIdlong

The ID of the backup gateway that is used to download the backup set.

123123
BackupPlanCreateTimelong

The timestamp that indicates when the backup schedule was created.

1582527713000
InstanceClassstring

The specifications of the backup schedule. Valid values:

  • micro
  • small
  • medium
  • large
  • xlarge
micro
BackupSetDownloadTargetTypestring

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
DuplicationInfrequentAccessPeriodinteger

The number of days after which the storage class of the backup data is changed to Infrequent Access (IA).

180
BackupStartTimestring

The start time of the full backup task. Specify the time in the HH:mm format.

14:22
ErrMessagestring

The error message returned about the precheck.

can not connect to oracle instance orcl with user dbs
BackupObjectsstring

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\\" }] } ]
BeginTimestampForRestorelong

The beginning of the time range during which the database can be restored. Example: 1554560477000.

1554560477000
SourceEndpointInstanceIDstring

The ID of the database instance.

test
OpenBackupSetAutoDownloadboolean

Indicates whether the automatic backup set download feature is enabled.

true
BackupPlanNamestring

The name of the backup schedule.

dbstooi01e****
OSSBucketNamestring

The name of the OSS bucket that is used to store backup files.

dbs-backup-1857XXXXX489
BackupGatewayIdlong

The ID of the backup gateway.

827362187368736
SourceEndpointUserNamestring

The account that is used to log on to the database.

test
BackupSetDownloadIncrementDataFormatstring

The format in which the incremental backup set is downloaded.

  • Native
  • SQL
  • CSV
  • JSON
SQL
EnableBackupLogboolean

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
ResourceGroupIdstring

The ID of the resource group.

rg-aekzecovzti****
DatabaseTypestring

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.