Query the list of backup plans
Operation description
Before using this interface, please activate the OSS service in advance. For more information, see Object Storage Service (OSS).
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- 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:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- 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.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| 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 schedule. You can query multiple backup schedule IDs. Separate multiple IDs with commas (,). | dbstooi01exXXXX |
| Region | string | No | DBS region, you can view the supported DBS regions by calling the DescribeRegions interface. | cn-hangzhou |
| PageSize | integer | No | Number of records per page, the value should be between 1 and 100. Note
The default is 30.
| 30 |
| PageNum | integer | No | Page number, must be greater than or equal to 0 and not exceed the maximum value of Integer. The default value is 0. | 1 |
| BackupPlanName | string | No | Backup plan name. | test123 |
| BackupPlanStatus | string | No | Backup plan status, the values are as follows:
| wait |
| ClientToken | string | No | Used to ensure the idempotence of the request, preventing duplicate submissions. | ASDASDASDSADASFCZXVZ |
| ResourceGroupId | string | No | Resource group ID. | rg-aekzecovzti**** |
Response parameters
Examples
Sample success responses
JSONformat
{
"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": "",
"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 |
|---|---|---|
| 403 | Request.Forbidden | Have no Permissions |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2023-03-28 | The internal configuration of the API is changed, but the call is not affected | View Change Details |