DescribeBackupPlanList-阿里云帮助中心

Queries a DBS backup plan.

Operation description

Ensure Object Storage Service (OSS) is enabled before you use this operation. For more information, see Object Storage Service.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dbs:DescribeBackupPlanList

get

*BackupPlan

acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}

None

Request parameters

Parameter	Type	Required	Description	Example
BackupPlanId	string	No	The ID of the backup plan. You can specify multiple backup plan IDs, separated by commas.	dbstooi01exXXXX
Region	string	No	The ID of the region where the backup plan is located. You can call the DescribeRegions operation to query the list of supported regions.	cn-hangzhou
PageSize	integer	No	The number of entries to return on each page. Valid values: 1 to 100. Note The default value is 30.	30
PageNum	integer	No	The page number to return. The value must be an integer that is greater than or equal to 0. The default value is 0.	1
BackupPlanName	string	No	The name of the backup plan.	test123
BackupPlanStatus	string	No	The status of the backup plan. Valid values: wait: The backup plan is not configured. init: The backup plan is not started because a precheck failed. running: The backup plan is running. stop: The backup plan has failed. pause: The backup plan is paused. locked: The backup plan is locked. check_pass: The precheck is passed.	wait
ClientToken	string	No	A client-generated token that ensures the idempotence of the request.	ASDASDASDSADASFCZXVZ
ResourceGroupId	string	No	The ID of the resource group.	rg-aekzecovzti****
ShowStorageStrategyInfo	boolean	No	Specifies whether to return information about the storage strategy. Default value: false.	false
ShowBackupStrategyInfo	boolean	No	Specifies whether to return information about the backup strategy. Default value: false.	false
ShowRecoverTimeRange	boolean	No	Specifies whether to return the recovery time range. Default value: false.	false
BackupMethod	string	No	The backup method.	logical

