更新时间:2024-11-19 GMT+08:00
分享

追加上传(Harmony SDK)

功能说明

您可以根据需要上传文件或者文件夹至已有的OBS桶。待上传的文件可以是任何类型:文本文件、图片、视频等。

追加写对象操作是指在指定桶内的一个对象尾追加上传数据,不存在相同对象键值的对象则创建新对象。

接口约束

  • 您必须是桶拥有者或拥有上传对象的权限,才能上传对象。建议使用IAM或桶策略进行授权,如果使用IAM则需授予obs:object:PutObject权限,如果使用桶策略则需授予PutObject权限。相关授权方式介绍可参见OBS权限控制概述,配置方式详见使用IAM自定义策略配置对象策略
  • OBS支持的Region与Endpoint的对应关系,详细信息请参见地区与终端节点
  • 用户上传的对象存储在桶中。用户必须对桶有WRITE权限,才可以在桶中上传对象。同一个桶中存储的对象名必须是唯一的。
  • 每次追加上传都会更新该对象的最后修改时间。
  • 服务端加密SSE-C方式,那么追加上传和初始化段一样,设置诸如x-obs-server-side-encryption之类的请求Header,后续追加上传也必须携带。
  • 服务端加密SSE-KMS方式,有且只有第一次上传且桶内不存在同名对象时,才设置诸如x-obs-server-side-encryption之类的请求Header,后续追加上传不携带。
  • 每次追加上传的长度不能超过对象长度上限5G的限制。
  • 每个Appendable对象追加写次数最多为10000次。
  • 如果对象存储类型为COLD(归档存储)或深度归档存储,则不能调用该接口。
  • 如果桶设置了跨区域复制配置,则不能调用该接口。
  • 并行文件系统不支持追加写对象。
  • 该接口仅支持上传文本和ArrayBuffer 类型,如果需要上传文件,请参考生成带授权信息的表单上传参数(Harmony SDK)

方法定义

appendObject(input: AppendObjectInput): Response<AppendObjectOutput>

请求参数

表1 请求参数列表

参数名称

参数类型

是否必选

描述

input

AppendObjectInput

必选

参数解释:

追加上传接口入参,详见AppendObjectInput

表2 AppendObjectInput

参数名称

参数类型

是否必选

描述

Bucket

string

必选

参数解释

桶名。

约束限制:

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

默认取值:

Key

string

必选

参数解释:

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

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

取值范围:

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

默认取值:

Position

number

必选

参数解释:

追加写位置

约束限制:

需要追加写的对象首次上传时就必须指定为0,下次追加需要填写的值为服务端本次上传成功返回消息的NextAppendPosition。

取值范围:

0~(263-1),单位:字节。

默认取值:

0

ContentMD5

string

可选

参数解释:

待上传对象数据的MD5值(经过Base64编码),提供给OBS服务端,校验数据完整性。

示例:n58IG6hfM7vqI4K0vnWpog==。

取值范围:

按照RFC 1864标准计算出消息体的MD5摘要字符串,即消息体128-bit MD5值经过base64编码后得到的字符串。

默认取值:

ACL

AclType

可选

参数解释:

创建对象时可指定的预定义访问策略。有关访问控制列表(Access Control List,ACL)功能的详细信息可参见ACL功能介绍

取值范围:

可选择的访问策略选项参见AclType

默认取值:

WebsiteRedirectLocation

string

可选

参数解释:

当桶设置了Website配置,可以将获取这个对象的请求重定向到桶内另一个对象或一个外部的URL。

例如,重定向请求到桶内另一对象:

WebsiteRedirectLocation:/anotherPage.html

或重定向请求到一个外部URL:

WebsiteRedirectLocation:http://www.example.com/

OBS将这个值从头域中取出,保存在对象的元数据“WebsiteRedirectLocation”中。

约束限制:

  • 必须以“/”、“http://”或“https://”开头,长度不超过2KB。
  • OBS仅支持为桶根目录下的对象设置重定向,不支持为桶中文件夹下的对象设置重定向。

默认取值:

ContentType

string

可选

参数解释:

待上传对象的文件类型(MIME类型)。Content-Type(MIME)用于标识发送或接收数据的类型,浏览器根据该参数来决定数据的打开方式。

取值范围:

常见的Content-Type(MIME)列表参见获取理解Content-Type(MIME)?(Harmony SDK)

默认取值:

如果您在上传Object时未指定Content-Type,SDK会根据指定Object名称的后缀名来判定文件类型并自动填充Content-Type。

ContentLength

number

