request

CopyObjectRequest

必选

参数解释：

复制对象请求参数，详见CopyObjectRequest。

bucketName

String

必选

参数解释：

目标桶名。

约束限制：

桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。
桶命名规则如下：

3～63个字符，数字或字母开头，支持小写字母、数字、“-”、“.”。
禁止使用IP地址。
禁止以“-”或“.”开头及结尾。
禁止两个“.”相邻（如：“my..bucket”）。
禁止“.”和“-”相邻（如：“my-.bucket”和“my.-bucket”）。

同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。

默认取值：

无

objectKey

String

必选

参数解释：

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

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

取值范围：

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

默认取值：

无

sseKmsHeader

SseKmsHeader

可选

参数解释：

服务端加密头信息，用于加密目标对象。详见SseKmsHeader。

默认取值：

无

sseCHeader

SseCHeader

可选

参数解释：

服务端加密头信息，用于加密目标对象。详见SseCHeader。

默认取值：

无

acl

AccessControlList

可选

参数解释：

复制对象时可指定的预定义访问策略。详见AccessControlList。

默认取值：

无

successRedirectLocation

String

可选

参数解释：

此参数的值是一个URL，用于指定当此次请求操作成功响应后的重定向的地址。

如果此参数值有效且操作成功，响应码为303，返回值中的Location头域由此参数以及桶名、对象名、对象的ETag组成。
如果此参数值无效，则OBS忽略此参数的作用，返回值中的Location头域为对象地址，响应码根据操作成功或失败正常返回。

默认取值：

无

sourceBucketName

String

必选

参数解释：

源桶名。

约束限制：

桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。
桶命名规则如下：

3～63个字符，数字或字母开头，支持小写字母、数字、“-”、“.”。
禁止使用IP地址。
禁止以“-”或“.”开头及结尾。
禁止两个“.”相邻（如：“my..bucket”）。
禁止“.”和“-”相邻（如：“my-.bucket”和“my.-bucket”）。

同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。

默认取值：

无

sourceObjectKey

String

必选

参数解释：

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

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

取值范围：

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

默认取值：

无

newObjectMetadata

ObjectMetadata

可选

参数解释：

目标对象的自定义元数据，详见ObjectMetadata。

约束限制：

newObjectMetadata需与replaceMetadata配合使用。

默认取值：

无

replaceMetadata

boolean

可选

参数解释：

复制对象时，是否重写源对象的元数据。

约束限制：

replaceMetadata需与newObjectMetadata配合使用。

取值范围：

true：重写源对象的元数据。

false：不重写源对象的元数据。

默认取值：

无

ifModifiedSince

java.util.Date

可选

参数解释：

如果源对象的修改时间早于该参数值指定的时间，则进行复制，否则返回错误。

默认取值：

无

ifUnmodifiedSince

java.util.Date

可选

参数解释：

如果源对象的修改时间晚于该参数值指定的时间，则进行复制，否则返回错误。

默认取值：

无

ifMatchTag

String

可选

参数解释：

指定一个预设的Etag值，如果下载对象的ETag值与该参数值相同，则返回对象内容，否则返回错误。其中，源对象的ETag值是指源对象数据的MD5校验值。

约束限制：

如果包含ifUnmodifiedSince并且不符合，或者包含ifMatchTag并且不符合，或者包含ifModifiedSince并且不符合，或者包含ifNoneMatchTag并且不符合，则复制失败，抛出异常中HTTP状态码为：412 precondition failed。
ifModifiedSince和ifNoneMatchTag可以一起使用；ifUnmodifiedSince和ifMatchTag可以一起使用。

取值范围：

长度为32的字符串。

默认取值：

无

ifNoneMatchTag

String

可选

参数解释：

指定一个预设的Etag值，如果下载对象的ETag值与该参数值不相同，则返回对象内容，否则返回错误。

取值范围：

长度为32的字符串。

默认取值：

无

versionId

String

可选

参数解释：

源对象版本号。

取值范围：

长度为32的字符串。

默认取值：

无

sseCHeaderSource

SseCHeader

可选

参数解释：

服务端解密头信息，用于解密源对象。详见SseCHeader。

默认取值：

无

encryption

ServerEncryption

必选

参数解释：

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

取值范围：

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

默认取值：

无

sseAlgorithm

SSEAlgorithmEnum

可选

参数解释：

加密算法。

约束限制：

只支持kms。

取值范围：

详见SSEAlgorithmEnum。

默认取值：

无

kmsKeyId

String

可选

参数解释：

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

取值范围：

有效值支持两种格式：

