Queries backup schedules.
Operation Description
Before you call this operation, activate Object Storage Service (OSS). For more information, see What is OSS?
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:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resources
is 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 | Association operation |
---|---|---|---|---|
dbs:DescribeBackupPlanList | List |
|
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
BackupPlanId | string | No | The ID of the backup schedule. You can query multiple backup schedules. Separate multiple IDs with commas (,). | dbstooi01exXXXX |
Region | string | No | The region in which Database Backup (DBS) is activated. You can call the DescribeRegions operation to query the regions in which DBS is supported. | cn-hangzhou |
PageSize | integer | No | The number of entries to return on each page. Valid values:
NoteDefault value: 30. | 30 |
PageNum | integer | No | The number of the page 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 schedule. | test123 |
BackupPlanStatus | string | No | The status of the backup schedule. Valid values:
| wait |
ClientToken | string | No | The 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 parameters
Examples
Sample success responses
JSON
format
{
"HttpStatusCode": 200,
"PageNum": 1,
"RequestId": "4F1888AC-1138-4995-B9FE-D2734F61C058",
"ErrCode": "Param.NotFound",
"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\\\\\":\\\\\"Name of the database to be backed up\\\\\", \\\\\"SchemaName\\\\\":\\\\\"Name of the schema to be backed up\\\\\", \\\\\"TableIncludes\\\\\":\\[{ \\\\\"TableName\\\\\":\\\\\"Name of the table to be backed up\\\\\" }], \\\\\"TableExcludes\\\\\":\\[{ \\\\\"TableName\\\\\":\\\\\"Name of the table to be excluded during the backup\\\\\" }] } ]\n",
"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
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation |
---|