调用DescribeBackupPlanList接口,查看一个DBS备份计划。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeBackupPlanList

系统规定参数,取值:DescribeBackupPlanList。

BackupPlanId String dbstooi01exXXXX

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

Region String cn-hangzhou

DBS地域,取值:

  • cn-hangzhou:公有云杭州
  • cn-shanghai:公有云上海
  • cn-qingdao:公有云青岛
  • cn-beijing:公有云北京
  • cn-shenzhen:公有云深圳
  • cn-hongkong:公有云中国香港
  • ap-southeat-1:公有云新加坡
  • cn-hangzhou-finance:金融云杭州
  • cn-shanghai-finance:金融云上海
  • cn-shenzhen-finance:金融云深圳
PageSize Integer 30

每页的记录数,取值:

  • 30
  • 50
  • 100

默认为30。

PageNum Integer 1

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

BackupPlanName String test23

备份计划名称。

BackupPlanStatus String wait

备份计划状态,取值:

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

地域ID,调用DescribeRegions接口查看DBS支持地域。

ClientToken String ASDASDASDSADASFCZXVZ

任意字符串,用于保证请求幂等性。

返回数据

名称 类型 示例值 描述
ErrCode String Param.NotFound

错误码。

ErrMessage String The specified parameter %s value is not valid.

错误信息。

HttpStatusCode Integer 200

HTTP状态码。

Items Array of BackupPlanDetail

备份计划详情。

BackupPlanDetail
BackupGatewayId Long 827362187368736

备份网关ID。

BackupMethod String logical

备份方式,取值:

  • logical:逻辑备份
  • physical:物理备份
  • duplication:转储备份
