对象存储服务 OBS-上传段(Java SDK):请求参数说明

时间:2024-12-19 16:31:14

请求参数说明

表1 uploadPart请求参数列表

参数名称

参数类型

是否必选

描述

request

UploadPartRequest

必选

参数解释:

上传段请求参数,详见UploadPartRequest

表2 UploadPartRequest

参数名称

参数类型

是否必选

描述

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

默认取值:

partNumber

int

必选

参数解释:

段号。

取值范围:

[1,10000],超出这个范围,OBS将返回400 Bad Request错误。

默认取值:

uploadId

String

必选

参数解释:

分段上传任务的ID。任务ID可以通过初始化分段上传任务生成。例如:000001648453845DBB78F2340DD460D8。

约束限制:

长度为32的字符串。

默认取值:

input

java.io.InputStream

可选

参数解释:

待上传对象的数据流。

约束限制:

file为null,需要设置input字段不为空;input为null ,需要设置file字段不为空。二者需要选其一。

默认取值:

file

java.io.File

可选

参数解释:

待上传对象的文件。

约束限制:

file为null,需要设置input字段不为空;input为null ,需要设置file字段不为空。二者必须选其一。

默认取值:

offset

long

可选

参数解释:

源文件中某一分段的起始偏移大小。流不支持该参数。

取值范围:

非负整数,不大于待上传对象的大小,单位:字节。

默认取值:

0

partSize

Long

可选

参数解释:

当前段的长度。

约束限制:

  • 上传段接口要求除最后一段以外,其他的段大小都要大于100KB。但是上传段接口并不会立即校验上传段的大小(因为不知道是否为最后一段),只有调用合并段接口时才会校验。
  • OBS 3.0的桶支持最小段的大小为100KB,OBS 2.0的桶支持最小段的大小为5MB。

取值范围:

100KB~5GB,单位:字节。

默认取值:

102400字节

sseCHeader

SseCHeader

可选

参数解释:

服务端加密头域。详见SseCHeader

默认取值:

attachMd5

boolean

可选

参数解释:

是否自动计算待上传数据的MD5值。为了保证数据在网络传输过程中不出现错误,可以通过设置UploadPartRequest.setAttachMd5为true来让SDK自动计算每段数据的MD5值(仅在数据源为本地文件时有效),并放到Content-MD5请求头中。OBS服务端会计算上传数据的MD5值与SDK计算的MD5值比较,保证数据完整性。

约束限制:

attachMd5和contentMd5同时使用时,忽略attachMd5字段。

取值范围:

true:自动计算上传数据的MD5值。

false:不自动计算上传数据的MD5值。

默认取值:

false

contentMd5

String

可选

参数解释:

待上传段数据的MD5值(经过Base64编码),是上传段数据内容的唯一标识,可以通过该值识别对象内容是否有变化。

约束限制:

attachMd5和contentMd5同时使用时,忽略attachMd5字段。

取值范围:

长度为32的字符串。

默认取值:

progressListener

ProgressListener

可选

参数解释:

上传进度,详见ProgressListener

progressInterval

long

可选

参数解释

上传进度反馈间隔。例子:1024 * 1024L,每上传1MB数据反馈上传进度。

默认取值:

100 * 1024L,单位:字节。

autoClose

boolean

可选

参数解释:

上传完成后,自动关闭数据流。

取值范围:

true:自动关闭数据流。

false:不自动关闭数据流。

默认取值:

true

表3 SseCHeader

参数名称

参数类型

是否必选

描述

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编码后得到,该密钥用于加密对象。

默认取值:

表4 ServerAlgorithm

常量值

原始值

AES256

AES256

表5 SSEAlgorithmEnum

常量值

原始值

KMS

kms

AES256

AES256

表6 StorageClassEnum

常量名

原始值

说明

STANDARD

STANDARD

标准存储。

WARM

WARM

低频访问存储。

COLD

COLD

归档存储。

DEEP_ARCHIVE

DEEP_ARCHIVE

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

表7 ProgressListener(传输进度接口)成员如下

方法名称

返回值类型

是否必选

描述

progressChanged

void

必选

参数解释:

获取上传进度,详见progressChanged

默认取值:

表8 progressChanged参数列表

参数名称

参数类型

是否必选

描述

status

ProgressStatus

必选

参数解释:

传输进度数据,详见ProgressStatus

默认取值:

表9 ProgressStatus方法

方法名称

返回值类型

说明

getAverageSpeed()

double

上传平均速率。

getInstantaneousSpeed()

double

上传瞬时速率。

getTransferPercentage()

int

上传进度百分比。

getNewlyTransferredBytes()

long

新增的字节数。

getTransferredBytes()

long

已传输的字节数。

getTotalBytes()

long

待传输的字节数。

support.huaweicloud.com/sdk-java-devg-obs/obs_21_0616.html