All Products
Search
Document Center

DescribeBackupPlanList

Last Updated: May 06, 2020

Description

You can call this operation to query a DBS backup schedule.

Request parameters

Parameter Type Required Description
Action String Yes The operation that you want to perform. Set the value to DescribeBackupPlanList.
BackupPlanId String No The ID of the backup schedule. Separate multiple IDs with commas (,).
Region String Yes The region of the DBS instance. Valid values:
  • cn-hangzhou: Alibaba Cloud of China (Hangzhou)
  • cn-shanghai: Alibaba Cloud of China (Shanghai)
  • cn-qingdao: Alibaba Cloud of China (Qingdao)
  • cn-beijing: Alibaba Cloud of China (Beijing)
  • cn-shenzhen: Alibaba Cloud of China (Shenzhen)
  • cn-hongkong: Alibaba Cloud of China (Hong Kong)
  • ap-southeat-1: Alibaba Cloud of Singapore
  • cn-hangzhou-finance: Finance Cloud of China (Hangzhou)
  • cn-shanghai-finance: Finance Cloud of China (Shanghai)
  • cn-shenzhen-finance: Finance Cloud of China (Shenzhen)
PageSize Integer No The number of entries to return on each page. Valid values: 30, 50, and 100. Default value: 30.
PageNum Integer No The number of the page to return. It must be greater than or equal to 0 and smaller than or equal to the maximum value of the Integer type. Default value: 0.

Response parameters

Parameter Type Description
Items List The details of the backup schedule. For more information, see the description of the BackupPlanDetail parameter.
TotalPages Integer The total number of pages returned.
PageSize Integer The number of entries returned per page.
PageNum Integer The number of the page returned.
TotalElements Long The total number of backup schedules returned.

BackupPlanDetail

Parameter Type Description
BackupPlanId String The ID of the backup schedule.
SourceEndpointInstanceType String The location of the database. Valid values:
  • rds
  • ecs
  • express: for databases connected to Alibaba Cloud through Express Connect, VPN Gateway, or Smart Access Gateway.
  • agent: for databases connected to Alibaba Cloud through a backup gateway.
  • dds: for ApsaraDB for MongoDB databases.
  • other: for databases connected to Alibaba Cloud through IP addresses and port numbers.
SourceEndpointRegion String The region of the database.
SourceEndpointInstanceID String The ID of the database instance.
SourceEndpointIpPort String The connection endpoint of the database.
SourceEndpointDatabaseName String The name of the database.
SourceEndpointUserName String The username for logging on to the database.
BackupObjects String The objects that were backed up.
BackupGatewayId Long The ID of the backup gateway.
OSSBucketRegion String The region of the OSS bucket.
OSSBucketName String The name of the OSS bucket.
BackupPeriod String The day of each week when the full backup task runs. Valid values:
  • Monday
  • Tuesday
  • Wednesday
  • Thursday
  • Friday
  • Saturday
  • Sunday
BackupStartTime String The start time of the full backup task. Specify the time in the HH:mm format. Example: 14:22.
EnableBackupLog Boolean Indicates whether incremental log backup was enabled. Valid values:
  • True
  • False
BackupRetentionPeriod Integer The number of days during which the backup data is retained. Valid values: 0 to 1825.
DuplicationInfrequentAccessPeriod Integer The number of days after which the storage class of the backup data is changed to IA.
DuplicationArchivePeriod Integer The number of days after which the storage class of the backup data is changed to Archive.
BackupPlanName String The name of the backup schedule.
SourceEndpointOracleSID String The system ID (SID) of the Oracle database.
InstanceClass String The type of the DBS instance. Valid values:
  • micro
  • small
  • medium
  • large
BackupMethod String The backup method that was used. Valid values:
  • logical
  • physical
  • duplication
BackupPlanCreateTime Long The time when the backup schedule was created. Example: 1554560477000.
BackupPlanStatus String The status of the backup schedule. Valid values:
  • wait: The backup schedule was not configured.
  • init: The backup schedule was not started or did not pass the precheck.
  • running: The backup schedule was running.
  • stop: The backup schedule failed.
  • pause: The backup schedule was stopped.
  • locked: The backup schedule was locked.
  • check_pass: The backup schedule passed the precheck.
BeginTimestampForRestore Long The beginning of the time range to restore the database. Example: 1554560477000.
EndTimestampForRestore Long The end of the time range to restore the database. Example: 1554560477000.

Error codes

Error code Error message Description
BackupPlanNotDescribe Backup Plan not Describe. The error message returned because the backup schedule cannot be queried.