OBS NODE.JS SDK-下载对象:请求参数
下载OBS NODE.JS SDK用户手册完整版
请求参数
字段名 |
类型 |
约束 |
说明 |
|---|---|---|---|
Bucket |
String |
必选 |
桶名。 |
Key |
String |
必选 |
对象名。 |
VersionId |
String |
可选 |
对象的版本号。 |
ProgressCallback |
Function |
可选 |
获取下载进度的回调函数。 说明：
该回调函数依次包含三个参数：已下载字节数、总字节数、已使用的时间（单位：秒）。 |
IfMatch |
String |
可选 |
如果对象的ETag值与该参数值相同，则返回对象内容，否则返回异常码。 |
IfModifiedSince |
String |
可选 |
如果对象的修改时间晚于该参数值指定的时间，则返回对象内容，否则返回异常码。该参数值必须符合http://www.ietf.org/rfc/rfc2616.txt规定的HTTP时间格式。 |
IfNoneMatch |
String |
可选 |
如果对象的ETag值与该参数值不相同，则返回对象内容，否则返回异常码。 |
IfUnmodifiedSince |
String |
可选 |
如果对象的修改时间早于该参数值指定的时间，则返回对象内容，否则返回异常码。该参数值必须符合http://www.ietf.org/rfc/rfc2616.txt规定的HTTP时间格式。 |
Range |
String |
可选 |
指定下载的范围，取值区间：[0，对象长度-1]，格式：bytes=x-y。如果Range的最大长度超出对象长度-1，仍旧取对象长度-1。 |
Origin |
String |
可选 |
预请求指定的跨域请求Origin（通常为 域名 ）。 |
RequestHeader |
String |
可选 |
跨域请求可以使用的HTTP头域。 |
ResponseCacheControl |
String |
可选 |
重写响应中的Cache-Control头。 |
ResponseContentDisposition |
String |
可选 |
重写响应中的Content-Disposition头。 |
ResponseContentEncoding |
String |
可选 |
重写响应中的Content-Encoding头。 |
ResponseContentLanguage |
String |
可选 |
重写响应中的Content-Language头。 |
ResponseContentType |
String |
可选 |
重写响应中的Content-Type头。 |
ResponseExpires |
String |
可选 |
重写响应中的Expires头。 |
ImageProcess |
String |
可选 |
图片处理参数。 |
SaveAsFile |
String |
可选 |
下载对象的目标路径，包含文件名。 |
SaveAsStream |
Boolean |
可选 |
是否将对象以流（stream.Readable）的形式返回。 |
SseC |
String |
可选 |
以SSE-C方式解密对象，支持的值：
|
SseCKey |
Buffer |
可选 |
SSE-C方式下解密的密钥，由AES256算法算出。 |
- SaveAsFile和SaveAsStream不能同时使用。
- 如果包含IfUnmodifiedSince并且不符合或者包含IfMatch并且不符合，抛出异常中HTTP状态码为：412 precondition failed。
- 如果包含IfModifiedSince并且不符合或者包含IfNoneMatch并且不符合，抛出异常中HTTP状态码为：304 Not Modified。
