Bucket

string

必选

参数解释：

桶名。

约束限制：

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

取值范围：

长度为3～63个字符。

默认取值：

无

Key

string

必选

参数解释：

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

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

约束限制：

无

取值范围：

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

默认取值：

无

PartNumber

number

必选

参数解释：

段号。

约束限制：

无

取值范围：

取值范围是[1,10000]的非负整数。

默认取值：

无

UploadId

string

必选

参数解释：

分段上传任务的ID。任务ID可以通过初始化分段上传任务生成。

约束限制：

无

取值范围：

长度为32的字符串。

例如：000001648453845DBB78F2340DD460D8。

默认取值：

无

ContentMD5

string

可选

参数解释：

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

约束限制：

消息体128-bit MD5值经过base64编码后得到的字符串。

取值范围：

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

示例：n58IG6hfM7vqI4K0vnWpog==。

默认取值：

无

Body

string | stream.Readable

可选

参数解释：

待上传对象的数据流。

约束限制：

单次上传大小范围是[0, 5GB]。

取值范围：

无

默认取值：

无

SourceFile

string

可选

参数解释：

待上传对象的源文件路径。

约束限制：

• 单次上传大小范围是[0, 5GB]。
• Body与SourceFile不能同时使用。
• 当Body与SourceFile都为空时，上传对象的大小为0字节。
• Offset、PartSize和SourceFile配套使用，用于指定上传源文件中的某一分段数据。

取值范围：

无

默认取值：

无

Offset

number

可选

参数解释：

源文件中某一分段的起始偏移大小。

约束限制：

Offset、PartSize和SourceFile配套使用，用于指定上传源文件中的某一分段数据。

取值范围：

非负整数，小于待上传对象的大小，单位：字节。

默认取值：

0

PartSize

number

可选

参数解释：

当前段的长度。

约束限制：

Offset、PartSize和SourceFile配套使用，用于指定上传源文件中的某一分段数据。

取值范围：

100KB~5GB，单位：字节。

默认取值：

102400字节

SseKms

string

当使用SSE-KMS方式时，必选

参数解释：

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

约束限制：

当前仅支持kms。

取值范围：

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

默认取值：

无

SseKmsKey

string

可选

参数解释：

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

约束限制：

有效值支持两种格式：

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

其中：

• regionID是使用密钥所属region的ID，可在地区和终端节点页面获取；
• domainID是使用密钥所属账号的账号ID，获取方法参见如何获取账号ID和用户ID？(Node.js SDK)；
• key_id是从 数据加密 服务创建的密钥ID，获取方法请参见查看密钥。

取值范围：

无

默认取值：

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

SseC

string

当使用SSE-C方式时，必选

参数解释：

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

约束限制：

仅支持AES256。

取值范围：

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

默认取值：

无

SseCKey

string

当使用SSE-C方式时，必选

参数解释：

SSE-C方式下加密使用的密钥，该密钥用于加密对象。

约束限制：

该头域由256bit的密钥经过Base64编码得到，示例：K7QkYpBkM5+hca27fsNkUnNVaobncnLht/rCB2o/9Cw=

取值范围：

无

默认取值：

无