上传对象-九游平台

input

*putobjectinput

必选

参数解释：

流式上传请求参数，详见putobjectinput。

extensions

可选

参数解释：

桶相关扩展信息。通过调用拓展配置项为对应请求配置额外的拓展请求头，详情参考。

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的字符串。

默认取值：

无

contentmd5

string

可选

参数解释：

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

取值范围：

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

示例：n58ig6hfm7vqi4k0vnwpog==。

默认取值：

无

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）列表参见

默认取值：

如果您在上传object时未指定content-type，sdk会根据指定object名称的后缀来判定文件类型并自动填充content-type。

contentlength

int64

可选

参数解释：

待上传对象数据的长度。

约束限制：

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

默认取值：

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

sseheader

ssecheader

或

ssekmsheader

可选

参数解释：

服务端加密头信息，选择sse-c加密方式，则详见ssecheader，选择sse-kms加密方式，则详见ssekmsheader。

storageclass

storageclasstype

可选

参数解释：

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

取值范围：

可选择的存储类型参见storageclasstype。

默认取值：

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

metadata

map[string]string

可选

参数解释：

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

约束限制：

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

默认取值：

无

body

io.reader

可选

参数解释：

待上传对象的数据流。

约束限制：

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

默认取值：

无

grantreadid

string

可选

参数解释：

被授予read权限的账号的账号id，即domain_id。账号被授予read权限后，针对当前对象，允许被授权指定账号有读对象和获取对象元数据的权限。

取值范围：

获取账号id的方法请参见

默认取值：

无

grantreadacpid

string

可选

参数解释：

被授予read_acp权限的账号的账号id，即domain_id。账号被授予read_acp权限后，针对当前对象，允许读取对象的acl。

取值范围：

获取账号id的方法请参见

默认取值：

无

grantwriteacpid

string

可选

参数解释：

被授予write_acp权限的账号的账号id，即domain_id。账号被授予write_acp权限后，针对当前对象，允许写对象的acl。

取值范围：

获取账号id的方法请参见

默认取值：

无

grantfullcontrolid

string

可选

参数解释：

被授予full_control权限的账号的账号id，即domain_id。账号被授予full_control权限后，针对当前对象，授权指定账号有读对象、获取对象元数据、获取对象acl、写对象acl的权限。

取值范围：

获取账号id的方法请参见

默认取值：

无

expires

int64

可选

参数解释：

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

取值范围：

大于0的正整型，单位：天。

默认取值：

无

aclprivate

private

私有读写。

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

aclpublicread

public-read

公共读私有写。

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

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

aclpublicreadwrite

public-read-write

公共读写。

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

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

aclpublicreaddelivered

public-read-delivered

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

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

aclpublicreadwritedelivered

public-read-write-delivered

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

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

aclbucketownerfullcontrol

bucket-owner-full-control

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

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

encryption

string

作为请求参数时必选

参数解释：

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

取值范围：

可选值：aes256，即选择sse-c方式加密对象。

默认取值：

无

key

string

作为请求参数时必选

参数解释：

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

约束限制：

该头域由256bit的密钥经过base64编码得到，示例：k7qkypbkm5 hca27fsnkunnvaobncnlht/rcb2o/9cw=

默认取值：

无

keymd5

string

作为请求参数时可选

参数解释：

sse-c方式下加密使用密钥的md5值，该值用于验证密钥传输过程中是否出错。

约束限制：

由密钥值经过md5加密再经过base64编码后得到，示例：4xvb3tbntn tieva0/fgaq==

默认取值：

无

encryption

string

作为请求参数时必选

参数解释：

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

取值范围：

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

默认取值：

无

key

string

作为请求参数时可选

参数解释：

sse-kms加密方式下使用的kms主密钥的id值。

取值范围：

有效值支持两种格式：

1. regionid:domainid(账号id):key/key_id
2. key_id

其中：

• regionid是使用密钥所属region的id，可在页面获取；
• domainid是使用密钥所属账号的账号id，获取方法参见；
• key_id是从数据加密服务创建的密钥id，获取方法请参见查看密钥。

默认取值：

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

storageclassstandard

standard

标准存储。

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

storageclasswarm

warm

低频访问存储。

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

storageclasscold

cold

归档存储。

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

storageclassdeeparchive

deep_archive

深度归档存储（受限公测）

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

output

*putobjectoutput

参数解释：

接口返回信息，详见putobjectoutput。

err

error

参数解释：

接口返回错误信息。

statuscode

int

参数解释：

http状态码。

取值范围：

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

默认取值：

无

requestid

string

参数解释：

obs服务端返回的请求id。

默认取值：

无

responseheaders

map[string][]string

参数解释：

http响应头信息。

默认取值：

无

storageclass

storageclasstype

参数解释：

对象的存储类型。

取值范围：

• 当对象存储类型是标准存储时，该值为空。
• 可选择的存储类型参见storageclasstype。

默认取值：

无

versionid

string

参数解释：

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

取值范围：

长度为32的字符串。

默认取值：

无

etag

string

参数解释：

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

约束限制：

当对象是服务端加密的对象时，etag值不是对象的md5值。

取值范围：

长度为32的字符串。

默认取值：

无

sseheader

ssecheader

或

ssekmsheader

参数解释：

服务端加密头信息，选择sse-c加密方式，则详见ssecheader，选择sse-kms加密方式，则详见ssekmsheader。

storageclassstandard

standard

标准存储。

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

storageclasswarm

warm

低频访问存储。

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

storageclasscold

cold

归档存储。

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

storageclassdeeparchive

deep_archive

深度归档存储（受限公测）

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

encryption

string

作为请求参数时必选

参数解释：

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

取值范围：

可选值：aes256，即选择sse-c方式加密对象。

默认取值：

无

key

string

作为请求参数时必选

参数解释：

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

约束限制：

该头域由256bit的密钥经过base64编码得到，示例：k7qkypbkm5 hca27fsnkunnvaobncnlht/rcb2o/9cw=

默认取值：

无

keymd5

string

作为请求参数时可选

参数解释：

sse-c方式下加密使用密钥的md5值，该值用于验证密钥传输过程中是否出错。

约束限制：

由密钥值经过md5加密再经过base64编码后得到，示例：4xvb3tbntn tieva0/fgaq==

默认取值：

无

encryption

string

作为请求参数时必选

参数解释：

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

取值范围：

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

默认取值：

无

key

string

作为请求参数时可选

参数解释：

sse-kms加密方式下使用的kms主密钥的id值。

取值范围：

有效值支持两种格式：

1. regionid:domainid(账号id):key/key_id
2. key_id

其中：

• regionid是使用密钥所属region的id，可在页面获取；
• domainid是使用密钥所属账号的账号id，获取方法参见；
• key_id是从数据加密服务创建的密钥id，获取方法请参见查看密钥。

默认取值：

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