九游平台/ 对象存储服务 obs/ sdk参考/ node.js/ / 获取对象元数据(node.js sdk)
更新时间：2024-10-11 gmt 08:00

获取对象元数据(node.js sdk)-九游平台

开发过程中，您有任何问题可以在github上，或者在中发帖求助。

功能说明

元数据（metadata）为描述对象属性的信息，是一组名称值对，用作对象管理的一部分。

当前仅支持系统定义的元数据。系统定义的元数据又分为两种类别：系统控制和用户控制。如last-modified日期等数据由系统控制，不可修改；如为对象配置的contentlanguage，用户可以通过接口进行修改。

对指定桶中的对象发送head请求，获取对象的元数据信息。

接口约束

  • 您必须是桶拥有者或拥有获取对象元数据的权限，才能获取对象元数据。建议使用iam或桶策略进行授权，如果使用iam则需授予obs:object:getobject权限，如果使用桶策略则需授予getobject权限。相关授权方式介绍可参见obs权限控制概述，配置方式详见、。
  • obs支持的region与endpoint的对应关系，详细信息请参见。

方法定义

obsclient.getobjectmetadata(params)

请求参数

表1 请求参数列表

参数名称

参数类型

是否必选

描述

bucket

string

必选

参数解释：

桶名。

约束限制：

  • 桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。
  • 桶命名规则如下：
    • 3～63个字符，数字或字母开头，支持小写字母、数字、“-”、“.”。
    • 禁止使用ip地址。
    • 禁止以“-”或“.”开头及结尾。
    • 禁止两个“.”相邻（如：“my..bucket”）。
    • 禁止“.”和“-”相邻（如：“my-.bucket”和“my.-bucket”）。
  • 同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。

取值范围：

长度为3～63个字符。

默认取值：

无

key

string

必选

参数解释：

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

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

约束限制：

无

取值范围：

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

默认取值：

无

versionid

string

可选

参数解释：

对象的版本号。例如：g001117fce89978b0000401205d5dc9a。

约束限制：

无

取值范围：

长度为32的字符串。

默认取值：

无

origin

string

可选

参数解释：

预请求指定的跨域请求origin（通常为域名）。

约束限制：

每个匹配规则允许使用最多一个“*”通配符。

取值范围：

无

默认取值：

无

requestheader

string

可选

参数解释：

跨域请求可以使用的http头域。只有匹配上允许的头域中的配置，才被视为是合法的cors请求。

约束限制：

每个头域可填写一个“*”通配符，不支持&、:、<、空格以及中文字符。

取值范围：

无

默认取值：

无

ssec

string

当使用sse-c方式时，必选

参数解释：

以sse-c方式解密对象。

约束限制：

仅支持aes256。

取值范围：

可选值：aes256。

默认取值：

无

sseckey

string

当使用sse-c方式时，必选

参数解释：

sse-c方式下解密的密钥，该密钥用于解密对象。

约束限制：

该头域由256bit的密钥经过base64编码得到，示例：k7qkypbkm5 hca27fsnkunnvaobncnlht/rcb2o/9cw=

取值范围：

无

默认取值：

无

返回结果

表2 返回结果

参数类型

描述

表3

说明：

该接口返回是一个promise类型，需要使用promise、async/await语法处理。

参数解释：

接口返回信息，详见表3。
表3 response

参数名称

参数类型

描述

commonmsg

icommonmsg

参数解释：

接口调用完成后的公共信息，包含http状态码，操作失败的错误码等，详见icommonmsg。

interfaceresult

表5

参数解释：

操作成功后的结果数据，详见表5。

约束限制：

当status大于300时为空。
表4 icommonmsg

参数名称

参数类型

描述

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服务端返回的详细错误码。
表5 getobjectmetadataoutput

参数名称

参数类型

描述

requestid

string

参数解释：

obs服务端返回的请求id。

storageclass

storageclasstype

参数解释：

复制时设置对象的存储类别。如果未设置此头域，则以桶的默认存储类型作为对象的存储类型。

取值范围：

可选择的存储类型参见storageclasstype。

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方法：

  • get
  • put
  • head
  • post
  • delete

默认取值：

无

exposeheader

string

参数解释：

桶cors规则中的exposeheader。exposeheader是指cors规则允许响应中可返回的附加头域，给客户端提供额外的信息。默认情况下浏览器只能访问以下头域：content-length、content-type，如果需要访问其他头域，需要在附加头域中配置。

约束限制：

不支持*、&、:、<、空格以及中文字符。

默认取值：

无

maxageseconds

number

参数解释：

桶cors规则中的maxageseconds。maxageseconds指请求来源的客户端可以对跨域请求返回结果的缓存时间。

