更新时间:2023-11-09 GMT+08:00

设置对象属性

开发过程中,您有任何问题可以在github上提交issue接口参考文档详细介绍了每个接口的参数和使用方法。

您可以在上传对象时设置对象属性。对象属性包含对象长度、对象MIME类型、对象MD5值(用于校验)、对象存储类型、对象自定义元数据。对象属性可以在多种上传方式下(文本上传、流式上传、文件上传、分段上传),或复制对象时进行设置。

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

名称

描述

默认值

对象长度(Content-Length)

上传对象的长度,超过流/文件的长度会截断。

流/文件实际长度

对象MIME类型(Content-Type)

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

binary/octet-stream

对象MD5值(Content-MD5)

对象数据的MD5值(经过Base64编码),提供给OBS服务端,校验数据完整性。

对象存储类型

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

对象自定义元数据

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

设置对象长度

// 引入依赖库
require 'vendor/autoload.php';
// 使用源码安装时引入SDK代码库
// require 'obs-autoloader.php';
// 声明命名空间
use Obs\ObsClient;
// 创建ObsClient实例
$obsClient = new ObsClient ( [ 
      //推荐通过环境变量获取AKSK,这里也可以使用其他外部引入方式传入,如果使用硬编码可能会存在泄露风险。
      //您可以登录访问管理控制台获取访问密钥AK/SK,获取方式请参见https://support.huaweicloud.com/intl/zh-cn/usermanual-ca/ca_01_0003.html
      'key' => getenv('ACCESS_KEY_ID'),
      'secret' => getenv('SECRET_ACCESS_KEY'),
      'endpoint' => 'https://your-endpoint'
] );

$resp = $obsClient->putObject([
       'Bucket' => 'bucketname',
       'Key' => 'objectname',
       'SourceFile' => 'localfile',   // localfile为上传的本地文件路径,需要指定到具体的文件名
       'ContentLength' => 1024 * 1024 // 1MB
]);

printf("RequestId:%s\n",$resp['RequestId']);

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

设置对象MIME类型

// 引入依赖库
require 'vendor/autoload.php';
// 使用源码安装时引入SDK代码库
// require 'obs-autoloader.php';
// 声明命名空间
use Obs\ObsClient;
// 创建ObsClient实例
$obsClient = new ObsClient ( [ 
      //推荐通过环境变量获取AKSK,这里也可以使用其他外部引入方式传入,如果使用硬编码可能会存在泄露风险。
      //您可以登录访问管理控制台获取访问密钥AK/SK,获取方式请参见https://support.huaweicloud.com/intl/zh-cn/usermanual-ca/ca_01_0003.html
      'key' => getenv('ACCESS_KEY_ID'),
      'secret' => getenv('SECRET_ACCESS_KEY'),
      'endpoint' => 'https://your-endpoint'
] );

$resp = $obsClient->putObject([
       'Bucket' => 'bucketname',
       'Key' => 'objectname.jpg',
       'SourceFile' => 'localimage.jpg',
       'ContentType' => 'image/jpeg'
]);

printf("RequestId:%s\n",$resp['RequestId']);
  • 使用ContentType参数指定对象MIME类型。
  • 如果不设置对象MIME类型,SDK会根据上传对象的后缀名自动判断对象MIME类型,如.xml判断为application/xml文件;.html判断为text/html文件。

设置对象MD5值

// 引入依赖库
require 'vendor/autoload.php';
// 使用源码安装时引入SDK代码库
// require 'obs-autoloader.php';
// 声明命名空间
use Obs\ObsClient;
// 创建ObsClient实例
$obsClient = new ObsClient ( [ 
      //推荐通过环境变量获取AKSK,这里也可以使用其他外部引入方式传入,如果使用硬编码可能会存在泄露风险。
      //您可以登录访问管理控制台获取访问密钥AK/SK,获取方式请参见https://support.huaweicloud.com/intl/zh-cn/usermanual-ca/ca_01_0003.html
      'key' => getenv('ACCESS_KEY_ID'),
      'secret' => getenv('SECRET_ACCESS_KEY'),
      'endpoint' => 'https://your-endpoint'
] );