regionID:domainID(账号ID):key/key_id
key_id

其中：

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

默认取值：

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

algorithm

ServerAlgorithm

必选

参数解释：

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

取值范围：

可选值：AES256，即选择SSE-C方式，使用高级加密标准（Advanced Encryption Standard，AES）加密对象。详见ServerAlgorithm。

默认取值：

无

sseAlgorithm

SSEAlgorithmEnum

可选

参数解释：

加密算法。

约束限制：

只支持AES256。

取值范围：

详见SSEAlgorithmEnum。

默认取值：

无

sseCKey

byte[]

必选

参数解释：

SSE-C方式下加密使用的原始密钥，byte[]形式，该密钥用于加密对象。

默认取值：

无

sseCKeyBase64

String

可选

参数解释：

SSE-C方式下的密钥，由原始密钥经过Base64编码后得到，该密钥用于加密对象。

默认取值：

无

OBS_KMS

kms

KMS

kms

AES256

AES256

AES256

AES256

owner

Owner

可选

参数解释：

桶所有者的信息，详见Owner。

delivered

boolean

可选

参数解释：

桶的ACL是否向桶内对象传递，作用于桶内所有对象。

取值范围：

true：是，桶ACL向桶内对象传递。

false：否，桶ACL不向桶内对象传递，仅作用于桶。

默认取值：

false

grants

Set

可选

参数解释：

被授权用户相关信息，详见GrantAndPermission。

id

String

必选

参数解释：

桶所有者的账号ID，即domain_id。

取值范围：

如何获取账号ID请参见如何获取账号ID和用户ID?。

默认取值：

无

displayName

String

可选

参数解释：

所有者的账号名。

取值范围：

如何获取账号名请参见如何获取账号名?。

默认取值：

无

grantee

GranteeInterface

必选

参数解释：

被授权用户或用户组，详见GranteeInterface。

permission

Permission

必选

参数解释：

用户或用户组被授予的权限。

取值范围：

详见Permission。

默认取值：

无

delivered

boolean

可选

参数解释：

桶的ACL是否向桶内对象传递，作用于桶内所有对象。

取值范围：

true：是，桶ACL向桶内对象传递。

false：否，桶ACL不向桶内对象传递，仅作用于桶。

默认取值：

false

PERMISSION_READ

READ

读权限。

若有桶的读权限，则可以获取该桶内对象列表、桶内多段任务、桶的元数据、桶的多版本。

若有对象的读权限，则可以获取该对象内容和元数据。

PERMISSION_WRITE

WRITE

写权限。

若有桶的写权限，则可以上传、覆盖和删除该桶内任何对象和段。

此权限在对象上不适用。

PERMISSION_READ_ACP

READ_ACP

读取ACL配置的权限。

若有读ACP的权限，则可以获取对应的桶或对象的权限控制列表（ACL）。

桶或对象的所有者永远拥有读对应桶或对象ACP的权限。

PERMISSION_WRITE_ACP

WRITE_ACP

修改ACL配置的权限。

若有写ACP的权限，则可以更新对应桶或对象的权限控制列表（ACL）。

桶或对象的所有者永远拥有写对应桶或对象的ACP的权限。

拥有了写ACP的权限，由于可以更改权限控制策略，实际上意味着拥有了完全访问的权限。

PERMISSION_FULL_CONTROL

FULL_CONTROL

完全控制权限，包括对桶或对象的读写权限，以及对桶或对象ACL配置的读写权限。

若有桶的完全控制权限意味着拥有READ、WRITE、READ_ACP和WRITE_ACP的权限。

若有对象的完全控制权限意味着拥有READ、READ_ACP和WRITE_ACP的权限。

CanonicalGrantee

CanonicalGrantee

必选

参数解释：

被授权用户的用户信息，详见CanonicalGrantee。

GroupGrantee

GroupGrantee

必选

参数解释：

被授权用户组的用户组信息。

取值范围：

详见GroupGrantee。

默认取值：

无

grantId

String

如果Type为用户类型则必选

参数解释：

被授权用户的账号ID，即domain_id。

取值范围：

如何获取账号ID请参见如何获取账号ID和用户ID?。

默认取值：

无

displayName

String

可选

参数描述：

被授权用户的账号名。

取值范围：

如何获取账号名请参见如何获取账号名?。

默认取值：

无

ALL_USERS

所有用户。

AUTHENTICATED_USERS

授权用户，已废弃。

LOG_DELIVERY

日志投递组，已废弃。

contentLength

Long

可选

参数解释：

对象数据的长度。

约束限制：

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