BackupObjects String [ { \"DBName\":\"待备份库名\", \"SchemaName\":\"待备份 Schema 名\", \"TableIncludes\":[{ \"TableName\":\"待备份表表名\" }], \"TableExcludes\":[{ \"TableName\":\"待备份库名不需要备份表的表名\" }] } ]

备份对象。

BackupPeriod String Monday

全量备份周期,取值:

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

备份计划创建时间戳。

BackupPlanId String dbstooi01eXXXX

备份计划ID。

BackupPlanName String dbstooi01eXXXX

备份计划名称。

BackupPlanStatus String init

备份计划状态,取值:

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

备份数据保留时间,取值:0-1825(天)。

BackupSetDownloadDir String */test/test123

备份集下载服务器目录。

BackupSetDownloadFullDataFormat String SQL

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

  • Native
  • SQL
  • CSV
  • JSON
BackupSetDownloadGatewayId Long 123123

备份集下载备份网关ID。

BackupSetDownloadIncrementDataFormat String SQL

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

  • Native
  • SQL
  • CSV
  • JSON
BackupSetDownloadTargetType String agent

备份集下载目标类型。

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

BackupStartTime String 14:22

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

BackupStorageType String simple

全量备份周期,取值:

  • simple (周期备份,和BackupPeriod、BackupStartTime配合使用)
  • manual(手动备份)
    说明 默认simple。
BeginTimestampForRestore Long 1554560477000

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

CrossAliyunId String 2xxx7778xxxxxxxxxx

跨阿里云账号备份的uid。

CrossRoleName String test123

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

DuplicationArchivePeriod Integer 365

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

DuplicationInfrequentAccessPeriod Integer 180

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

EnableBackupLog Boolean true

是否开启增量日志备份,取值:

  • true:开启
  • false:关闭
EndTimestampForRestore Long 1554560477000

可数据库恢复时间段的结束时间,取值:1554560477000。

ErrMessage String can not connect to oracle instance orcl with user dbs

预检查任务异常信息。

InstanceClass String micro

规格,取值:

  • micro
  • small
  • medium
  • large
OSSBucketName String dbs-backup-1857XXXXX489

OSS Bucket名称。

OSSBucketRegion String cn-hangzhou

OSS Bucket地域。

OpenBackupSetAutoDownload Boolean true

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

SourceEndpointDatabaseName String test

数据库名称。

SourceEndpointInstanceID String test

数据库实例ID。

SourceEndpointInstanceType String rds

数据库所在位置,取值:

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

数据库连接地址。

SourceEndpointOracleSID String test

Oracle SID名称。

SourceEndpointRegion String cn-hangzhou

数据库地域。

SourceEndpointUserName String test

数据库账号。

PageNum Integer 1

页码。

PageSize Integer 30

每页的记录数。

RequestId String 4F1888AC-1138-4995-B9FE-D2734F61C058

请求ID。

Success Boolean true

是否成功。

TotalElements Integer 100

总备份计划数。

TotalPages Integer 4

总页数。

示例

请求示例

http(s)://dbs-api.cn-hangzhou.aliyuncs.com/?Action=DescribeBackupPlanList
&<公共请求参数>

正常返回示例

XML 格式

<DescribeBackupPlanListReponse>
  <PageSize>30</PageSize>
  <RequestId>4F1888AC-1138-4995-B9FE-D2734F61C058</RequestId>
  <PageNum>0</PageNum>
  <HttpStatusCode>200</HttpStatusCode>
  <TotalElements>1</TotalElements>
  <Items>
        <BackupPlanDetail>
              <BackupPlanName>dbXXXXX7ltj</BackupPlanName>
              <BackupMethod>logical</BackupMethod>
              <BackupPlanCreateTime>1583000</BackupPlanCreateTime>
              <BackupPeriod>MONDAY</BackupPeriod>
              <BackupObjects>[     {         "DBName":"待备份库名",         "SchemaName":"待备份 Schema 名",         "TableIncludes":[{             "TableName":"待备份表表名"         }],         "TableExcludes":[{             "TableName":"待备份库名不需要备份表的表名"         }]     } ]</BackupObjects>
              <SourceEndpointInstanceID>rm-bp1p8XXXXXv8pxe</SourceEndpointInstanceID>
              <InstanceClass>medium</InstanceClass>
              <OSSBucketRegion>cn-hangzhou</OSSBucketRegion>
              <SourceEndpointRegion>cn-hangzhou</SourceEndpointRegion>
              <SourceEndpointIpPort>100.X.X.10:33204</SourceEndpointIpPort>
              <DuplicationArchivePeriod>365</DuplicationArchivePeriod>
              <OSSBucketName>dbs-backup-1857XXXXX489</OSSBucketName>
              <BackupPlanStatus>init</BackupPlanStatus>
              <BackupStartTime>14:22</BackupStartTime>
              <EnableBackupLog>true</EnableBackupLog>
              <BackupPlanId>dbXXXXXx7ltj</BackupPlanId>
              <BackupRetentionPeriod>730</BackupRetentionPeriod>
              <SourceEndpointInstanceType>rds</SourceEndpointInstanceType>
              <SourceEndpointUserName>test</SourceEndpointUserName>
              <DuplicationInfrequentAccessPeriod>180</DuplicationInfrequentAccessPeriod>
        </BackupPlanDetail>
  </Items>
  <TotalPages>1</TotalPages>
  <Success>true</Success>
</DescribeBackupPlanListReponse>

JSON 格式

{
	"PageSize": 30,
	"RequestId": "4F1888AC-1138-4995-B9FE-D2734F61C058",
	"PageNum": 0,
	"HttpStatusCode": 200,
	"TotalElements": 1,
	"Items": {
		"BackupPlanDetail": [
			{
				"BackupPlanName": "dbXXXXX7ltj",
				"BackupMethod": "logical",
				"BackupPlanCreateTime": 1583000,
				"BackupPeriod": "MONDAY",
				"BackupObjects": "[     {         \"DBName\":\"待备份库名\",         \"SchemaName\":\"待备份 Schema 名\",         \"TableIncludes\":[{             \"TableName\":\"待备份表表名\"         }],         \"TableExcludes\":[{             \"TableName\":\"待备份库名不需要备份表的表名\"         }]     } ]",
				"SourceEndpointInstanceID": "rm-bp1p8XXXXXv8pxe",
				"InstanceClass": "medium",
				"OSSBucketRegion": "cn-hangzhou",
				"SourceEndpointRegion": "cn-hangzhou",
				"SourceEndpointIpPort": "100.X.X.10:33204",
				"DuplicationArchivePeriod": 365,
				"OSSBucketName": "dbs-backup-1857XXXXX489",
				"BackupPlanStatus": "init",
				"BackupStartTime": "14:22",
				"EnableBackupLog": true,
				"BackupPlanId": "dbXXXXXx7ltj",
				"BackupRetentionPeriod": 730,
				"SourceEndpointInstanceType": "rds",
				"SourceEndpointUserName": "test",
				"DuplicationInfrequentAccessPeriod": 180
			}
		]
	},
	"TotalPages": 1,
	"Success": true
}

错误码

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