下载对象(Harmony SDK)
功能说明
您可以根据需要将存储在OBS中的对象下载到本地。
接口约束
- 您必须是桶拥有者或拥有下载对象的权限,才能下载对象。建议使用IAM或桶策略进行授权,如果使用IAM则需授予obs:object:GetObject权限,如果使用桶策略则需授予GetObject权限。相关授权方式介绍可参见OBS权限控制概述,配置方式详见使用IAM自定义策略、配置对象策略。
- OBS支持的Region与Endpoint的对应关系,详细信息请参见地区与终端节点。
- 对于存储类别为归档存储或深度归档存储的对象,需要确认对象的状态为“已恢复”才能对其进行下载。
方法定义
getObject(input: GetObjectInput): Response<GetObjectOutput>
请求参数
参数名称 |
参数类型 |
是否必选 |
描述 |
---|---|---|---|
input |
必选 |
参数解释: 下载对象接口入参,详见GetObjectInput。 |
参数名称 |
参数类型 |
是否必选 |
描述 |
---|---|---|---|
Bucket |
string |
必选 |
参数解释: 桶名。 约束限制:
默认取值: 无 |
Key |
string |
必选 |
参数解释: 对象名。对象名是对象在存储桶中的唯一标识。对象名是对象在桶中的完整路径,路径中不包含桶名。 例如,您对象的访问地址为examplebucket.obs.cn-north-4. myhuaweicloud.com/folder/test.txt 中,对象名为folder/test.txt。 取值范围: 长度大于0且不超过1024的字符串。 默认取值: 无 |
VersionId |
string |
可选 |
参数解释: 对象的版本号,用于获取指定版本号的对象。例如:G001117FCE89978B0000401205D5DC9。 取值范围: 长度为32的字符串。 默认取值: 无,如果不设置则默认获取最新版本的对象。 |
SaveByType |
可选 |
参数解释: 文件下载时的保存路径。 取值范围: 可选择的数据类型选项参见SaveByType。 默认取值: 无 |
|
SaveFilePath |
string |
可选 |
参数解释: 指定下载路径。 约束限制: 格式需要在cacheDir路径下,示例如下: getContext(this).cacheDir + '/folder/filename'
须知:
如果指定该参数,SaveByType 参数会被忽略掉。 默认取值: 无 |
Range |
string |
可选 |
参数解释: 获取对象时,获取在Range范围内的对象内容。如果Range不合法则忽略此字段获取整个对象。 取值范围:
取值范围: Range是一个范围,它的起始值最小为0,最大为对象长度减1。 默认取值: 无 |
SseC |
string |
作为请求参数时必选 |
参数解释: 表示服务端加密是SSE-C方式。对象使用SSE-C加密方式。 取值范围: 可选值:AES256,即选择SSE-C方式加密对象。 默认取值: 无 |
SseCKey |
string |
作为请求参数时必选 |
参数解释: SSE-C方式下加密使用的密钥,该密钥用于加密对象。 约束限制: 该头域由256bit的密钥经过Base64编码得到,示例:K7QkYpBkM5+hca27fsNkUnNVaobncnLht/rCB2o/9Cw=。 默认取值: 无 |
ResponseCacheControl |
string |
可选 |
参数解释: 指定OBS返回请求中Cache-Control头的值。指定Object被下载时的网页的缓存行为。 默认取值: 无 |
ResponseContentDisposition |
string |
可选 |
参数解释: 指定OBS返回请求中Content-Disposition头的值。指定Object被下载时的名称。 默认取值: 无 |
ResponseContentEncoding |
string |
可选 |
参数解释: 指定OBS返回请求中Content-Encoding头的值。指定Object被下载时的内容编码格式。 默认取值: 无 |
ResponseContentLanguage |
string |
可选 |
参数解释: 指定OBS返回请求中Content-Language头的值。指定Object被下载时的内容语言格式。 默认取值: 无 |
ResponseContentType |
string |
可选 |
参数解释: 指定OBS返回请求中Content-Type头的值。指定Object文件类型。 默认取值: 无 |
ResponseExpires |
string |
可选 |
参数解释: 指定OBS返回请求中Expires头的值。指定Object被下载时的网页的缓存过期时间。 默认取值: 无 |
ImageProcess |
string |
可选 |
参数解释: 图片处理参数,描述针对对象的图片处理命令或处理样式。例如表示对图片依次进行缩放、旋转,取值:image/resize,m_fixed,w_100,h_100/rotate,90。 取值范围: 命令方式:image/命令参数。 样式方式:style/样式名称。 详细参数说明参见处理图片。 默认取值: 如果不输入处理命令,将返回原图。 |
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)。 默认取值: 无 |
常量名 |
原始值 |
说明 |
---|---|---|
TEXT |
string |
文本格式。 |
ARRAY_BUFFER |
array_buffer |
二进制格式。 |
OBJECT |
object |
对象格式。 |
FILE |
file |
文件格式。 |
- 如果包含IfUnmodifiedSince并且不符合或者包含IfMatch并且不符合,抛出异常中HTTP状态码为:412 precondition failed。
- 如果包含IfModifiedSince并且不符合或者包含IfNoneMatch并且不符合,抛出异常中HTTP状态码为:304 Not Modified。
返回结果
参数类型 |
描述 |
---|---|
说明:
该接口返回是一个Promise类型,需要使用Promise、async/await语法处理。 |
参数解释: 接口返回信息,详见Response。 |
参数名称 |
参数类型 |
描述 |
---|---|---|
CommonMsg |
参数解释: 接口调用完成后的公共信息,包含HTTP状态码,操作失败的错误码等,详见ICommonMsg。 |
|
InterfaceResult |
参数解释: 操作成功后的结果数据,详见GetObjectOutput。 约束限制: 当Status大于300时为空。 |
参数名称 |
参数类型 |
描述 |
---|---|---|
Status |
number |
参数解释: OBS服务端返回的HTTP状态码。 取值范围: 状态码是一组从2xx(成功)到4xx或5xx(错误)的数字代码,状态码表示了请求响应的状态。完整的状态码列表请参见状态码。 |
Code |
string |
参数解释: OBS服务端返回的错误码。 |
Message |
string |
参数解释: OBS服务端返回的错误描述。 |
HostId |
string |
参数解释: OBS服务端返回的请求服务端ID。 |
RequestId |
string |
参数解释: OBS服务端返回的请求ID。 |
Id2 |
string |
参数解释: OBS服务端返回的请求ID2。 |
Indicator |
string |
参数解释: OBS服务端返回的详细错误码。 |
参数名称 |
参数类型 |
描述 |
---|---|---|
RequestId |
string |
参数解释: OBS服务端返回的请求ID。 默认取值: 无 |
Body |
io.ReadCloser |
参数解释: 下载对象的数据流。 默认取值: 无 |
StorageClass |
参数解释: 对象的存储类型。 取值范围:
默认取值: 无 |
|
AllowOrigin |
string |
参数解释: 如果请求中的Origin满足桶的CORS规则,则返回CORS规则中的AllowedOrigin。AllowedOrigin指定允许的跨域请求的来源,即允许来自该域名下的请求访问该对象。 约束限制: 表示域名的字符串,每个匹配规则允许使用最多一个“*”通配符。例如:https://*.vbs.example.com。 默认取值: 无 |
AllowHeader |
string |
参数解释: 如果请求的RequestHeader满足桶的CORS规则,则返回CORS规则中的AllowedHeader。AllowedHeader是指允许的跨域请求的头域。只有匹配上允许的头域中的配置,才被视为是合法的CORS请求。 约束限制: 最多可填写一个“*”通配符,不支持&、:、<、空格以及中文字符。 默认取值: 无 |
AllowMethod |
string |
参数解释: 桶CORS规则中的AllowedMethod。AllowedMethod指允许的跨域请求HTTP方法,即桶和对象的几种操作类型。 取值范围: 支持以下HTTP方法:
默认取值: 无 |
ExposeHeader |
string |
参数解释: 桶CORS规则中的ExposeHeader。ExposeHeader是指CORS规则允许响应中可返回的附加头域,给客户端提供额外的信息。默认情况下浏览器只能访问以下头域:Content-Length、Content-Type,如果需要访问其他头域,需要在附加头域中配置。 约束限制: 不支持*、&、:、<、空格以及中文字符。 默认取值: 无 |
MaxAgeSeconds |
number |
参数解释: 桶CORS规则中的MaxAgeSeconds。MaxAgeSeconds指请求来源的客户端可以对跨域请求返回结果的缓存时间。 约束限制: 每个CORSRule可以包含至多一个MaxAgeSeconds。 取值范围: 0~(231-1),单位:秒。 默认取值: 100,单位:秒。 |
ContentLength |
number |
参数解释: 对象数据的长度。 取值范围: 0~48.8TB,单位:字节。 默认取值: 无 |
CacheControl |
string |
参数解释: 响应中的Cache-Control头。指定对象被下载时的网页的缓存行为。 默认取值: 无 |
ContentDisposition |
string |
参数解释: 响应中的Content-Disposition头。 默认取值: 无 |
ContentEncoding |
string |
参数解释: 响应中的Content-Encoding头。 默认取值: 无 |
ContentLanguage |
string |
参数解释: 响应中的Content-Language头。 默认取值: 无。 |
ContentType |
string |
参数解释: 对象的文件类型(MIME类型)。Content-Type(MIME)用于标识发送或接收数据的类型,浏览器根据该参数来决定数据的打开方式。 取值范围: 常见的Content-Type(MIME)列表参见获取理解Content-Type(MIME)?(Harmony SDK) 默认取值: 如果您在上传Object时未指定Content-Type,SDK会根据指定Object名称的后缀名来判定文件类型并自动填充Content-Type。 |
Expires |
string |
参数解释: 响应中的Expires头。 默认取值: 无 |
LastModified |
string |
参数解释: 对象的最近一次修改时间。 约束限制: 日期格式必须为ISO8601的格式。 例如:2018-01-01T00:00:00.000Z,表示最后一次修改时间为2018-01-01T00:00:00.000Z。 默认取值: 无 |
ETag |
string |
参数解释: 对象的base64编码的128位MD5摘要。ETag是对象内容的唯一标识,可以通过该值识别对象内容是否有变化。比如上传对象时ETag为A,下载对象时ETag为B,则说明对象内容发生了变化。ETag只反映变化的内容,而不是其元数据。上传的对象或复制操作创建的对象,都有唯一的ETag。 约束限制: 当对象是服务端加密的对象时,ETag值不是对象的MD5值。 取值范围: 长度为32的字符串。 默认取值: 无 |
VersionId |
string |
参数解释: 对象的版本号。 取值范围: 长度为32的字符串。 默认取值: 无 |
Restore |
string |
参数解释: 标识对象的恢复状态。对象为归档存储或深度归档存储类型,并且处于正在恢复或已经恢复时,会返回此头域。 示例:正在恢复ongoing-request="true";已恢复 ongoing-request="false", expiry-date="Wed, 7 Nov 2012 00:00:00 GMT"。其中expiry-date值表示对象恢复后的失效时间。 约束限制: 归档存储类型对象的恢复状态,如果对象不为归档存储类型,则该值为空。 默认取值: 无 |
Expiration |
string |
参数解释: 对象的详细过期信息。比如:"expiry-date=\"Mon, 11 Sep 2023 00:00:00 GMT\"" 默认取值: 无 |
WebsiteRedirectLocation |
string |
参数解释: 当桶设置了Website配置,可以将获取这个对象的请求重定向到桶内另一个对象或一个外部的URL,该参数指明对象的重定向地址。 例如,重定向请求到桶内另一对象: WebsiteRedirectLocation:/anotherPage.html 或重定向请求到一个外部URL: WebsiteRedirectLocation:http://www.example.com/ OBS将这个值从头域中取出,保存在对象的元数据“WebsiteRedirectLocation”中。 约束限制:
默认取值: 无 |
Metadata |
object |
参数解释: 对象自定义元数据。OBS支持用户使用以“x-obs-meta-”开头的消息头来加入自定义的元数据,以便对对象进行自定义管理。当用户获取此对象或查询此对象元数据时,加入的自定义元数据将会在返回的消息头中出现。 约束限制:
默认取值: 无 |
DeleteMarker |
boolean |
参数解释: 标识删除的对象是否是删除标记。 取值范围:
默认取值: false |
代码示例-文本下载
本示例用于文本下载examplebucket桶中的example/objectname对象。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 |
// 引入依赖包 import ObsClient, { GetObjectInput } from '@obs/esdk-obs-harmony'; // 创建ObsClient实例 const obsClient = new ObsClient({ // 推荐通过环境变量获取AKSK,这里也可以使用其他外部引入方式传入,如果使用硬编码可能会存在泄露风险 // 您可以登录访问管理控制台获取访问密钥AK/SK,获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.htmlhttps://support.huaweicloud.com/intl/zh-cn/usermanual-ca/ca_01_0003.htmlhttps://support.huaweicloud.com/eu/usermanual-ca/ca_01_0003.html AccessKeyId: process.env.ACCESS_KEY_ID, SecretAccessKey: process.env.SECRET_ACCESS_KEY, // 【可选】如果使用临时AK/SK和SecurityToken访问OBS,同样建议您尽量避免使用硬编码,以降低信息泄露风险。您可以通过环境变量获取访问密钥AK/SK,也可以使用其他外部引入方式传入。 // SecurityToken: process.env.SECURITY_TOKEN, // Server填写Bucket对应的Endpoint, 这里以华北-北京四为例,其他地区请按实际情况填写。 Server: "https://obs.cn-north-4.myhuaweicloud.com", }); async function getObject() { try { const params: GetObjectInput = { // 指定存储桶名称 Bucket: "examplebucket", // 指定下载对象,此处以 example/objectname 为例。 Key: 'example/objectname', }; // 文本下载对象 const result = await obsClient.getObject(params); if (result.CommonMsg.Status <= 300) { console.log("Get object(%s) under the bucket(%s) successful!", params.Key, params.Bucket); console.log("RequestId: %s", result.CommonMsg.RequestId); console.log('Object Content: %s', result.InterfaceResult.Content); return; } console.log("An ObsError was found, which means your request sent to OBS was rejected with an error response.") console.log("Status: %d", result.CommonMsg.Status); console.log("Code: %s", result.CommonMsg.Code); console.log("Message: %s", result.CommonMsg.Message); console.log("RequestId: %s", result.CommonMsg.RequestId); } catch (error) { console.log("An Exception was found, which means the client encountered an internal problem when attempting to communicate with OBS, for example, the client was unable to access the network.") console.log(error); } } getObject(); |
代码示例-范围下载
本示例用于范围下载examplebucket桶中的example/objectname对象,并且指定下载范围是0~1000。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 |
// 引入依赖包 import ObsClient, { GetObjectInput } from '@obs/esdk-obs-harmony'; // 创建ObsClient实例 const obsClient = new ObsClient({ // 推荐通过环境变量获取AKSK,这里也可以使用其他外部引入方式传入,如果使用硬编码可能会存在泄露风险 // 您可以登录访问管理控制台获取访问密钥AK/SK,获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.htmlhttps://support.huaweicloud.com/intl/zh-cn/usermanual-ca/ca_01_0003.htmlhttps://support.huaweicloud.com/eu/usermanual-ca/ca_01_0003.html AccessKeyId: process.env.ACCESS_KEY_ID, SecretAccessKey: process.env.SECRET_ACCESS_KEY, // 【可选】如果使用临时AK/SK和SecurityToken访问OBS,同样建议您尽量避免使用硬编码,以降低信息泄露风险。您可以通过环境变量获取访问密钥AK/SK,也可以使用其他外部引入方式传入。 // SecurityToken: process.env.SECURITY_TOKEN, // Server填写Bucket对应的Endpoint, 这里以华北-北京四为例,其他地区请按实际情况填写。 Server: "https://obs.cn-north-4.myhuaweicloud.com", }); async function getObject() { try { const params: GetObjectInput = { // 指定存储桶名称 Bucket: "examplebucket", // 指定下载对象,此处以 example/objectname 为例。 Key: 'example/objectname', // 指定下载范围 Range: 'bytes=0-1000' }; // 范围下载对象 const result = await obsClient.getObject(params); if (result.CommonMsg.Status <= 300) { console.log("Get object(%s) under the bucket(%s) successful!", params.Key, params.Bucket); console.log("RequestId: %s", result.CommonMsg.RequestId); console.log('Object Content: %s', result.InterfaceResult.Content); return; } console.log("An ObsError was found, which means your request sent to OBS was rejected with an error response.") console.log("Status: %d", result.CommonMsg.Status); console.log("Code: %s", result.CommonMsg.Code); console.log("Message: %s", result.CommonMsg.Message); console.log("RequestId: %s", result.CommonMsg.RequestId); } catch (error) { console.log("An Exception was found, which means the client encountered an internal problem when attempting to communicate with OBS, for example, the client was unable to access the network.") console.log(error); } } getObject(); |
代码示例-限定条件下载
本示例用于限定条件下载examplebucket桶中的example/objectname对象,并且指定该文件的修改时间必须在"Wed, 04 Jul 2024 08:54:53 GMT"后才能下载成功。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 |
// 引入依赖包 import ObsClient, { GetObjectInput } from '@obs/esdk-obs-harmony'; // 创建ObsClient实例 const obsClient = new ObsClient({ // 推荐通过环境变量获取AKSK,这里也可以使用其他外部引入方式传入,如果使用硬编码可能会存在泄露风险 // 您可以登录访问管理控制台获取访问密钥AK/SK,获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.htmlhttps://support.huaweicloud.com/intl/zh-cn/usermanual-ca/ca_01_0003.htmlhttps://support.huaweicloud.com/eu/usermanual-ca/ca_01_0003.html AccessKeyId: process.env.ACCESS_KEY_ID, SecretAccessKey: process.env.SECRET_ACCESS_KEY, // 【可选】如果使用临时AK/SK和SecurityToken访问OBS,同样建议您尽量避免使用硬编码,以降低信息泄露风险。您可以通过环境变量获取访问密钥AK/SK,也可以使用其他外部引入方式传入。 // SecurityToken: process.env.SECURITY_TOKEN, // Server填写Bucket对应的Endpoint, 这里以华北-北京四为例,其他地区请按实际情况填写。 Server: "https://obs.cn-north-4.myhuaweicloud.com", }); async function getObject() { try { const params: GetObjectInput = { // 指定存储桶名称 Bucket: "examplebucket", // 指定下载对象,此处以 example/objectname 为例。 Key: 'example/objectname', // 如果下载对象在给定的日期之后存在修改,才会下载成功。否则返回不带消息主题的304响应。 IfModifiedSince: 'Wed, 04 Jul 2024 08:54:53 GMT' }; // 限定条件下载对象 const result = await obsClient.getObject(params); if (result.CommonMsg.Status <= 300) { console.log("Get object(%s) under the bucket(%s) successful!", params.Key, params.Bucket); console.log("RequestId: %s", result.CommonMsg.RequestId); console.log('Object Content: %s', result.InterfaceResult.Content); return; } console.log("An ObsError was found, which means your request sent to OBS was rejected with an error response.") console.log("Status: %d", result.CommonMsg.Status); console.log("Code: %s", result.CommonMsg.Code); console.log("Message: %s", result.CommonMsg.Message); console.log("RequestId: %s", result.CommonMsg.RequestId); } catch (error) { console.log("An Exception was found, which means the client encountered an internal problem when attempting to communicate with OBS, for example, the client was unable to access the network.") console.log(error); } } getObject(); |
代码示例-图片处理
本示例用于examplebucket桶中的对象名称为example/objectname图片处理。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 |
// 引入依赖包 import ObsClient, { GetObjectInput } from '@obs/esdk-obs-harmony'; // 创建ObsClient实例 const obsClient = new ObsClient({ // 推荐通过环境变量获取AKSK,这里也可以使用其他外部引入方式传入,如果使用硬编码可能会存在泄露风险 // 您可以登录访问管理控制台获取访问密钥AK/SK,获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html AccessKeyId: process.env.ACCESS_KEY_ID, SecretAccessKey: process.env.SECRET_ACCESS_KEY, // 【可选】如果使用临时AK/SK和SecurityToken访问OBS,同样建议您尽量避免使用硬编码,以降低信息泄露风险。您可以通过环境变量获取访问密钥AK/SK,也可以使用其他外部引入方式传入 // SecurityToken: process.env.SECURITY_TOKEN, // Server填写Bucket对应的Endpoint, 这里以华北-北京四为例,其他地区请按实际情况填写 Server: "https://obs.cn-north-4.myhuaweicloud.com", }); async function getObject() { try { const params: GetObjectInput = { // 指定存储桶名称 Bucket: "examplebucket", // 指定下载对象,此处以 example/objectname 为例 Key: 'example/objectname', // 对图片依次进行缩放、旋转 ImageProcess: 'image/resize,m_fixed,w_100,h_100/rotate,90' }; // 图片处理对象 const result = await obsClient.getObject(params); if (result.CommonMsg.Status <= 300) { console.log("Get object(%s) under the bucket(%s) successful!", params.Key, params.Bucket); console.log("RequestId: %s", result.CommonMsg.RequestId); console.log('Object Content: %s', result.InterfaceResult.Content); return; } console.log("An ObsError was found, which means your request sent to OBS was rejected with an error response."); console.log("Status: %d", result.CommonMsg.Status); console.log("Code: %s", result.CommonMsg.Code); console.log("Message: %s", result.CommonMsg.Message); console.log("RequestId: %s", result.CommonMsg.RequestId); } catch (error) { console.log("An Exception was found, which means the client encountered an internal problem when attempting to communicate with OBS, for example, the client was unable to access the network."); console.log(error); } } getObject(); |