Call DescribeBackupPlanList to view a DBS backup schedule.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeBackupPlanList

The parameter specified by the system. Value: DescribeBackupPlanList.

BackupPlanId String No dbstooi01exXXXX

The ID of the backup plan. Separate multiple backup plans with commas (,).

Region String No cn-hangzhou

The DBS region. Valid values:

  • cn-hangzhou: Alibaba Cloud Hangzhou
  • cn-shanghai: Alibaba Cloud Shanghai
  • cn-qingdao: Alibaba Cloud Qingdao
  • cn-beijing: Alibaba Cloud Beijing
  • cn-shenzhen: Alibaba Cloud Shenzhen
  • cn-hongkong: Public Cloud China (Hong Kong)
  • ap-southeat-1: public cloud Singapore
  • cn-hangzhou-finance: finance cloud (Hangzhou)
  • cn-shanghai-finance: finance cloud of Shanghai
  • cn-shenzhen-finance: finance cloud Shenzhen
PageSize Integer Optional 30

The number of records on each page. Valid values:

  • 30
  • 50
  • 100

Default value: 30.

PageNum Integer Optional 1

The number of the page to return. Valid values: any non-zero positive Integer. Default value: 0.

BackupPlanName String No test23

The name of the backup plan.

BackupPlanStatus String No wait

The status of the backup plan. Valid values:

  • wait: Not configured
  • init: not started (pre-check failed)
  • running: The check task is running.
  • stop: Failed
  • pause
  • locked: locked
  • check_pass: Pre-Check passed.
RegionId String No cn-hangzhou

Region ID, call DescribeRegions to view the regions supported by DBS.

ClientToken String No ASDASDASDSADASFCZXVZ

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

Response parameters

Parameter Type Example Description
ErrCode String Param.NotFound

The error code.

ErrMessage String The specified parameter %s value is not valid.

The error message.

HttpStatusCode Integer 200

The HTTP status code.

Items Array of BackupPlanDetail

The details of the backup plan.

BackupPlanDetail
BackupGatewayId Long 827362187368736

The ID of the backup gateway.

BackupMethod String logical

The method to use for backup. Valid values:

  • logical
  • physical
  • duplication