可选

参数解释:

待上传对象数据的长度。

约束限制:

  • 单次上传对象大小范围是[0, 5GB]。
  • 如果需要上传超过5GB的大文件,需要通过多段操作来分段上传。

默认取值:

如果不传,则sdk会自动计算上传对象数据的长度。

StorageClass

StorageClassType

可选

参数解释:

创建对象时,可以加上此头域设置对象的存储类型。

取值范围:

可选择的存储类型参见StorageClassType

默认取值:

如果未设置此头域,则以桶的默认存储类型作为对象的存储类型。

Metadata

Object

可选

参数解释:

待上传对象的自定义元数据。OBS支持用户使用以“x-obs-meta-”开头的消息头来加入自定义的元数据,以便对对象进行自定义管理。当用户获取此对象或查询此对象元数据时,加入的自定义元数据将会在返回的消息头中出现。

约束限制:

  • 所有自定义元数据大小的总和不超过8K。单个自定义元数据大小的计算方式为:每个键和值的UTF-8 编码中的字节总数。
  • 自定义元数据的key值不区分大小写,OBS统一转为小写进行存储。value值区分大小写。
  • 自定义元数据key-value对都必须符合US-ASCII。如果一定要使用非ASCII码或不可识别字符,需要客户端自行做编解码处理,可以采用URL编码或者Base64编码,服务端不会做解码处理。例如x-obs-meta-中文:中文 经URL编码后发送,“中文”的URL编码为:%E4%B8%AD%E6%96%87,则响应为x-obs-meta-%E4%B8%AD%E6%96%87: %E4%B8%AD%E6%96%87

默认取值:

Body

string | ArrayBuffer

可选

参数解释:

待上传对象的数据流。

约束限制:

  • 单次上传对象大小范围是[0, 5GB]。
  • 如果需要上传超过5GB的大文件,需要通过多段操作来分段上传。

默认取值:

GrantRead

string

可选

参数解释

被授予READ权限的账号的账号ID,即domain_id。账号被授予READ权限后,针对当前正在创建的桶,允许列举桶内对象、列举桶中多段任务、列举桶中多版本对象、获取桶元数据。

取值范围:

如何获取账号ID请参见如何获取账号ID和用户ID?(Harmony SDK)

默认取值:

GrantReadACP

string

可选

参数解释

被授予READ_ACP权限的账号的账号ID,即domain_id。账号被授予READ_ACP权限后,针对当前正在创建的桶,允许读桶的ACL信息。

取值范围:

如何获取账号ID请参见如何获取账号ID和用户ID?(Harmony SDK)

默认取值:

GrantWriteACP

string

可选

参数解释

被授予WRITE_ACP权限的账号的账号ID,即domain_id。账号被授予WRITE_ACP权限后,针对当前正在创建的桶,允许修改桶的ACL信息。

取值范围:

如何获取账号ID请参见如何获取账号ID和用户ID?(Harmony SDK)

默认取值:

GrantFullControl

string

可选

参数解释

被授予FULL_CONTROL权限的账号的账号ID,即domain_id。账号被授予FULL_CONTROL权限后,针对当前正在创建的桶,允许进行任何操作。

取值范围:

如何获取账号ID请参见如何获取账号ID和用户ID?(Harmony SDK)

默认取值:

Expires

number

可选

参数解释:

表示对象的过期时间(从对象最后修改时间开始计算),过期之后对象会被自动删除。

取值范围:

1~(263-1),单位:天。

默认取值:

表3 AclType

常量名

原始值

说明

AclPrivate

private

私有读写。

桶或对象的所有者拥有完全控制的权限,其他任何人都没有访问权限。

AclPublicRead

public-read

公共读私有写。

设在桶上,所有人可以获取该桶内对象列表、桶内多段任务、桶的元数据、桶的多版本。

设在对象上,所有人可以获取该对象内容和元数据。

AclPublicReadWrite

public-read-write

公共读写。

设在桶上,所有人可以获取该桶内对象列表、桶内多段任务、桶的元数据、桶的多版本、上传对象、删除对象、初始化段任务、上传段、合并段、拷贝段、取消多段上传任务。

设在对象上,所有人可以获取该对象内容和元数据。

AclPublicReadDelivered

public-read-delivered

桶公共读,桶内对象公共读。

设在桶上,所有人可以获取该桶内对象列表、桶内多段任务、桶的元数据、桶的多版本,可以获取该桶内对象的内容和元数据。

说明:

AclPublicReadDelivered不能应用于对象。

AclPublicReadWriteDelivered