默认取值：

如果不设置，则SDK会自动计算对象数据的长度。

contentType

String

可选

参数解释：

对象的文件类型（MIME类型）。contentType（MIME）用于标识发送或接收数据的类型，浏览器根据该参数来决定数据的打开方式。

取值范围：

常见的contentType（MIME）列表参见如何理解Content-Type（MIME）？(Java SDK)。

默认取值：

如果未指定Content-Type，SDK会根据指定Object名称的后缀来判定文件类型并自动填充Content-Type（如.xml判断为application/xml文件；.html判断为text/html文件）。

contentEncoding

String

可选

参数解释：

响应中的Content-Encoding头。指定对象内容编码格式。

默认取值：

无

contentDisposition

String

可选

参数解释：

为请求的对象提供一个默认的文件名赋值给该对象，当下载对象或者访问对象时，以默认文件名命名的文件将直接在浏览器上显示，或在弹出文件下载对话框时显示。

默认取值：

无

cacheControl

String

可选

参数解释：

响应中的Cache-Control头。指定对象被下载时的网页的缓存行为。

默认取值：

无

contentLanguage

String

可选

参数解释：

说明访问者希望采用的语言或语言组合，以根据自己偏好的语言来定制。详情请参见HTTP协议中关于ContentLanguage的定义。

默认取值：

无

expires

String

可选

参数解释：

表示对象的过期时间点（从对象最后修改时间开始计算）。

约束限制：

日期格式为GMT的格式。

默认取值：

无

contentMd5

String

可选

参数解释：

对象数据的MD5值（经过Base64编码），提供给OBS服务端，校验数据完整性。OBS服务端会将该MD5值与对象数据计算出的MD5值进行对比，如果不匹配则上传失败，返回HTTP 400错误。

约束限制：

对象数据的MD5值必须经过Base64编码。
如果不设置对象的MD5值，OBS服务端会忽略对对象数据的MD5值校验。

取值范围：

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

示例：n58IG6hfM7vqI4K0vnWpog==

默认取值：

无

storageClass

StorageClassEnum

可选

参数解释：

对象的存储类别。创建对象时，可以加上此头域设置对象的存储类别。如果未设置此头域，则以桶的默认存储类别作为对象的存储类别。

取值范围：

可选择的存储类别参见StorageClassEnum。

默认取值：

无

webSiteRedirectLocation

String

可选

参数解释：

当桶设置了Website配置，可以将获取这个对象的请求重定向到桶内另一个对象或一个外部的URL，该参数指明对象的重定向地址。

例如，重定向请求到桶内另一对象：

WebsiteRedirectLocation:/anotherPage.html

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

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

约束限制：

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

默认取值：

无

nextPosition

long

可选

参数解释：

下次追加上传的位置。

取值范围：

0~对象长度，单位：字节。

默认取值：

无

appendable

boolean

可选

参数解释：

对象是否为可追加上传的对象。

取值范围：

true：是，可追加上传。

false：否，不可追加上传。

默认取值：

无

userMetadata

Map

可选

参数解释：

对象的自定义元数据，OBS支持用户使用以“x-obs-meta-”开头的消息头来加入自定义的元数据，以便对对象进行自定义管理。Map中的String代表以“x-obs-meta-”开头的自定义元数据名称，Object代表自定义元数据的值。对象的自定义元数据可以通过ObsClient.getObjectMetadata获取，参见获取对象元数据。

约束限制：

一个对象可以有多个元数据，总大小不能超过8KB。
使用ObsClient.getObject下载对象时，对象的自定义元数据也会同时下载。

默认取值：

无

STANDARD

STANDARD

标准存储。

WARM

WARM

低频访问存储。

COLD

COLD

归档存储。

statusCode

int

参数解释：

HTTP状态码。

取值范围：

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

默认取值：

无

responseHeaders

Map

参数解释：

响应消息头列表，由多个元组构成。元组中String代表响应消息头的名称，Object代表响应消息头的值。

默认取值：

无

lastModified

java.util.Date

参数解释：

目标对象的最近一次修改时间。

默认取值：

无

etag

String

参数解释：

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

约束限制：

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

取值范围：

长度为32的字符串。

默认取值：

无

versionId

String

参数解释：

目标对象的版本号。

取值范围：

长度为32的字符串。

默认取值：

无

copySourceVersionId

String

参数解释：

源对象的版本号。

取值范围：

长度为32的字符串。

默认取值：

无

storageClass

StorageClassEnum

参数解释：

目标对象的存储类别。

取值范围：

详见StorageClassEnum。

默认取值：

无