设置对象元数据(Harmony SDK)
功能说明
元数据(Metadata)为描述对象属性的信息,是一组名称值对,用作对象管理的一部分。
当前仅支持系统定义的元数据。
系统定义的元数据又分为两种类别:系统控制和用户控制。如Last-Modified日期等数据由系统控制,不可修改;如为对象配置的ContentLanguage,用户可以通过接口进行修改。
对指定桶中的对象发送HEAD请求,设置对象的元数据信息。
接口约束
- 您必须是桶拥有者或拥有设置对象元数据的权限,才能设置对象元数据。建议使用IAM或桶策略进行授权,如果使用IAM则需授予obs:object:ModifyObjectMetaData权限,如果使用桶策略则需授予ModifyObjectMetaData权限。相关授权方式介绍可参见OBS权限控制概述,配置方式详见使用IAM自定义策略、配置对象策略。
- OBS支持的Region与Endpoint的对应关系,详细信息请参见地区与终端节点。
- 当桶开启多版本控制时,最新版本的对象支持设置元数据,历史版本的对象不支持设置元数据。
- 对于存储类别为归档存储或深度归档存储的对象,不能对其设置对象的元数据。
方法定义
setObjectMetadata(input: SetObjectMetadataInput): Response<SetObjectMetadataOutput>
请求参数
参数名称 |
参数类型 |
是否必选 |
描述 |
---|---|---|---|
input |
必选 |
参数解释: 设置对象元数据接口入参,详见SetObjectMetadataInput。 |
参数名称 |
参数类型 |
是否必选 |
描述 |
---|---|---|---|
Bucket |
string |
必选 |
参数解释: 桶名。 约束限制:
取值范围: 长度为3~63个字符。 |
Key |
string |
必选 |
参数解释: 对象名。对象名是对象在存储桶中的唯一标识。对象名是对象在桶中的完整路径,路径中不包含桶名。 例如,您对象的访问地址为examplebucket.obs.cn-north-4. myhuaweicloud.com/folder/test.txt 中,对象名为folder/test.txt。 取值范围: 长度大于0且不超过1024的字符串。 默认取值: 无 |
VersionId |
string |
可选 |
参数解释: 对象的版本号。例如:G001117FCE89978B0000401205D5DC9A。 取值范围: 长度为32的字符串。 默认取值: 无 |
CacheControl |
string |
可选 |
参数解释: 响应中的Cache-Control头。指定对象被下载时的网页的缓存行为。 默认取值: 无 |
ContentDisposition |
string |
可选 |
参数解释: 响应中的Content-Disposition头。指定对象被下载时的名称。 默认取值: 无 |
ContentEncoding |
string |
可选 |
参数解释: 响应中的Content-Encoding头。指定对象被下载时的内容编码格式。 默认取值: 无 |
ContentLanguage |
string |
可选 |
参数解释: 响应中的Content-Language头。指定对象被下载时的内容语言格式。 默认取值: 无 |
ContentType |
string |
可选 |
参数解释: 响应中的Content-Type头。指定对象被下载时的文件类型。 默认取值: 无 |
Expires |
string |
可选 |
参数解释: 响应中的Expires头。指定对象被下载时的网页的缓存过期时间。 默认取值: 无 |
WebsiteRedirectLocation |
string |
可选 |
参数解释: 当桶设置了Website配置,可以将获取这个对象的请求重定向到桶内另一个对象或一个外部的URL。 例如,重定向请求到桶内另一对象: WebsiteRedirectLocation:/anotherPage.html 或重定向请求到一个外部URL: WebsiteRedirectLocation:http://www.example.com/ OBS将这个值从头域中取出,保存在对象的元数据“WebsiteRedirectLocation”中。 约束限制:
默认取值: 无 |
StorageClass |
可选 |
参数解释: 指定对象的存储类型。 取值范围: 可选择的存储类型参见StorageClassType。 默认取值: 无 |
|
Metadata |
object |
可选 |
参数解释: 对象的自定义元数据。OBS支持用户使用以“x-obs-meta-”开头的消息头来加入自定义的元数据,以便对对象进行自定义管理。当用户获取此对象或查询此对象元数据时,加入的自定义元数据将会在返回的消息头中出现。 约束限制:
默认取值: 无 |
返回结果
参数类型 |
描述 |
---|---|
说明:
该接口返回是一个Promise类型,需要使用Promise、async/await语法处理。 |
参数解释: 接口返回信息,详见Response。 |
参数名称 |
参数类型 |
描述 |
---|---|---|
CommonMsg |
参数解释: 接口调用完成后的公共信息,包含HTTP状态码,操作失败的错误码等,详见ICommonMsg。 |
|
InterfaceResult |
参数解释: 操作成功后的结果数据,详见SetObjectMetadataOutput。 约束限制: 当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。 默认取值: 无 |
MetadataDirective |
参数解释: 复制源对象属性的策略。 取值范围: 可选择的对象属性选项参见MetadataDirectiveType。 默认取值: 无 |
|
CacheControl |
string |
参数解释: 响应中的Cache-Control头。指定对象被下载时的网页的缓存行为。 默认取值: 无 |
ContentDisposition |
string |
参数解释: 响应中的Content-Disposition头。指定对象被下载时的名称。 默认取值: 无 |
ContentEncoding |
string |
参数解释: 响应中的Content-Encoding头。指定对象被下载时的内容编码格式。 默认取值: 无 |
ContentLanguage |
string |
参数解释: 响应中的Content-Language头。指定对象被下载时的内容语言格式。 默认取值: 无 |
ContentType |
string |
参数解释: 响应中的Content-Type头。指定对象被下载时的文件类型。 默认取值: 无 |
Expires |
string |
参数解释: 响应中的Expires头。指定对象被下载时的网页的缓存过期时间。 默认取值: 无 |
WebsiteRedirectLocation |
string |
参数解释: 当桶设置了Website配置,可以将获取这个对象的请求重定向到桶内另一个对象或一个外部的URL。 例如,重定向请求到桶内另一对象: WebsiteRedirectLocation:/anotherPage.html 或重定向请求到一个外部URL: WebsiteRedirectLocation:http://www.example.com/ OBS将这个值从头域中取出,保存在对象的元数据“WebsiteRedirectLocation”中。 约束限制:
默认取值: 无 |
StorageClass |
参数解释: 复制时设置对象的存储类型。如果未设置此头域,则以桶的默认存储类型作为对象的存储类型。 取值范围: 可选择的存储类型参见StorageClassType。 默认取值: 无 |
|
Metadata |
object |
参数解释: 对象的自定义元数据。OBS支持用户使用以“x-obs-meta-”开头的消息头来加入自定义的元数据,以便对对象进行自定义管理。当用户获取此对象或查询此对象元数据时,加入的自定义元数据将会在返回的消息头中出现。 约束限制:
默认取值: 无 |
常量名 |
原始值 |
说明 |
---|---|---|
COPY |
COPY |
复制对象时,复制源对象属性。
须知:
该值仅在复制对象(Harmony SDK)接口中使用。 |
REPLACE |
REPLACE |
使用当前请求中携带的头域完整替换,未指定的元数据会被删除。 |
REPLACE_NEW |
REPLACE_NEW |
对于已经存在值的元数据进行替换,不存在值的元数据进行赋值,未指定的元数据保持不变。
须知:
该值仅在设置对象元数据(Harmony SDK)接口中使用。 |
代码示例
本示例用于设置examplebucket桶中的example/objectname对象元数据,并且将对象MIME类型设置成image/jpeg,对象存储类型指定为归档存储,并设置自定义元数据。
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 |
// 引入依赖包 import ObsClient, { StorageClassType } 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 setObjectMetadata() { try { const params = { // 指定存储桶名称 Bucket: "examplebucket", // 指定对象,此处以 example/objectname 为例 Key: "example/objectname", // 指定对象MIME类型,这里以image/jpeg为例 ContentType: "image/jpeg", // 指定对象存储类型,这里以 StorageClassType.COLD 为例 StorageClass: StorageClassType.COLD, // 指定自定义元数据 Metadata: { "property1": "property-value1", "property2": "property-value2" } }; // 设置对象元数据 const result = await obsClient.setObjectMetadata(params); if (result.CommonMsg.Status <= 300) { console.log("Set Object(%s)'s metadata successful with bucket(%s)!", params.Key, params.Bucket); console.log("RequestId: %s", result.CommonMsg.RequestId); 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); } } setObjectMetadata(); |