DescribeBackupPlanList - Data Management - Alibaba Cloud Documentation Center

Queries the details of one or more DBS backup plans.

Operation description

You must activate Object Storage Service (OSS) before you can use this API. 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. To query multiple backup plans, separate the IDs with commas (,).	dbstooi01exXXXX
Region	string	No	The region ID of the DBS instance. To view the supported regions, call the DescribeRegions operation.	cn-hangzhou
PageSize	integer	No	The number of entries to return on each page. Valid values: 1 to 100. Note Default value: 30.	30
PageNum	integer	No	The page number 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 plan.	test123
BackupPlanStatus	string	No	The status of the backup plan. Valid values: wait: The backup plan is not configured. init: The backup plan failed to be started because the precheck failed. running: The backup plan is running. stop: The backup plan failed. pause: The backup plan is paused. locked: The backup plan is locked. check_pass: The precheck passed.	wait
ClientToken	string	No	A 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 elements

Element	Type	Description	Example
	object	The details of the returned 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 returned per page.	30
Items	object
BackupPlanDetail	array<object>	The details of the backup plan.
	object	The return value.
CrossRoleName	string	The name of the Resource Access Management (RAM) role that is used for cross-account backup.	test123
SourceEndpointInstanceType	string	The location of the database. Valid values: rds ecs express: A database that is connected over a leased line, VPN Gateway, or Smart Access Gateway. agent: A database that is connected using a backup gateway. dds: A MongoDB instance. other: A database that is connected over the internet.	rds
BackupSetDownloadDir	string	The directory on the server where the backup set is downloaded.	*/test/test123
SourceEndpointIpPort	string	The database endpoint.	100...10:33204
CrossAliyunId	string	The UID of the Alibaba Cloud account that is used for cross-account backup.	2xxx7778xxxxxxxxxx
DuplicationArchivePeriod	integer	The number of days after which a backup set is converted to an archive backup. Unit: days.	365
BackupPlanId	string	The ID of the backup plan.	dbstooi01eXXXX
EndTimestampForRestore	integer	The end of the time range within which the database can be restored. This value is a UNIX timestamp.	1554560477000
BackupPlanStatus	string	The status of the backup plan. Valid values: wait: The backup plan is not configured. init: The backup plan failed to be started because the precheck failed. running: The backup plan is running. stop: The backup plan failed. pause: The backup plan is paused. locked: The backup plan is locked. check_pass: The precheck passed.	init
BackupSetDownloadFullDataFormat	string	The format of the full data in the downloaded backup set: Native SQL CSV JSON	SQL
BackupRetentionPeriod	integer	The retention period of the backup data. Valid values: 0 to 1825. Unit: days.	365
OSSBucketRegion	string	The region of the OSS bucket.	cn-hangzhou
SourceEndpointOracleSID	string	The Oracle system ID (SID).	test
BackupStorageType	string	The built-in storage type. Valid values: Empty (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: Dump backup	logical
SourceEndpointRegion	string	The region of the database.	cn-hangzhou
BackupPeriod	string	The full backup cycle. Valid values: Monday Tuesday Wednesday Thursday Friday Saturday Sunday	Monday
SourceEndpointDatabaseName	string	The name of the database.	test
BackupSetDownloadGatewayId	integer	The ID of the backup gateway that is used to download the backup set.	123123
BackupPlanCreateTime	integer	The timestamp that indicates when the backup plan was created.	1582527713000
InstanceClass	string	The instance specification. Valid values: micro: Micro small: Small medium: Medium large: Large xlarge: X-Large (no traffic limit)	micro
BackupSetDownloadTargetType	string	The destination type for downloading the backup set. Note The only valid value is agent, which indicates that a backup gateway is installed.	agent
DuplicationInfrequentAccessPeriod	integer	The number of days after which a backup set is converted to Infrequent Access (IA) storage. Unit: days.	180
BackupStartTime	string	The start time of the full backup. The time is in the HH:mm format.	14:22
ErrMessage	string	The error message returned for the precheck task.	can not connect to oracle instance orcl with user dbs
BackupObjects	string	The backup objects.	[ { \"DBName\":\"待备份库名\", \"SchemaName\":\"待备份 Schema 名\", \"TableIncludes\":[{ \"TableName\":\"待备份表表名\" }], \"TableExcludes\":[{ \"TableName\":\"待备份库名不需要备份表的表名\" }] } ]
BeginTimestampForRestore	integer	The beginning of the time range within which the database can be restored. This value is a UNIX timestamp.	1554560477000
SourceEndpointInstanceID	string	The ID of the database instance.	test
OpenBackupSetAutoDownload	boolean	Indicates whether the feature of automatically downloading 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 database account.	test
BackupSetDownloadIncrementDataFormat	string	The format of the full data downloaded from the backup set: Native SQL CSV JSON	SQL
EnableBackupLog	boolean	Indicates whether incremental log backup is enabled. Valid values: true: Enabled false: Disabled	true
ResourceGroupId	string	The ID of the resource group.	rg-aekzecovzti****
DatabaseType	string	The database type.	MySQL

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

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.