public-read-write-delivered

桶公共读写,桶内对象公共读写。

设在桶上,所有人可以获取该桶内对象列表、桶内多段任务、桶的元数据、桶的多版本、上传对象、删除对象、初始化段任务、上传段、合并段、拷贝段、取消多段上传任务,可以获取该桶内对象的内容和元数据。

说明:

AclPublicReadWriteDelivered不能应用于对象。

AclBucketOwnerFullControl

bucket-owner-full-control

设在对象上,桶和对象的所有者拥有对象的完全控制权限,其他任何人都没有访问权限。

默认情况下,上传对象至其他用户的桶中,桶拥有者没有对象的控制权限。对象拥有者为桶拥有者添加此权限控制策略后,桶所有者可以完全控制对象。例如,用户A上传对象x至用户B的桶中,系统默认用户B没有对象x的控制权。当用户A为对象x设置bucket-owner-full-control策略后,用户B就拥有了对象x的控制权。

表4 StorageClassType

常量名

原始值

说明

StorageClassStandard

STANDARD

标准存储。

标准存储拥有低访问时延和较高的吞吐量,适用于有大量热点对象(平均一个月多次)或小对象(<1MB),且需要频繁访问数据的业务场景。

StorageClassWarm

WARM

低频访问存储。

低频访问存储适用于不频繁访问(平均一年少于12次)但在需要时也要求能够快速访问数据的业务场景。

StorageClassCold

COLD

归档存储。

归档存储适用于很少访问(平均一年访问一次)数据的业务场景。

StorageClassDeepArchive

DEEP_ARCHIVE

深度归档存储(受限公测)

适用于长期不访问(平均几年访问一次)数据的业务场景

返回结果

表5 返回结果

参数类型

描述

Response

说明:

该接口返回是一个Promise类型,需要使用Promise、async/await语法处理。

参数解释:

接口返回信息,详见Response

表6 Response

参数名称

参数类型

描述

CommonMsg

ICommonMsg

参数解释:

接口调用完成后的公共信息,包含HTTP状态码,操作失败的错误码等,详见ICommonMsg

InterfaceResult

AppendObjectOutput

参数解释:

操作成功后的结果数据,详见AppendObjectOutput

约束限制:

当Status大于300时为空。

表7 ICommonMsg

参数名称

参数类型

描述

Status

number

参数解释:

OBS服务端返回的HTTP状态码。

取值范围:

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

Code

string

参数解释:

OBS服务端返回的错误码。

Message

string

参数解释:

OBS服务端返回的错误描述。

HostId

string

参数解释:

OBS服务端返回的请求服务端ID。

RequestId

string

参数解释:

OBS服务端返回的请求ID。

Id2

string

参数解释:

OBS服务端返回的请求ID2。

Indicator

string

参数解释:

OBS服务端返回的详细错误码。

表8 AppendObjectOutput

参数名称

参数类型

描述

RequestId

string

参数解释:

OBS服务端返回的请求ID。

默认取值:

VersionId

string

参数解释:

对象的版本号。如果桶的多版本状态为开启,则会返回对象的版本号。

取值范围:

长度为32的字符串

默认取值:

ETag

string

参数解释:

对象的ETag值,即base64编码的128位MD5摘要。ETag是对象内容的唯一标识,可以通过该值识别对象内容是否有变化。比如上传对象时ETag为A,下载对象时ETag为B,则说明对象内容发生了变化。ETag只反映变化的内容,而不是其元数据。上传的对象或复制操作创建的对象,都有唯一的ETag。

约束限制:

当对象是服务端加密的对象时,ETag值不是对象的MD5值。

取值范围:

长度为32的字符串。

默认取值:

NextAppendPosition

number

参数解释:

下一次追加上传请求应该提供的追加写位置(position)。

约束限制:

需要追加写的对象首次上传时就必须指定为0,下次追加需要填写的值为服务端本次上传成功返回消息的NextAppendPosition。

取值范围:

0~(263-1),单位:字节。

默认取值:

0

SseKms

string

参数解释:

表示服务端加密是SSE-KMS方式。对象使用SSE-KMS方式加密。

取值范围:

可选值:kms,即选择SSE-KMS方式加密对象。

默认取值:

SseKmsKey

string

参数解释:

SSE-KMS加密方式下使用的KMS主密钥的ID值。

取值范围:

有效值支持两种格式:

  1. regionID:domainID(账号ID):key/key_id
  2. key_id

其中:

