文档

DescribeBackupPlanList - 查看备份计划

该接口用于查看一个DBS备份计划。

接口说明

请在使用本接口前,提前开通 OSS 服务,更多信息请参见对象存储 OSS

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
dbs:DescribeBackupPlanListRead
  • BackupPlan
    acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}

请求参数

名称类型必填描述示例值
BackupPlanIdstring

备份计划 ID,支持查询多个备份计划,英文逗号(,)分隔。

dbstooi01exXXXX
Regionstring

DBS 地域,可通过调用 DescribeRegions 接口查看 DBS 支持地域。

cn-hangzhou
PageSizeinteger

每页的记录数,取值为 1~100。

说明 默认为 30
30
PageNuminteger

页码,大于等于 0 且不超过 Integer 的最大值,默认值为:0。

1
BackupPlanNamestring

备份计划名称。

test123
BackupPlanStatusstring

备份计划状态,取值:

  • wait:未配置
  • init:未启动(预检查失败)
  • running:运行中
  • stop:失败
  • pause:暂停
  • locked:锁定中
  • check_pass:预检查通过
wait
ClientTokenstring

用于保证请求的幂等性,防止重复提交请求。

ASDASDASDSADASFCZXVZ
ResourceGroupIdstring

资源组 ID。

rg-aekzecovzti****

返回参数

名称类型描述示例值
object

返回参数详情如下。

HttpStatusCodeinteger

HTTP 状态码。

200
PageNuminteger

页码。

1
RequestIdstring

请求 ID。

4F1888AC-1138-4995-B9FE-D2734F61C058
ErrCodestring

错误码。

InvalidParameterValid
Successboolean

是否成功。

true
ErrMessagestring

错误信息。

The specified parameter %s value is not valid.
TotalPagesinteger

总页数。

4
TotalElementsinteger

总备份计划数。

100
PageSizeinteger

每页的记录数。

30
Itemsobject []

备份计划详情。

CrossRoleNamestring

跨阿里云账号备份的 RAM 角色名称。

test123
SourceEndpointInstanceTypestring

数据库所在位置,返回值如下:

  • rds
  • ecs
  • express:通过专线/VPN 网关/智能网关接入的数据库
  • agent:通过备份网关接入的数据库
  • dds:云 MongoDB
  • other:通过 IP:Port 直连的数据库
rds
BackupSetDownloadDirstring

备份集下载服务器目录。

*/test/test123
SourceEndpointIpPortstring

数据库连接地址。

100.*.*.10:33204
CrossAliyunIdstring

跨阿里云账号备份的 uid。

2xxx7778xxxxxxxxxx
DuplicationArchivePeriodinteger

转为归档冷备存储时间(天)。

365
BackupPlanIdstring

备份计划 ID。

dbstooi01eXXXX
EndTimestampForRestorelong

数据库可恢复时间段的结束时间,格式为时间戳。

1554560477000
BackupPlanStatusstring

备份计划状态,返回值如下:

  • wait:未配置
  • init:未启动(预检查失败)
  • running:运行中
  • stop:失败
  • pause:暂停
  • locked:锁定中
  • check_pass:预检查通过
init
BackupSetDownloadFullDataFormatstring

备份集下载全量数据格式:

  • Native
  • SQL
  • CSV
  • JSON
SQL
BackupRetentionPeriodinteger

备份数据保留时间,返回值:0~1825(天)。

365
OSSBucketRegionstring

OSS Bucket 地域。

cn-hangzhou
SourceEndpointOracleSIDstring

Oracle SID 名称。

test
BackupStorageTypestring

内置存储类型,返回值如下:

  • 空(默认):备份数据存储在用户 OSS 上。
  • system :备份数据存储在 DBS 的内置 OSS 上。
system
BackupMethodstring

备份方式,返回值如下:

  • logical:逻辑备份
  • physical:物理备份
  • duplication:转储备份
logical
SourceEndpointRegionstring

数据库地域。

cn-hangzhou
BackupPeriodstring

全量备份周期,返回值如下:

  • Monday:周一
  • Tuesday:周二
  • Wednesday:周三
  • Thursday:周四
  • Friday:周五
  • Saturday:周六
  • Sunday:周日
Monday
SourceEndpointDatabaseNamestring

数据库名称。

test
BackupSetDownloadGatewayIdlong

备份集下载备份网关 ID。

123123
BackupPlanCreateTimelong

备份计划创建时间戳。

1582527713000
InstanceClassstring

规格,返回值如下:

  • micro:入门型
  • small:低配型
  • medium:中配型
  • large:高配型
  • xlarge:高配型(无流量上限)
micro
BackupSetDownloadTargetTypestring

备份集下载目标类型。

说明 唯一取值:agent,表示已安装备份网关。
agent
DuplicationInfrequentAccessPeriodinteger

转为低频访问存储时间(天)。

180
BackupStartTimestring

全量备份开始时间,格式为 HH:mm。

14:22
ErrMessagestring

预检查任务异常信息。

can not connect to oracle instance orcl with user dbs
BackupObjectsstring

备份对象。

[ { \"DBName\":\"待备份库名\", \"SchemaName\":\"待备份 Schema 名\", \"TableIncludes\":[{ \"TableName\":\"待备份表表名\" }], \"TableExcludes\":[{ \"TableName\":\"待备份库名不需要备份表的表名\" }] } ]
BeginTimestampForRestorelong

可数据库恢复时间段的开始时间,返回值:1554560477000。

1554560477000
SourceEndpointInstanceIDstring

数据库实例 ID。

test
OpenBackupSetAutoDownloadboolean

是否开启自动备份集下载功能。

true
BackupPlanNamestring

备份计划名称。

dbstooi01e****
OSSBucketNamestring

OSS Bucket 名称。

dbs-backup-1857XXXXX489
BackupGatewayIdlong

备份网关 ID。

827362187368736
SourceEndpointUserNamestring

数据库账号。

test
BackupSetDownloadIncrementDataFormatstring

备份集下载全量数据格式:

  • Native
  • SQL
  • CSV
  • JSON
SQL
EnableBackupLogboolean

是否开启增量日志备份,返回值如下:

  • true:开启
  • false:关闭
true
ResourceGroupIdstring

资源组 ID。

rg-aekzecovzti****
DatabaseTypestring

数据库类型。

MySQL

示例

正常返回示例

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错误码错误信息描述
403Request.ForbiddenHave no Permissions当前操作未被授权,请联系主账号在RAM控制台进行授权后再执行操作

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-03-28API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
  • 本页导读 (1)