BackupObjects String [{"DBName": "The name of the database to be backed up", "SchemaName": "The name of the Schema to be backed up", "tableinclude":[{"TableName": "The name of the table to be backed up" }], "TableExcludes":[{"TableName": "Name of the database to be backed up" name of a table that does not need to be backed up " }] } ]

The backup object.

BackupPeriod String Monday

The cycle of full Backup. Valid values:

  • Monday
  • Tuesday
  • Wednesday
  • Thursday
  • Friday
  • Saturday
  • Sunday
BackupPlanCreateTime Long 1582527713000

The timestamp when the backup plan was created.

BackupPlanId String dbstooi01eXXXX

The ID of the backup plan.

BackupPlanName String dbstooi01eXXXX

The name of the backup plan.

BackupPlanStatus String init

The status of the backup plan. Valid values:

  • wait: Not configured
  • init: not started (pre-check failed)
  • running: The check task is running.
  • stop: Failed
  • pause
  • locked: locked
  • check_pass: Pre-Check passed.
BackupRetentionPeriod Integer 365

The retention period of backup data. Valid value: 0 to 1825.

BackupSetDownloadDir String */test/test123

The Directory of the backup set download server.

BackupSetDownloadFullDataFormat String SQL

Backup set download full data format:

  • Native
  • SQL
  • CSV
  • JSON
BackupSetDownloadGatewayId Long 123123

Backup set download backup gateway ID.

BackupSetDownloadIncrementDataFormat String SQL

Backup set download full data format:

  • Native
  • SQL
  • CSV
  • JSON
BackupSetDownloadTargetType String agent

The type of the target backup set.

Unique Value: agent, indicating that the backup gateway has been installed.

BackupStartTime String 14:22

The start time of full Backup. The format is HH:mm.

BackupStorageType String simple

The cycle of full Backup. Valid values:

  • simple (periodic backup that works with backuptopic and BackupStartTime)
  • manual
    Note The default value is simple.
BeginTimestampForRestore Long 1554560477000

The start time of the database recovery period. Valid value: 1554560477000.

CrossAliyunId String 2xxx7778xxxxxxxxxx

The uid of the backup file.

CrossRoleName String test123

The name of the RAM role used for cross-account backup.

DuplicationArchivePeriod Integer 365

Convert the storage period to archive (days).

DuplicationInfrequentAccessPeriod Integer 180

Converted to low-frequency access storage time (days).

EnableBackupLog Boolean true

Indicates whether to enable incremental backup. Valid values:

  • true
  • false
EndTimestampForRestore Long 1554560477000

The end time of the database recovery period. Valid value: 1554560477000.

ErrMessage String can not connect to oracle instance orcl with user dbs

The pre-check task exception information.

InstanceClass String micro

The specifications. Values:

  • micro
  • small
  • medium
  • large
OSSBucketName String dbs-backup-1857XXXXX489

The name of an OSS bucket.

OSSBucketRegion String cn-hangzhou

The region of the OSS Bucket.

OpenBackupSetAutoDownload Boolean true

Indicates whether to enable automatic backup set download.

SourceEndpointDatabaseName String test

The name of the RDS database.

SourceEndpointInstanceID String test

The ID of the ApsaraDB RDS instance to query.

SourceEndpointInstanceType String rds

The location of the database. Valid values:

  • rds
  • ecs
  • express: a database connected over express connect, VPN Gateway, or smart gateway.
  • agent: The database connected through the backup Gateway
  • dds: apsaradb for MongoDB
  • other: the database is directly connected through IP Address: Port.
SourceEndpointIpPort String 100.*. *.10:33204

The endpoint used to connect to the database.

SourceEndpointOracleSID String test

The SID of the Oracle instance.

SourceEndpointRegion String cn-hangzhou

The region of the database.

SourceEndpointUserName String test

The database account.

PageNum Integer 1

The page number of the page to be returned.

PageSize Integer 30

The number of records per page.

RequestId String 4F1888AC-1138-4995-B9FE-D2734F61C058

The ID of the request.

Success Boolean true

Indicates whether the request succeeded.

TotalElements Integer 100

The total number of backup plans.

TotalPages Integer 4

The total number of returned pages.

Examples

Sample requests

http(s)://dbs-api.cn-hangzhou.aliyuncs.com/? Action=DescribeBackupPlanList
&<Common request parameters>

Sample success responses

XML format

<DescribeBackupPlanListReponse>
  <PageSize>30</PageSize>
  <RequestId>4F1888AC-1138-4995-B9FE-D2734F61C058</RequestId>
  <PageNum>0</PageNum>
  <HttpStatusCode>200</HttpStatusCode>
  <TotalElements>1</TotalElements>
  <Items>
        <BackupPlanDetail>
              <BackupPlanName>dbXXXXX7ltj</BackupPlanName>
              <BackupMethod>logical</BackupMethod>
              <BackupPlanCreateTime>1583000</BackupPlanCreateTime>
              <BackupPeriod>MONDAY</BackupPeriod>
              <BackupObjects>[ {"DBName":"The name of the database to be backed up", "SchemaName":"The name of the Schema to be backed up", "TableExcludes":[{"TableName":"The name of the table to be backed up" }], "TableExcludes":[{"TableName":"Database to be backed up" } ]</backupods>: The name of a table that does not need to be backed up " }]
              <SourceEndpointInstanceID>rm-bp1p8XXXXXv8pxe</SourceEndpointInstanceID>
              <InstanceClass>medium</InstanceClass>
              <OSSBucketRegion>cn-hangzhou</OSSBucketRegion>
              <SourceEndpointRegion>cn-hangzhou</SourceEndpointRegion>
              <SourceEndpointIpPort>100.X.X.10:33204</SourceEndpointIpPort>
              <DuplicationArchivePeriod>365</DuplicationArchivePeriod>
              <OSSBucketName>dbs-backup-1857XXXXX489</OSSBucketName>
              <BackupPlanStatus>init</BackupPlanStatus>
              <BackupStartTime>14:22</BackupStartTime>
              <EnableBackupLog>true</EnableBackupLog>
              <BackupPlanId>dbXXXXXx7ltj</BackupPlanId>
              <BackupRetentionPeriod>730</BackupRetentionPeriod>
              <SourceEndpointInstanceType>rds</SourceEndpointInstanceType>
              <SourceEndpointUserName>test</SourceEndpointUserName>
              <DuplicationInfrequentAccessPeriod>180</DuplicationInfrequentAccessPeriod>
        </BackupPlanDetail>
  </Items>
  <TotalPages>1</TotalPages>
  <Success>true</Success>
</DescribeBackupPlanListReponse>

JSON format

{
	"PageSize": 30,
	"RequestId": "4F1888AC-1138-4995-B9FE-D2734F61C058",
	"PageNum": 0,
	"HttpStatusCode": 200,
	"TotalElements": 1,
	"Items": {
		"BackupPlanDetail": [
			{
				"BackupPlanName": "dbXXXXX7ltj",
				"BackupMethod": "logical",
				"BackupPlanCreateTime": 1583000,
				"BackupPeriod": "MONDAY",
				"BackupObjects": "[ {" DBName ": " The name of the database to be backed up "," SchemaName ": " The name of the Schema to be backed up "," TableIncludes ":[{" TableName ": " The name of the table to be backed up " }]," TableExcludes ":[{" TableName ": " The name of the database to be backed up " }] }",
				"SourceEndpointInstanceID": "rm-bp1p8XXXXXv8pxe",
				"InstanceClass": "medium",
				"OSSBucketRegion": "cn-hangzhou",
				"SourceEndpointRegion": "cn-hangzhou",
				"SourceEndpointIpPort": "100.X.X.10:33204",
				"DuplicationArchivePeriod": 365,
				"OSSBucketName": "dbs-backup-1857XXXXX489",
				"BackupPlanStatus": "init",
				"BackupStartTime": "14:22",
				"EnableBackupLog": true,
				"BackupPlanId": "dbXXXXXx7ltj",
				"BackupRetentionPeriod": 730,
				"SourceEndpointInstanceType": "rds",
				"SourceEndpointUserName": "test",
				"DuplicationInfrequentAccessPeriod": 180
			}
		]
	},
	"TotalPages": 1,
	"Success": true
}

Error codes

For a list of error codes, visit the API Error Center.