约束限制：

每个corsrule可以包含至多一个maxageseconds。

取值范围：

0~（231-1），单位：秒。

默认取值：

100，单位：秒。

contentlength

number

参数解释：

对象数据的长度。

取值范围：

0~（263-1），单位：字节。

默认取值：

无

contenttype

string

参数解释：

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

取值范围：

常见的content-type（mime）列表参见

默认取值：

如果您在上传object时未指定content-type，sdk会根据指定object名称的后缀名来判定文件类型并自动填充content-type。

lastmodified

string

参数解释：

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

约束限制：

日期格式必须为iso8601的格式。 例如：2018-01-01t00:00:00.000z，表示最后一次修改时间为2018-01-01t00:00:00.000z。

默认取值：

无

etag

string

参数解释：

对象的etag值。对象的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”中。

约束限制：

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

默认取值：

无

metadata

object

参数解释：

对象的自定义元数据。obs支持用户使用以“x-obs-meta-”开头的消息头来加入自定义的元数据，以便对对象进行自定义管理。当用户获取此对象或查询此对象元数据时，加入的自定义元数据将会在返回的消息头中出现。

约束限制：

  • 所有自定义元数据大小的总和不超过8k。单个自定义元数据大小的计算方式为：每个键和值的utf-8 编码中的字节总数。
  • 自定义元数据的key值不区分大小写，obs统一转为小写进行存储。value值区分大小写。
  • 自定义元数据key-value对都必须符合us-ascii。如果一定要使用非ascii码或不可识别字符，需要客户端自行做编解码处理，可以采用url编码或者base64编码，服务端不会做解码处理。例如x-obs-meta-中文：中文 经url编码后发送，“中文”的url编码为：中文，则响应为x-obs-meta-中文: 中文

默认取值：

无
表6 storageclasstype

常量名

原始值

说明

obsclient.enums.storageclassstandard

standard

标准存储。

标准存储拥有低访问时延和较高的吞吐量，适用于有大量热点对象（平均一个月多次）或小对象（<1mb），且需要频繁访问数据的业务场景。

obsclient.enums.storageclasswarm

warm

低频访问存储。

低频访问存储适用于不频繁访问（平均一年少于12次）但在需要时也要求能够快速访问数据的业务场景。

obsclient.enums.storageclasscold

cold

归档存储。

归档存储适用于很少访问（平均一年访问一次）数据的业务场景。

无

deep_archive

深度归档存储（受限公测）

适用于长期不访问（平均几年访问一次）数据的业务场景

代码示例

您可以通过obsclient.getobjectmetadata来获取对象元数据信息，包括对象长度，对象mime类型，对象自定义元数据等信息。以下代码展示了如何获取名为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
47
48
49
50
 
// 引入obs库
// 使用npm安装
constobsclient=require("esdk-obs-nodejs");
// 使用源码安装
// var obsclient = require('./lib/obs');
// 创建obsclient实例
constobsclient=newobsclient({
// 推荐通过环境变量获取aksk，这里也可以使用其他外部引入方式传入，如果使用硬编码可能会存在泄露风险
// 您可以登录访问管理控制台获取访问密钥ak/sk，获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html
access_key_id:process.env.access_key_id,
secret_access_key:process.env.secret_access_key,
// 【可选】如果使用临时ak/sk和securitytoken访问obs，同样建议您尽量避免使用硬编码，以降低信息泄露风险。您可以通过环境变量获取访问密钥ak/sk，也可以使用其他外部引入方式传入
// security_token: process.env.security_token,
// endpoint填写bucket对应的endpoint, 这里以华北-北京四为例，其他地区请按实际情况填写
server:"https://obs.cn-north-4.myhuaweicloud.com",
});
asyncfunctiongetobjectmetadata(){
try{
constparams={
// 指定存储桶名称
bucket:"examplebucket",
// 指定对象名，此处以 example/objectname 为例
key:'example/objectname',
};
// 获取对象元数据
constresult=awaitobsclient.getobjectmetadata(params);
if(result.commonmsg.status<=300){
console.log("put bucket(%s) successful!",params.bucket);
console.log("requestid: %s",result.commonmsg.requestid);
console.log("storageclass:%s, etag:%s, contenttype:%s, contentlength:%d, lastmodified:%s\n",
result.interfaceresult.storageclass,result.interfaceresult.etag,result.interfaceresult.contenttype,
result.interfaceresult.contentlength,result.interfaceresult.lastmodified);
// 获取对象自定义元数据        
console.log("metadata:%v",result.interfaceresult.metadata);
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);
};
};
getobjectmetadata();
父主题：

相关文档

网站地图