控制台指南

最佳实践

开发者指南

API 文档

SDK 文档

诚邀爱技术、爱分享的你,成为文档内容共建者> HOT

简介

本文档提供关于查询对象元数据操作相关的 API 概览以及 SDK 示例代码。

API 操作名 操作描述
HEAD Object 查询对象元数据 查询对象的元数据信息

查询对象元数据

功能说明

查询对象的元数据信息。

使用示例

cos.headObject({
    Bucket: 'examplebucket-1250000000', /* 填入您自己的存储桶,必须字段 */
    Region: 'COS_REGION',  /* 存储桶所在地域,例如ap-beijing,必须字段 */
    Key: '1.jpg',  /* 存储在桶里的对象键(例如1.jpg,a/b/test.txt),必须字段 */
}, function(err, data) {
    console.log(err || data);
});

参数说明

参数名 参数描述 类型 是否必填
Bucket 存储桶的名称,命名格式为 BucketName-APPID,此处填写的存储桶名称必须为此格式 String
Region 存储桶所在地域,枚举值请参见 地域和访问域名 String
Key 对象键(Object 的名称),对象在存储桶中的唯一标识,详情请参见 对象概述 String
IfModifiedSince 当在指定时间后被修改,则返回对应的元数据信息,否则返回304 String

回调函数说明

function(err, data) { ... }

参数名 参数描述 类型
err 请求发生错误时返回的对象,包括网络错误和业务错误,如果请求成功则为空,更多详情请参见 错误码 文档 Object
- statusCode 请求返回的 HTTP 状态码,例如200、403、404等 Number
- headers 请求返回的头部信息 Object
data 请求成功时返回的对象,如果请求发生错误,则为空 Object
- statusCode 请求返回的 HTTP 状态码,例如200,304等,如果在指定时间后未被修改,则返回304 Number
- headers 请求返回的头部信息 Object
- x-cos-object-type 用来表示对象是否可以被追加上传,枚举值:normal、appendable,默认 normal 不显示在返回中 String
- x-cos-storage-class 对象的存储级别,枚举值:STANDARD、STANDARD_IA、ARCHIVE,默认值:STANDARD 不显示在返回中 String
- x-cos-meta-* 用户自定义的 meta String
- NotModified 对象是否在指定时间后未被修改 Boolean
- ETag 返回文件的 MD5 算法校验值。ETag 的值可以用于检查对象在上传过程中是否有损坏
例如"09cba091df696af91549de27b8e7d0f6"注意:这里的 ETag 值字符串前后带有双引号
String
- VersionId 在开启过版本控制的存储桶中上传对象返回对象的版本 ID,存储桶从未开启则不返回该参数 String
目录