DescribeRestoreTaskList - 查看恢复任务列表

调用DescribeRestoreTaskList接口,查看DBS恢复任务列表。

调试

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

调试

授权信息

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

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

    请求参数

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

    备份计划ID。

    dbs1hvb0wwwXXXXX
    RestoreTaskIdstring

    恢复任务ID,支持多个查询,逗号分隔,您可以调用CreateRestoreTask接口获取该参数。

    说明本参数与备份计划(BackupPlanId)参数为二选一,同时填入时会导致报错。
    s102h7rf5anq
    PageSizeinteger

    每页的记录数,取值:

    • 30
    • 50
    • 100
    说明默认为30。
    30
    PageNuminteger

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

    1
    ClientTokenstring

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

    ETnLKlblzczshOTUbOCzxxxxxxx
    StartTimestampLong

    开始备份时间。

    1570701361528
    EndTimestampLong

    结束备份时间。

    1570701361528

    返回参数

    名称类型描述示例值
    object
    HttpStatusCodeinteger

    HTTP状态码。

    200
    PageNuminteger

    页码。

    1
    RequestIdstring

    请求ID。

    9C397502-B4F2-4E22-AD97-C81F0049F3F3
    ErrCodestring

    错误码。

    Param.NotFound
    Successboolean

    是否成功。

    true
    ErrMessagestring

    错误信息。

    The specified parameter %s value is not valid.
    TotalPagesinteger

    总页数。

    1
    TotalElementsinteger

    总恢复任务数。

    1
    PageSizeinteger

    每页的记录数。

    30
    Itemsarray

    备份计划详情。

    object
    RestoreStatusstring

    恢复任务状态,取值:

    • init:未启动或预检查失败
    • running:运行中
    • stop:失败
    • pause:暂停
    • check_pass:预检查通过
    running
    FullStruAfterRestoreProgressinteger

    全量结构后置恢复进度。

    100
    CrossRoleNamestring

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

    test123
    RestoreDirstring

    恢复路径。

    100.X.X.10:33204
    CrossAliyunIdstring

    跨阿里云账号备份的uid。

    2xxx7778xxxxxxxxxx
    RestoreObjectsstring

    恢复对象。

    [ { \"DBName\":\"test\" } ]
    BackupPlanIdstring

    备份计划ID。

    dbs1hvb0wXXXX
    DestinationEndpointRegionstring

    数据库地域。

    cn-hangzhou
    RestoreTaskCreateTimeLong

    恢复任务创建时间,取值:1554560477000。

    1554560477000
    DestinationEndpointUserNamestring

    数据库账号。

    test
    RestoreTaskFinishTimeLong

    恢复任务完成时间,取值:1554560477000。

    1554560477000
    DestinationEndpointIpPortstring

    数据库连接地址。

    100.X.X.10:33204
    DestinationEndpointDatabaseNamestring

    数据库名称。

    test
    DestinationEndpointInstanceTypestring

    数据库所在位置,取值:

    • RDS
    • ECS
    • Express:通过专线/VPN网关/智能网关接入的数据库
    • agent:通过备份网关接入的数据库
    • dds:云MongoDB
    • other:通过IP:Port直连的数据库
    RDS
    DestinationEndpointOracleSIDstring

    Oracle SID名称。

    test
    FullStruforeRestoreProgressinteger

    全量结构前置恢复进度。

    0
    ErrMessagestring

    错误信息。

    NULL
    RestoreTaskIdstring

    恢复任务ID。

    s1XXXXXX
    FullDataRestoreProgressinteger

    全量数据恢复进度。

    100
    ContinuousRestoreProgressinteger

    增量日志恢复进度。

    100
    DestinationEndpointInstanceIDstring

    数据库实例ID。

    rm-bp1p8c2947XXX
    BackupSetIdstring

    恢复所使用的全量备份集ID。

    1ibh2f5uXXX
    BackupGatewayIdLong

    备份网关ID。

    324234332
    RestoreTaskNamestring

    恢复任务名称。

    test
    RestoreTimeLong

    恢复时间,取值:1554560477000。

    1554560477000

    示例

    请求示例

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

    正常返回示例

    JSON格式

    {
    	"PageSize": 30,
    	"RequestId": "9C397502-B4F2-4E22-AD97-C81F0049F3F3",
    	"PageNum": 0,
    	"HttpStatusCode": 200,
    	"TotalElements": 1,
    	"Items": {
    		"RestoreTaskDetail": [
    			{
    				"FullStruAfterRestoreProgress": 0,
    				"FullStruforeRestoreProgress": 0,
    				"BackupSetId": "1ibXXXXX7qw",
    				"RestoreStatus": "check_pass",
    				"DestinationEndpointInstanceType": "rds",
    				"RestoreTime": 1583741465000,
    				"DestinationEndpointRegion": "cn-hangzhou",
    				"FullDataRestoreProgress": 0,
    				"RestoreTaskId": "s10XXXXnq",
    				"DestinationEndpointIpPort": "100.X.X.10:33204",
    				"DestinationEndpointUserName": "testygx",
    				"RestoreObjects": "[     {         \"DBName\":\"test_ygx\"       } ]",
    				"RestoreTaskName": "test",
    				"BackupPlanId": "dbs1hvb0wwweusfa",
    				"RestoreTaskCreateTime": 1583743872000,
    				"DestinationEndpointInstanceID": "rm-bp1p8c29479jv8pxe"
    			}
    		]
    	},
    	"TotalPages": 1,
    	"Success": true
    }

    XML格式

    <PageSize>30</PageSize>
    <RequestId>9C397502-B4F2-4E22-AD97-C81F0049F3F3</RequestId>
    <PageNum>0</PageNum>
    <HttpStatusCode>200</HttpStatusCode>
    <TotalElements>1</TotalElements>
    <Items>
        <RestoreTaskDetail>
            <FullStruAfterRestoreProgress>0</FullStruAfterRestoreProgress>
            <FullStruforeRestoreProgress>0</FullStruforeRestoreProgress>
            <BackupSetId>1ibXXXXX7qw</BackupSetId>
            <RestoreStatus>check_pass</RestoreStatus>
            <DestinationEndpointInstanceType>rds</DestinationEndpointInstanceType>
            <RestoreTime>1583741465000</RestoreTime>
            <DestinationEndpointRegion>cn-hangzhou</DestinationEndpointRegion>
            <FullDataRestoreProgress>0</FullDataRestoreProgress>
            <RestoreTaskId>s10XXXXnq</RestoreTaskId>
            <DestinationEndpointIpPort>100.X.X.10:33204</DestinationEndpointIpPort>
            <DestinationEndpointUserName>testygx</DestinationEndpointUserName>
            <RestoreObjects>[     {         "DBName":"test_ygx"       } ]</RestoreObjects>
            <RestoreTaskName>test</RestoreTaskName>
            <BackupPlanId>dbs1hvb0wwweusfa</BackupPlanId>
            <RestoreTaskCreateTime>1583743872000</RestoreTaskCreateTime>
            <DestinationEndpointInstanceID>rm-bp1p8c29479jv8pxe</DestinationEndpointInstanceID>
        </RestoreTaskDetail>
    </Items>
    <TotalPages>1</TotalPages>
    <Success>true</Success>

    错误码

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

    阿里云首页 数据库备份 DBS 相关技术圈