DescribeBackupPlanList - 查看备份计划 - 数据库备份 DBS

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

接口说明

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

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
dbs:DescribeBackupPlanList	get	BackupPlan acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}	无	无

请求参数

名称	类型	必填	描述	示例值
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：未配置 init：未启动（预检查失败） running：运行中 stop：失败 pause：暂停 locked：锁定中 check_pass：预检查通过	wait
ClientToken	string	否	用于保证请求的幂等性，防止重复提交请求。	ASDASDASDSADASFCZXVZ
ResourceGroupId	string	否	资源组 ID。	rg-aekzecovzti****

返回参数

名称	类型	描述	示例值
	object	返回参数详情如下。
HttpStatusCode	integer	HTTP 状态码。	200
PageNum	integer	页码。	1
RequestId	string	请求 ID。	4F1888AC-1138-4995-B9FE-D2734F61C058
ErrCode	string	错误码。	InvalidParameterValid
Success	boolean	是否成功。	true
ErrMessage	string	错误信息。	The specified parameter %s value is not valid.
TotalPages	integer	总页数。	4
TotalElements	integer	总备份计划数。	100
PageSize	integer	每页的记录数。	30
Items	array<object>	备份计划详情。
BackupPlanDetail	object	返回值。
CrossRoleName	string	跨阿里云账号备份的 RAM 角色名称。	test123
SourceEndpointInstanceType	string	数据库所在位置，返回值如下： rds ecs express：通过专线/VPN 网关/智能网关接入的数据库 agent：通过备份网关接入的数据库 dds：云 MongoDB other：通过 IP:Port 直连的数据库	rds
BackupSetDownloadDir	string	备份集下载服务器目录。	*/test/test123
SourceEndpointIpPort	string	数据库连接地址。	100...10:33204
CrossAliyunId	string	跨阿里云账号备份的 uid。	2xxx7778xxxxxxxxxx
DuplicationArchivePeriod	integer	转为归档冷备存储时间（天）。	365
BackupPlanId	string	备份计划 ID。	dbstooi01eXXXX
EndTimestampForRestore	long	数据库可恢复时间段的结束时间，格式为时间戳。	1554560477000
BackupPlanStatus	string	备份计划状态，返回值如下： wait：未配置 init：未启动（预检查失败） running：运行中 stop：失败 pause：暂停 locked：锁定中 check_pass：预检查通过	init
BackupSetDownloadFullDataFormat	string	备份集下载全量数据格式： Native SQL CSV JSON	SQL
BackupRetentionPeriod	integer	备份数据保留时间，返回值：0~1825（天）。	365
OSSBucketRegion	string	OSS Bucket 地域。	cn-hangzhou
SourceEndpointOracleSID	string	Oracle SID 名称。	test
BackupStorageType	string	内置存储类型，返回值如下：空（默认）：备份数据存储在用户 OSS 上。 system ：备份数据存储在 DBS 的内置 OSS 上。	system
BackupMethod	string	备份方式，返回值如下： logical：逻辑备份 physical：物理备份 duplication：转储备份	logical
SourceEndpointRegion	string	数据库地域。	cn-hangzhou
BackupPeriod	string	全量备份周期，返回值如下： Monday：周一 Tuesday：周二 Wednesday：周三 Thursday：周四 Friday：周五 Saturday：周六 Sunday：周日	Monday
SourceEndpointDatabaseName	string	数据库名称。	test
BackupSetDownloadGatewayId	long	备份集下载备份网关 ID。	123123
BackupPlanCreateTime	long	备份计划创建时间戳。	1582527713000
InstanceClass	string	规格，返回值如下： micro：入门型 small：低配型 medium：中配型 large：高配型 xlarge：高配型（无流量上限）	micro
BackupSetDownloadTargetType	string	备份集下载目标类型。说明唯一取值：agent，表示已安装备份网关。	agent
DuplicationInfrequentAccessPeriod	integer	转为低频访问存储时间（天）。	180
BackupStartTime	string	全量备份开始时间，格式为 HH:mm。	14:22
ErrMessage	string	预检查任务异常信息。	can not connect to oracle instance orcl with user dbs
BackupObjects	string	备份对象。	[ { \"DBName\":\"待备份库名\", \"SchemaName\":\"待备份 Schema 名\", \"TableIncludes\":[{ \"TableName\":\"待备份表表名\" }], \"TableExcludes\":[{ \"TableName\":\"待备份库名不需要备份表的表名\" }] } ]
BeginTimestampForRestore	long	可数据库恢复时间段的开始时间，返回值：1554560477000。	1554560477000
SourceEndpointInstanceID	string	数据库实例 ID。	test
OpenBackupSetAutoDownload	boolean	是否开启自动备份集下载功能。	true
BackupPlanName	string	备份计划名称。	dbstooi01e****
OSSBucketName	string	OSS Bucket 名称。	dbs-backup-1857XXXXX489
BackupGatewayId	long	备份网关 ID。	827362187368736
SourceEndpointUserName	string	数据库账号。	test
BackupSetDownloadIncrementDataFormat	string	备份集下载全量数据格式： Native SQL CSV JSON	SQL
EnableBackupLog	boolean	是否开启增量日志备份，返回值如下： true：开启 false：关闭	true
ResourceGroupId	string	资源组 ID。	rg-aekzecovzti****
DatabaseType	string	数据库类型。	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	错误码	错误信息	描述
403	Request.Forbidden	Have no Permissions	当前操作未被授权，请联系主账号在RAM控制台进行授权后再执行操作

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

变更历史

变更时间	变更内容概要	操作
2023-03-28	API 内部配置变更，不影响调用	查看变更详情