更新时间:2024-09-05 GMT+08:00

恢复归档存储对象(Go SDK)

功能说明

如果要获取归档存储对象的内容,需要先将对象恢复,然后再执行下载数据的操作。对象恢复后,会产生一个标准存储类型的对象副本,也就是说会同时存在标准存储类型的对象副本和归档存储对象,在恢复对象的保存时间到期后标准存储类型的对象副本会自动删除。

该接口可以恢复指定桶中的归档存储对象。

接口约束

  • 您必须是桶拥有者或拥有恢复归档存储对象的权限,才能恢复归档存储对象。建议使用IAM或桶策略进行授权,如果使用IAM则需授予obs:object:RestoreObject权限,如果使用桶策略则需授予RestoreObject权限。相关授权方式介绍可参见OBS权限控制概述,配置方式详见使用IAM自定义策略配置对象策略
  • OBS支持的Region与Endpoint的对应关系,详细信息请参见地区与终端节点
  • 重复恢复归档存储对象时在延长恢复有效期的同时,也将会对恢复时产生的恢复费用进行重复收取。产生的标准存储类别的对象副本有效期将会延长,并且收取延长时间段产生的标准存储副本费用。

方法定义

func (obsClient ObsClient) RestoreObject(input *RestoreObjectInput) (output *BaseModel, err error)

请求参数说明

表1 请求参数列表

参数名称

参数类型

是否必选

描述

input

*RestoreObjectInput

必选

参数解释:

恢复归档存储对象请求参数,详见RestoreObjectInput

表2 RestoreObjectInput

参数名称

参数类型

是否必选

描述

Bucket

string

必选

参数解释

桶名。

约束限制:

  • 桶的名字需全局唯一,不能与已有的任何桶名称重复,包括其他用户创建的桶。
  • 桶命名规则如下:
    • 3~63个字符,数字或字母开头,支持小写字母、数字、“-”、“.”。
    • 禁止使用IP地址。
    • 禁止以“-”或“.”开头及结尾。
    • 禁止两个“.”相邻(如:“my..bucket”)。
    • 禁止“.”和“-”相邻(如:“my-.bucket”和“my.-bucket”)。
  • 同一用户在同一个区域多次创建同名桶不会报错,创建的桶属性以第一次请求为准。

默认取值:

Key

string

必选

参数解释:

对象名。对象名是对象在存储桶中的唯一标识。对象名是对象在桶中的完整路径,路径中不包含桶名。

例如,您对象的访问地址为examplebucket.obs.ap-southeast-1.myhuaweicloud.com/folder/test.txt 中,对象名为folder/test.txt。

取值范围:

长度大于0且不超过1024的字符串。

默认取值:

VersionId

string

可选

参数解释:

待恢复归档存储对象的版本号。

默认取值:

无,如果不设置则默认指定最新版本的对象。

Days

int

必选

参数解释:

恢复对象后,会生成一个对象的标准存储副本,此参数指定恢复有效期,即标准存储副本的保存时间。

取值范围:

[1, 30],单位:天。

默认取值:

Tier

RestoreTierType

可选

参数解释:

恢复选项,用户可根据需求选择恢复选项,不同的恢复选项恢复耗时不同。

取值范围:

恢复选项可选值详见RestoreTierType

默认取值:

标准恢复

表3 RestoreTierType

常量名

原始值

说明

RestoreTierExpedited

Expedited

快速恢复,归档存储恢复耗时1~5 min。

RestoreTierStandard

Standard

标准恢复,归档存储恢复耗时3~5 h。

返回结果说明

表4 返回结果

参数名称

参数类型

描述

output

*BaseModel

参数解释:

接口返回信息,详见BaseModel

err

error

参数解释:

接口返回错误信息。

表5 BaseModel

参数名称

参数类型

描述

StatusCode

int

参数解释:

HTTP状态码。

取值范围:

