控制台指南

最佳实践

开发者指南

API 文档

SDK 文档

诚邀爱技术、爱分享的你,成为文档内容共建者> HOT

简介

本文档提供关于恢复归档对象操作相关的 API 概览以及 SDK 示例代码。

API 操作名 操作描述
POST Object restore 恢复归档对象 将归档类型的对象取回访问

恢复归档对象

功能说明

POST Object restore 接口可以对一个通过 COS 归档为 archive 类型的对象进行恢复,恢复出的可读取对象是临时的,您可以设置需要保持可读,以及随后删除该临时副本的时间。您可以用 Days 参数来指定临时对象的过期时间,若超出该时间且期间您没有发起任何复制、延长等操作,该临时对象将被系统自动删除。临时对象仅为 archive 类型对象的副本,被归档的源对象在此期间将始终存在。

使用示例

cos.restoreObject({
    Bucket: 'examplebucket-1250000000', /* 填入您自己的存储桶,必须字段 */
    Region: 'COS_REGION',  /* 存储桶所在地域,例如ap-beijing,必须字段 */
    Key: '1.jpg',  /* 存储在桶里的对象键(例如1.jpg,a/b/test.txt),必须字段 */
    RestoreRequest: {
        Days: 1,
        CASJobParameters: {
            Tier: 'Expedited'
        }
    },
}, function(err, data) {
    console.log(err || data);
});

参数说明

参数名 参数描述 类型 是否必填
Bucket 存储桶的名称,命名格式为 BucketName-APPID,此处填写的存储桶名称必须为此格式 String
Region 存储桶所在地域,枚举值请参见 地域和访问域名 String
Key 对象键(Object 的名称),对象在存储桶中的唯一标识,详情请参见 对象概述 String
RestoreRequest 用于恢复数据的容器 Object
- Days 设置临时副本的过期时间 Number
- CASJobParameters 归档存储工作参数的容器 Object
- - Tier 恢复归档存储类型的数据时,Tier 可以指定为 COS 支持的三种恢复模式,分别为:
  • Standard(标准取回模式,恢复任务在3 - 5小时内完成)
  • Expedited(快速取回模式,恢复任务在15分钟内可完成)
  • Bulk(批量取回模式,恢复任务在5 - 12小时内完成)
对于恢复深度归档存储类型的数据,有两种恢复模式,分别为:
  • Standard(标准取回模式,恢复时间为12 - 24小时)
  • Bulk(批量取回模式,恢复时间为24 - 48小时)
String

回调函数说明

function(err, data) { ... }

参数名 参数描述 类型
err 请求发生错误时返回的对象,包括网络错误和业务错误,如果请求成功则为空,更多详情请参见 错误码 文档 Object
- statusCode 请求返回的 HTTP 状态码,例如200、403、404等 Number
- headers 请求返回的头部信息 Object
data 请求成功时返回的对象,如果请求发生错误,则为空 Object
- statusCode 请求返回的 HTTP 状态码,例如200、403、404等 Number
- headers 请求返回的头部信息 Object
目录