$resp = $obsClient->putObject([
       'Bucket' => 'bucketname',
       'Key' => 'objectname',
       'Body' => 'Hello OBS'
       // your md5 which should be encoded by base64
       'ContentMD5' => base64_encode(hash("md5", "Hello OBS!", true))
]);

printf("RequestId:%s\n",$resp['RequestId']);
  • 使用ContentMD5参数指定对象MD5值。
  • 对象数据的MD5值必须经过Base64编码。
  • OBS服务端会将该MD5值与对象数据计算出的MD5值进行对比,如果不匹配则上传失败,返回HTTP 400错误。
  • 如果不设置对象的MD5值,OBS服务端会忽略对对象数据的MD5值校验。

设置对象存储类型

// 引入依赖库
require 'vendor/autoload.php';
// 使用源码安装时引入SDK代码库
// require 'obs-autoloader.php';
// 声明命名空间
use Obs\ObsClient;
// 创建ObsClient实例
$obsClient = new ObsClient ( [ 
      //推荐通过环境变量获取AKSK,这里也可以使用其他外部引入方式传入,如果使用硬编码可能会存在泄露风险。
      //您可以登录访问管理控制台获取访问密钥AK/SK,获取方式请参见https://support.huaweicloud.com/intl/zh-cn/usermanual-ca/ca_01_0003.html
      'key' => getenv('ACCESS_KEY_ID'),
      'secret' => getenv('SECRET_ACCESS_KEY'),
      'endpoint' => 'https://your-endpoint'
] );

$resp = $obsClient->putObject([
       'Bucket' => 'bucketname',
       'Key' => 'objectname',
       'SourceFile' => 'localfile',
       // 设置对象存储类型为归档存储
       
       'StorageClass' => ObsClient::StorageClassCold
]);

printf("RequestId:%s\n",$resp['RequestId']);
  • 使用StorageClass参数指定对象的存储类型。
  • 如果不设置,对象的存储类型默认与桶的存储类型保持一致。
  • 对象的存储类型分为三类,其含义与桶存储类型一致。
  • 下载归档存储类型的对象前必须将其恢复。

设置对象自定义元数据

// 引入依赖库
require 'vendor/autoload.php';
// 使用源码安装时引入SDK代码库
// require 'obs-autoloader.php';
// 声明命名空间
use Obs\ObsClient;
// 创建ObsClient实例
$obsClient = new ObsClient ( [ 
      //推荐通过环境变量获取AKSK,这里也可以使用其他外部引入方式传入,如果使用硬编码可能会存在泄露风险。
      //您可以登录访问管理控制台获取访问密钥AK/SK,获取方式请参见https://support.huaweicloud.com/intl/zh-cn/usermanual-ca/ca_01_0003.html
      'key' => getenv('ACCESS_KEY_ID'),
      'secret' => getenv('SECRET_ACCESS_KEY'),
      'endpoint' => 'https://your-endpoint'
] );

$resp = $obsClient->putObject([
       'Bucket' => 'bucketname',
       'Key' => 'objectname',
       'SourceFile' => 'localfile',
              'Metadata' => ['property1' => 'property-value1', 'property2' => 'property-value2']
]);

printf("RequestId:%s\n",$resp['RequestId']);
  • 使用Metadata参数指定对象自定义元数据。
  • 在上面设置对象自定义元数据示例代码中,用户自定义了一个名称为“property1”,值为“property-value1”的元数据和一个名称为“property2”,值为“property-value2”的元数据。
  • 一个对象可以有多个元数据,总大小不能超过8KB。
  • 对象的自定义元数据可以通过ObsClient->getObjectMetadata获取,参见获取对象元数据
  • 使用ObsClient->getObject下载对象时,对象的自定义元数据也会同时下载。