九游平台/ 对象存储服务 obs/ sdk参考/ / / 设置对象属性
更新时间：2024-04-26 gmt 08:00

设置对象属性-九游平台

开发过程中，您有任何问题可以在github上，或者在中发帖求助。接口参考文档详细介绍了每个接口的参数和使用方法。

您可以在上传对象时设置对象属性。对象属性包含对象长度、对象mime类型、对象md5值（用于校验）、对象存储类型、对象自定义元数据。对象属性可以在多种上传方式下（文本上传、文件上传、分段上传等），或时进行设置。

对象属性详细说明见下表：

名称

描述

默认值

对象长度（content-length）

上传对象的长度，超过文件的长度会截断。

文件实际长度

对象mime类型（content-type）

对象的mime类型，定义对象的类型及网页编码，决定浏览器将以什么形式、什么编码读取对象。

binary/octet-stream

对象md5值（content-md5）

对象数据的md5值（经过base64编码），提供给obs服务端，校验数据完整性。

无

对象存储类型

对象的存储类型，不同的存储类型可以满足客户业务对存储性能、成本的不同诉求。默认与桶的存储类型保持一致，可以设置为与桶的存储类型不同。

无

对象自定义元数据

用户对上传到桶中对象的自定义属性描述，以便对对象进行自定义管理。

无

设置对象长度

// 创建obsclient实例
var obsclient = new obsclient({
    // 认证用的ak和sk硬编码到代码中或者明文存储都有很大的安全风险，建议在配置文件或者环境变量中密文存放，使用时解密，确保安全；本示例以ak和sk保存在环境变量中为例，运行本示例前请先在本地环境中设置环境变量accesskeyid和secretaccesskey。
    // 前端本身没有process对象，可以使用webpack类打包工具定义环境变量，就可以在代码中运行了。
    // 您可以登录访问管理控制台获取访问密钥ak/sk，获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html
    access_key_id: process.env.accesskeyid,
    secret_access_key: process.env.secretaccesskey,
    // 这里以华北-北京四为例，其他地区请按实际情况填写
    server: 'https://obs.cn-north-4.myhuaweicloud.com'
});
obsclient.putobject({
       bucket: 'bucketname',
       key: 'objectname',
       sourcefile: document.getelementbyid('input-file').files[0],
       contentlength: 1024 * 1024 // 1mb
}, function (err, result) {
       if(err){
              console.error('error-->'   err);
       }else{
              console.log('status-->'   result.commonmsg.status);
       }
});

使用contentlength参数指定对象长度。

设置对象mime类型

// 创建obsclient实例
var obsclient = new obsclient({
    // 认证用的ak和sk硬编码到代码中或者明文存储都有很大的安全风险，建议在配置文件或者环境变量中密文存放，使用时解密，确保安全；本示例以ak和sk保存在环境变量中为例，运行本示例前请先在本地环境中设置环境变量accesskeyid和secretaccesskey。
    // 前端本身没有process对象，可以使用webpack类打包工具定义环境变量，就可以在代码中运行了。
    // 您可以登录访问管理控制台获取访问密钥ak/sk，获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html
    access_key_id: process.env.accesskeyid,
    secret_access_key: process.env.secretaccesskey,
    // 这里以华北-北京四为例，其他地区请按实际情况填写
    server: 'https://obs.cn-north-4.myhuaweicloud.com'
});
// 上传图片
obsclient.putobject({
       bucket: 'bucketname',
       key: 'objectname.jpg',
       sourcefile: document.getelementbyid('input-file').files[0],
       contenttype: 'image/jpeg'
}, function (err, result) {
       if(err){
              console.error('error-->'   err);
       }else{
              console.log('status-->'   result.commonmsg.status);
       }
});
  • 使用contenttype参数指定对象mime类型。
  • 如果不设置对象mime类型，sdk会根据上传对象的后缀名自动判断对象mime类型，如.xml判断为application/xml文件；.html判断为text/html文件。

设置对象md5值