Response elements

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	The name of the RAM role for cross-account backups.	test123
SourceEndpointInstanceType	string	The type of the source endpoint. Valid values: rds ecs express: A database connected over an Express Connect circuit, a VPN Gateway, or a Smart Access Gateway instance. agent: A database connected by a backup gateway. dds: An ApsaraDB for MongoDB instance. other: A database connected by an IP address and a port number.	rds
BackupSetDownloadDir	string	The server directory for downloaded backup sets.	*/test/test123
SourceEndpointIpPort	string	The endpoint of the source database.	100...10:33204
CrossAliyunId	string	The user ID for cross-account backups.	2xxx7778xxxxxxxxxx
DuplicationArchivePeriod	integer	The number of days after which a duplicate backup is converted to archive storage.	365
BackupPlanId	string	The ID of the backup plan.	dbstooi01eXXXX
EndTimestampForRestore	integer	The end of the restorable time period. This value is a UNIX timestamp in milliseconds.	1554560477000
BackupPlanStatus	string	The status of the backup plan. Valid values: wait: The plan is not configured. init: The plan has not started because a precheck failed. running: The plan is running. stop: The plan failed. pause: The plan is paused. locked: The plan is locked. check_pass: The precheck passed.	init
BackupSetDownloadFullDataFormat	string	The data format for downloading full backup sets. Valid values: Native SQL CSV JSON	SQL
BackupRetentionPeriod	integer	The backup retention period, in days. Valid values: 0 to 1825.	365
OSSBucketRegion	string	The region of the OSS bucket.	cn-hangzhou
SourceEndpointOracleSID	string	The Oracle system ID (SID).	test
BackupStorageType	string	The storage type of the backup data. Valid values: Empty string (default): The backup data is stored in your OSS bucket. system: The backup data is stored in the built-in OSS bucket of DBS.	system
BackupMethod	string	The backup method. Valid values: logical: Logical backup physical: Physical backup duplication: Duplicate backup	logical
SourceEndpointRegion	string	The region of the source database.	cn-hangzhou
BackupPeriod	string	The day of the week for full backups. Valid values: Monday Tuesday Wednesday Thursday Friday Saturday Sunday	Monday
SourceEndpointDatabaseName	string	The name of the source database.	test
BackupSetDownloadGatewayId	integer	The ID of the backup gateway used to download the backup set.	123123
BackupPlanCreateTime	integer	The creation time of the backup plan. This value is a UNIX timestamp in milliseconds.	1582527713000
InstanceClass	string	The instance class. Valid values: micro: Entry-level small: Low-spec medium: Medium-spec large: High-spec xlarge: High-spec (no traffic limit)	micro
BackupSetDownloadTargetType	string	The target type for backup set downloads. Note The only valid value is agent, which indicates that a backup gateway is installed.	agent
DuplicationInfrequentAccessPeriod	integer	The number of days after which backup data is converted to Infrequent Access storage.	180
BackupStartTime	string	The start time for full backups. The time is in the HH:mm format.	14:22
ErrMessage	string	The error message returned by the precheck task.	can not connect to oracle instance orcl with user dbs
BackupObjects	string	The backup objects, specified in a JSON string.	[ { \"DBName\":\"待备份库名\", \"SchemaName\":\"待备份 Schema 名\", \"TableIncludes\":[{ \"TableName\":\"待备份表表名\" }], \"TableExcludes\":[{ \"TableName\":\"待备份库名不需要备份表的表名\" }] } ]
BeginTimestampForRestore	integer	The beginning of the restorable time period. This value is a UNIX timestamp in milliseconds.	1554560477000
SourceEndpointInstanceID	string	The ID of the source database instance.	test
OpenBackupSetAutoDownload	boolean	Indicates whether automatic download of backup sets is enabled.	true
BackupPlanName	string	The name of the backup plan.	dbstooi01e****
OSSBucketName	string	The name of the OSS bucket.	dbs-backup-1857XXXXX489
BackupGatewayId	integer	The ID of the backup gateway.	827362187368736
SourceEndpointUserName	string	The username of the source database account.	test
BackupSetDownloadIncrementDataFormat	string	The data format for downloading incremental backup sets. Valid values: Native SQL CSV JSON	SQL
EnableBackupLog	boolean	Indicates whether log backup is enabled. Valid values: true: Enabled false: Disabled	true
ResourceGroupId	string	The ID of the resource group.	rg-aekzecovzti****
DatabaseType	string	The type of the source database.	MySQL
BackupPlanRegion	string	The region of the backup plan.	cn-beijing
SourceEndpointHost	string	The source endpoint address.	127.0.0.1
InstanceChargeType	string	The billing method of the backup plan instance.	PREPAY
InstanceExpiredTimestamp	integer	The expiration time of the backup plan instance. This value is a UNIX timestamp in milliseconds.	1764051253000
SourceEndpointEnableSsl	string	Indicates whether SSL encryption is enabled for the source database.	true
StorageEncryptMethod	string	The encryption method for the backup storage.	encrypted
SourceEndpointPort	string	The port number of the source database.	3306
IncrementBackupRetentionPeriod	string	The retention period for incremental backups, in days.	365
IncrementDuplicationInfrequentAccessPeriod	string	The number of days after which incremental backups are converted to Infrequent Access storage.	365
IncrementDuplicationArchivePeriod	string	The number of days after which incremental backups are converted to archive storage.	365
LogBackupRetentionPeriod	string	The retention period for log backups, in days.	365
LogDuplicationInfrequentAccessPeriod	string	The number of days after which log backups are converted to Infrequent Access storage.	365
LogDuplicationArchivePeriod	string	The number of days after which log backups are converted to archive storage.	365
BackupGatewayIdentifier	string	The unique ID of the backup gateway.	TESTGATEWAY
EnableMysqlPhysicalBackupBinLog	boolean	Indicates whether log backup is enabled for MySQL physical backups.	false

Examples

Success response

JSON format

{
  "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
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
403	Request.Forbidden	Have no Permissions

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.