对象存储服务 OBS-下载对象-断点续传下载(Go SDK):请求参数说明
请求参数说明
参数名称 |
参数类型 |
是否必选 |
描述 |
---|---|---|---|
input |
必选 |
参数解释: 断点续传下载请求参数,详见DownloadFileInput。 |
|
extensions |
extensionOptions |
可选 |
参数解释: 拓展配置项。通过调用拓展配置项为对应请求配置额外的拓展请求头,详情参考extensionOptions。 |
参数名称 |
参数类型 |
是否必选 |
描述 |
---|---|---|---|
Bucket |
string |
必选 |
参数解释: 桶名。 约束限制:
默认取值: 无 |
Key |
string |
必选 |
参数解释: 对象名。对象名是对象在存储桶中的唯一标识。对象名是对象在桶中的完整路径,路径中不包含桶名。 例如,您对象的访问地址为examplebucket.obs.cn-north-4. emyhuaweicloud.com/folder/test.txt 中,对象名为folder/test.txt。 取值范围: 长度大于0且不超过1024的字符串。 默认取值: 无 |
VersionId |
string |
可选 |
参数解释: 对象的版本号,用于获取指定版本号的对象。例如:G001117FCE89978B0000401205D5DC9。 取值范围: 长度为32的字符串。 默认取值: 无,如果不设置则默认获取最新版本的对象。 |
DownloadFile |
string |
可选 |
参数解释: 下载对象的本地文件全路径。 默认取值: 当该值为空时,默认为当前程序的运行目录。 |
PartSize |
int64 |
可选 |
参数解释: 分段大小。 取值范围: 大于0,小于对象大小,单位:字节。 默认取值: 9437184,即每段9MB。 |
TaskNum |
int |
可选 |
参数解释: 分段下载时的最大并发数。 取值范围: (0, 文件大小/分段大小],即大于0小于等于文件大小除以分段大小向上取整。 默认取值: 1,即不设置则默认串行下载。 |
EnableCheckpoint |
bool |
可选 |
参数解释: 是否开启断点续传模式。 取值范围:
默认取值: false |
CheckpointFile |
string |
可选 |
参数解释: 记录下载进度文件的文件路径,只在断点续传模式下有效。 默认取值: 当该值为空时,默认与下载对象的本地文件路径同目录。 |
SseHeader |
可选 |
参数解释: 服务端解密头信息,详见SseCHeader。 |
|
IfMatch |
string |
可选 |
参数解释: 指定一个预设的Etag值,如果下载对象的ETag值与该参数值相同,则返回对象内容,否则返回错误。 取值范围: 长度为32的字符串。 默认取值: 无 |
IfNoneMatch |
string |
可选 |
参数解释: 指定一个预设的Etag值,如果下载对象的ETag值与该参数值不相同,则返回对象内容,否则返回错误。 取值范围: 长度为32的字符串。 默认取值: 无 |
IfModifiedSince |
time.Time |
可选 |
参数解释: 如果对象在指定的时间后有修改,则返回对象内容,否则返回错误。 约束限制: 日期格式必须为ISO8601的格式。 例如:2018-01-01T00:00:00.000Z,表示如果最后修改时间晚于2018-01-01T00:00:00.000Z则返回对象内容,否则返回错误。 代码示例:time.Now().Add(time.Duration(24) * time.Hour)。 默认取值: 无 |
IfUnmodifiedSince |
time.Time |
可选 |
参数解释: 如果对象在指定的时间后没有修改,则返回对象内容,否则返回错误。 约束限制: 日期格式必须为ISO8601的格式。 例如:2018-01-01T00:00:00.000Z,表示如果最后修改时间早于2018-01-01T00:00:00.000Z则返回对象内容,否则返回错误。 代码示例:time.Now().Add(time.Duration(24) * time.Hour)。 默认取值: 无 |
参数名称 |
参数类型 |
是否必选 |
描述 |
---|---|---|---|
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== 默认取值: 无 |