// 创建obsclient实例
var obsclient = new obsclient({
    // 认证用的ak和sk硬编码到代码中或者明文存储都有很大的安全风险，建议在配置文件或者环境变量中密文存放，使用时解密，确保安全；本示例以ak和sk保存在环境变量中为例，运行本示例前请先在本地环境中设置环境变量accesskeyid和secretaccesskey。
    // 前端本身没有process对象，可以使用webpack类打包工具定义环境变量，就可以在代码中运行了。
    // 您可以登录访问管理控制台获取访问密钥ak/sk，获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html
    access_key_id: process.env.accesskeyid,
    secret_access_key: process.env.secretaccesskey,
    // 这里以华北-北京四为例，其他地区请按实际情况填写
    server: 'https://obs.cn-north-4.myhuaweicloud.com'
});
obsclient.putobject({
       bucket : 'bucketname',
       key : 'objectname',
       sourcefile : document.getelementbyid('input-file').files[0],
       contentmd5 : 'your md5 which should be encoded by base64'
}, function (err, result) {
       if(err){
              console.error('error-->'   err);
       }else{
              console.log('status-->'   result.commonmsg.status);
       }
});
  • 使用contentmd5参数指定对象md5值。
  • 对象数据的md5值必须经过base64编码。
  • obs服务端会将该md5值与对象数据计算出的md5值进行对比，如果不匹配则上传失败，返回http 400错误。
  • 如果不设置对象的md5值，obs服务端会忽略对对象数据的md5值校验。

设置对象存储类型

// 创建obsclient实例
var obsclient = new obsclient({
    // 认证用的ak和sk硬编码到代码中或者明文存储都有很大的安全风险，建议在配置文件或者环境变量中密文存放，使用时解密，确保安全；本示例以ak和sk保存在环境变量中为例，运行本示例前请先在本地环境中设置环境变量accesskeyid和secretaccesskey。
    // 前端本身没有process对象，可以使用webpack类打包工具定义环境变量，就可以在代码中运行了。
    // 您可以登录访问管理控制台获取访问密钥ak/sk，获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html
    access_key_id: process.env.accesskeyid,
    secret_access_key: process.env.secretaccesskey,
    // 这里以华北-北京四为例，其他地区请按实际情况填写
    server: 'https://obs.cn-north-4.myhuaweicloud.com'
});
obsclient.putobject({
       bucket : 'bucketname',
       key : 'objectname',
       sourcefile : document.getelementbyid('input-file').files[0],
       // 设置对象存储类型为归档存储
       storageclass : obsclient.enums.storageclasscold
}, function (err, result) {
       if(err){
              console.error('error-->'   err);
       }else{
              console.log('status-->'   result.commonmsg.status);
       }
});
  • 使用storageclass参数指定对象的存储类型。
  • 如果不设置，对象的存储类型默认与桶的存储类型保持一致。
  • 对象的存储类型分为三类，其含义与一致。
  • 下载归档存储类型的对象前必须将其恢复。

设置对象自定义元数据

// 创建obsclient实例
var obsclient = new obsclient({
    // 认证用的ak和sk硬编码到代码中或者明文存储都有很大的安全风险，建议在配置文件或者环境变量中密文存放，使用时解密，确保安全；本示例以ak和sk保存在环境变量中为例，运行本示例前请先在本地环境中设置环境变量accesskeyid和secretaccesskey。
    // 前端本身没有process对象，可以使用webpack类打包工具定义环境变量，就可以在代码中运行了。
    // 您可以登录访问管理控制台获取访问密钥ak/sk，获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html
    access_key_id: process.env.accesskeyid,
    secret_access_key: process.env.secretaccesskey,
    // 这里以华北-北京四为例，其他地区请按实际情况填写
    server: 'https://obs.cn-north-4.myhuaweicloud.com'
});
obsclient.putobject({
       bucket : 'bucketname',
       key : 'objectname',
       sourcefile : document.getelementbyid('input-file').files[0],
       metadata : {'property1':'property-value1', 'property2' : 'property-value2'},
}, function (err, result) {
       if(err){
              console.error('error-->'   err);
       }else{
              console.log('status-->'   result.commonmsg.status);
       }
});
  • 使用metadata参数指定对象自定义元数据。
  • 在上面设置对象自定义元数据示例代码中，用户自定义了一个名称为“property1”，值为“property-value1”的元数据和一个名称为“property2”，值为“property-value2”的元数据。
  • 一个对象可以有多个元数据，总大小不能超过8kb。
  • 对象的自定义元数据可以通过obsclient.getobjectmetadata获取，参见获取对象元数据。
  • 使用obsclient.getobject下载对象时，对象的自定义元数据也会同时下载。
父主题：

相关文档

网站地图