默认取值:

  • 如果用户没有提供该头域,那么默认的主密钥将会被使用。
  • 如果默认主密钥不存在,将默认创建并使用。

SseC

string

参数解释:

表示服务端加密是SSE-C方式。对象使用SSE-C加密方式。

取值范围:

可选值:AES256,即选择SSE-C方式加密对象。

默认取值:

SseCKeyMd5

string

参数解释:

SSE-C方式下加密使用密钥的MD5值,该值用于验证密钥传输过程中是否出错。

约束限制:

由密钥值经过MD5加密再经过Base64编码后得到,示例:4XvB3tbNTN+tIEVa0/fGaQ==

默认取值:

代码示例

本示例用于追加上传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
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
// 引入依赖包
import ObsClient, { AppendObjectInput } from '@obs/esdk-obs-harmony';

// 创建ObsClient实例
const obsClient = new ObsClient({
  // 推荐通过环境变量获取AKSK,这里也可以使用其他外部引入方式传入,如果使用硬编码可能会存在泄露风险
  // 您可以登录访问管理控制台获取访问密钥AK/SK,获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html
  AccessKeyId: process.env.ACCESS_KEY_ID,
  SecretAccessKey: process.env.SECRET_ACCESS_KEY,
  // 【可选】如果使用临时AK/SK和SecurityToken访问OBS,同样建议您尽量避免使用硬编码,以降低信息泄露风险。您可以通过环境变量获取访问密钥AK/SK,也可以使用其他外部引入方式传入
  // SecurityToken: process.env.SECURITY_TOKEN,
  // Server填写Bucket对应的Endpoint, 这里以华北-北京四为例,其他地区请按实际情况填写
  Server: "https://obs.cn-north-4.myhuaweicloud.com",
});

async function appendObject() {
  try {
    const params: AppendObjectInput = {
      // 指定存储桶名称
      Bucket: "examplebucket",
      // 指定追加上传对象名,此处以 example/objectname 为例
      Key: "example/objectname",
      // 指定追加写位置。首次上传时就必须指定position为0, 下次追加需要填写的position
      Position: 0,
      // 指定待上传对象的数据流
      Body: strings.NewReader("Hello OBS"),
    };
    // 追加上传对象
    const result = await obsClient.appendObject(params);
    if (result.CommonMsg.Status <= 300) {
      console.log("Append object(%s) under the bucket(%s) successful!", params.Key, params.Bucket);
      console.log("RequestId: %s", result.CommonMsg.RequestId);
      console.log("ETag: %s, NextAppendPosition:%d", result.InterfaceResult.ETag, result.InterfaceResult.NextAppendPosition);
      // 第二次追加上传
      const params: AppendObjectInput = {
        // 指定存储桶名称
        Bucket: "examplebucket",
        // 指定待上传对象,此处以 example/objectname 为例
        Key: "example/objectname",
        // 指定追加写位置。首次上传时就必须指定position为0, 下次追加需要填写的position
        Position: result.InterfaceResult.NextAppendPosition,
        // 指定待上传对象的数据流
        Body: strings.NewReader("Hello OBS Again"),
      };
      // 追加上传对象
      const result = await obsClient.appendObject(params);
      if (result.CommonMsg.Status <= 300) {
        console.log("Append object(%s) under the bucket(%s) successful!", params.Key, params.Bucket);
        console.log("RequestId: %s", result.CommonMsg.RequestId);
        console.log("ETag: %s, NextAppendPosition:%d", result.InterfaceResult.ETag, result.InterfaceResult.NextAppendPosition);
        return;
      }
      console.log("An ObsError was found, which means your request sent to OBS was rejected with an error response.");
      console.log("Status: %d", result.CommonMsg.Status);
      console.log("Code: %s", result.CommonMsg.Code);
      console.log("Message: %s", result.CommonMsg.Message);
      console.log("RequestId: %s", result.CommonMsg.RequestId);
      return;
    }
    console.log("An ObsError was found, which means your request sent to OBS was rejected with an error response.");
    console.log("Status: %d", result.CommonMsg.Status);
    console.log("Code: %s", result.CommonMsg.Code);
    console.log("Message: %s", result.CommonMsg.Message);
    console.log("RequestId: %s", result.CommonMsg.RequestId);
  } catch (error) {
    console.log("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.");
    console.log(error);
  }
}

appendObject();

相关链接

  • 关于上传对象-追加上传的API说明,请参见追加写对象
  • 上传对象过程中返回的错误码含义、问题原因及处理措施可参考OBS错误码
  • 上传对象常见问题请参见上传对象失败

相关文档