调用DescribeRestoreRangeInfo查询备份计划的可恢复时间段-数据管理 DMS-阿里云-数据管理 DMS-阿里云帮助中心

该接口用于查看一个备份计划可恢复时间段详情。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

dbs:DescribeRestoreRangeInfo

get

*BackupPlan

acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}

无

请求参数

名称	类型	必填	描述	示例值
BackupPlanId	string	是	备份计划 ID，可通过调用 DescribeBackupPlanList 接口获取该参数的值。	dbssl67c7mx****
BeginTimestampForRestore	integer	是	查询可恢复开始时间，可通过调用 DescribeBackupPlanList 接口获取该参数的值。	1646674092000
EndTimestampForRestore	integer	是	查询可恢复结束时间，可通过调用 DescribeBackupPlanList 接口获取该参数的值。	1646846814000
ClientToken	string	否	用于保证请求的幂等性，防止重复提交请求。	ETnLKlblzczshOTUbOCzxxxxxxx
RecentlyRestore	boolean	否	是否开启最近恢复。	true

返回参数

名称	类型	描述	示例值
	object	接口返回信息如下。
HttpStatusCode	integer	HTTP 状态码。	200
RequestId	string	请求 ID。	E2BD9DFC-6760-5F49-97C5-DA739E29****
ErrCode	string	错误码。	Param.NotFound
Success	boolean	请求是否成功，返回值如下： true：请求成功 false：请求失败	true
ErrMessage	string	错误信息。	The specified parameter %s value is not valid.
Items	object
DBSRecoverRange	array<object>	可恢复时间段信息。
	array<object>	具体详情记录。
EndTimestampForRestore	integer	可恢复结束时间戳。	1646760308000
SourceEndpointInstanceType	string	数据库所在位置。（已过时，请参考 BackupSourceInstanceType）	rds
RangeType	string	可恢复时间段类型，返回值如下： point：该时间段为全量备份离散时间点。 range：该时间段为连续备份时间段，可指定任意时间。	point
BeginTimestampForRestore	integer	可恢复开始时间戳。	1646760282000
SourceEndpointInstanceID	string	数据库实例 ID。（已过时，请参考 BackupSourceInstanceId）	rm-bp106x9tk2c91****
FullBackupList	object
FullBackupDetail	array<object>	当 RangeType 为 point 时，该字段展示这个时间段范围内所有的权利。备份点信息。
	object	具体详情如下。
EndTime	integer	全量备份结束时间，采用 UNIX 时间戳，单位为毫秒。	1646760308000
StartTime	integer	全量备份开始时间，采用 UNIX 时间戳，单位为毫秒。	1646760282000
BackupSetId	string	备份集 ID。	qecnsxkd****
BackupSourceInstanceType	string	备份源实例类型	rds
BackupSourceInstanceId	string	备份源实例 Id	rm-testxx
BackupSourceHost	string	备份源连接地址	127.0.0.1
BackupSourcePort	string	备份源连接端口	3306

示例

正常返回示例

JSON格式

{
  "HttpStatusCode": 200,
  "RequestId": "E2BD9DFC-6760-5F49-97C5-DA739E29****",
  "ErrCode": "Param.NotFound",
  "Success": true,
  "ErrMessage": "The specified parameter %s value is not valid. ",
  "Items": {
    "DBSRecoverRange": [
      {
        "EndTimestampForRestore": 1646760308000,
        "SourceEndpointInstanceType": "rds",
        "RangeType": "point",
        "BeginTimestampForRestore": 1646760282000,
        "SourceEndpointInstanceID": "rm-bp106x9tk2c91****",
        "FullBackupList": {
          "FullBackupDetail": [
            {
              "EndTime": 1646760308000,
              "StartTime": 1646760282000,
              "BackupSetId": "qecnsxkd****"
            }
          ]
        },
        "BackupSourceInstanceType": "rds",
        "BackupSourceInstanceId": "rm-testxx",
        "BackupSourceHost": "127.0.0.1",
        "BackupSourcePort": "3306"
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
403	Request.Forbidden	Have no Permissions	当前操作未被授权，请联系主账号在RAM控制台进行授权后再执行操作

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

变更历史

更多信息，参考变更详情。