状态码是一组从2xx(成功)到4xx或5xx(错误)的数字代码,状态码表示了请求响应的状态。完整的状态码列表请参见状态码

默认取值:

RequestId

string

参数解释:

OBS服务端返回的请求ID。

默认取值:

ResponseHeaders

map[string][]string

参数解释:

HTTP响应头信息。

默认取值:

代码示例

本示例用于在恢复examplebucket桶中对象名称为example/objectname的归档存储对象
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
package main
import (
    "fmt"
    "os"
    obs "github.com/huaweicloud/huaweicloud-sdk-go-obs/obs"
)
func main() {
    //推荐通过环境变量获取AKSK,这里也可以使用其他外部引入方式传入,如果使用硬编码可能会存在泄露风险。
    //您可以登录访问管理控制台获取访问密钥AK/SK,获取方式请参见https://support.huaweicloud.com/intl/zh-cn/usermanual-ca/ca_01_0003.html。
    ak := os.Getenv("AccessKeyID")
    sk := os.Getenv("SecretAccessKey")
    // 【可选】如果使用临时AK/SK和SecurityToken访问OBS,同样建议您尽量避免使用硬编码,以降低信息泄露风险。您可以通过环境变量获取访问密钥AK/SK,也可以使用其他外部引入方式传入。
    // securityToken := os.Getenv("SecurityToken")
    // endpoint填写Bucket对应的Endpoint, 这里以中国-香港为例,其他地区请按实际情况填写。
    endPoint := "https://obs.ap-southeast-1.myhuaweicloud.com"
    // 创建obsClient实例
    // 如果使用临时AKSK和SecurityToken访问OBS,需要在创建实例时通过obs.WithSecurityToken方法指定securityToken值。
    obsClient, err := obs.New(ak, sk, endPoint/*, obs.WithSecurityToken(securityToken)*/)
    if err != nil {
        fmt.Printf("Create obsClient error, errMsg: %s", err.Error())
    }
    input := &obs.RestoreObjectInput{}
    // 指定存储桶名称
    input.Bucket = "examplebucket"
    // 指定对象名称,此处以example/objectname为例。
    input.Key = "example/objectname"
    // 指定待取回对象的对应版本号
    input.VersionId = "G001117FCE89978B0000401205D5DC9A"
    // 指定恢复对象的保存时间,此处以1为例,单位天,取值范围:[1, 30]。
    input.Days = 1
    // 指定恢复选项,此处以obs.RestoreTierExpedited为例,默认为标准恢复。
    input.Tier = obs.RestoreTierExpedited
    // 取回归档对象
    output, err := obsClient.RestoreObject(input)
    if err == nil {
        fmt.Printf("Restore object(%s) under the bucket(%s) successful!\n", input.Key, input.Bucket)
        fmt.Printf("RequestId:%s\n", output.RequestId)
        return
    }
    fmt.Printf("Restore object(%s) under the bucket(%s) fail!\n", input.Key, input.Bucket)
    if obsError, ok := err.(obs.ObsError); ok {
        fmt.Println("An ObsError was found, which means your request sent to OBS was rejected with an error response.")
        fmt.Println(obsError.Error())
    } else {
        fmt.Println("An Exception was found, which means the client encountered an internal problem when attempting to communicate with OBS, for example, the client was unable to access the network.")
        fmt.Println(err)
    }
}
  • ObsClient.RestoreObject中指定的对象必须是归档存储类型,否则调用该接口会报错。
  • 使用RestoreObjectInput.Days指定恢复对象保存的时间,取值范围是1~30;使用RestoreObjectInput.Tier指定恢复选项,表示恢复选项。

相关链接

  • 关于恢复归档存储对象的API说明,请参见恢复归档存储对象
  • 更多关于恢复归档存储对象的示例代码,请参见Github示例
  • 恢复归档存储对象过程中返回的错误码含义、问题原因及处理措施可参考OBS错误码