该接口用于查看一个DBS备份计划。
接口说明
请在使用本接口前,提前开通 OSS 服务,更多信息请参见对象存储 OSS。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
dbs:DescribeBackupPlanList | Read |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
BackupPlanId | string | 否 | 备份计划 ID,支持查询多个备份计划,英文逗号(,)分隔。 | dbstooi01exXXXX |
Region | string | 否 | DBS 地域,可通过调用 DescribeRegions 接口查看 DBS 支持地域。 | cn-hangzhou |
PageSize | integer | 否 | 每页的记录数,取值为 1~100。 说明
默认为 30。
| 30 |
PageNum | integer | 否 | 页码,大于等于 0 且不超过 Integer 的最大值,默认值为:0。 | 1 |
BackupPlanName | string | 否 | 备份计划名称。 | test123 |
BackupPlanStatus | string | 否 | 备份计划状态,取值:
| wait |
ClientToken | string | 否 | 用于保证请求的幂等性,防止重复提交请求。 | ASDASDASDSADASFCZXVZ |
ResourceGroupId | string | 否 | 资源组 ID。 | rg-aekzecovzti**** |
返回参数
示例
正常返回示例
JSON
格式
{
"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"
}
]
}
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
403 | Request.Forbidden | Have no Permissions | 当前操作未被授权,请联系主账号在RAM控制台进行授权后再执行操作 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||
---|---|---|---|---|
2023-03-28 | API 内部配置变更,不影响调用 | 看变更集 | ||
|