HeadObject
HeadObject接口用于获取某个文件(Object)的元信息。使用此接口不会返回文件内容。
说明 如果您在PutObject的时候传入以x-oss-meta-为开头的user meta,比如x-oss-meta-location,返回消息时,返回这些user meta。
请求语法
HEAD /ObjectName HTTP/1.1
Host: BucketName/oss-cn-hangzhou.aliyuncs.com
Date: GMT Date
Authorization: SignatureValue
请求头
名称 | 类型 | 是否必选 | 描述 |
---|---|---|---|
If-Modified-Since | 字符串 | 否 | 如果传入参数中的时间早于实际修改时间,则返回200 OK和Object Meta;否则返回304 not modified。
默认值:无 |
If-Unmodified-Since | 字符串 | 否 | 如果传入参数中的时间等于或者晚于文件实际修改时间,则返回200 OK和Object Meta;否则返回412 precondition failed。
默认值:无 |
If-Match | 字符串 | 否 | 如果传入期望的ETag和Object的 ETag匹配,则返回200 OK和Object Meta;否则返回412 precondition failed。
默认值:无 |
If-None-Match | 字符串 | 否 | 如果传入期望的ETag值和Object的ETag不匹配,则返回200 OK和Object Meta;否则返回304 Not Modified。
默认值:无 |
响应头
说明 如果文件类型为软链接, 响应头中
Content-Length
、ETag
、Content-Md5
均为目标文件的元信息;Last-Modified
是目标文件和软链接的最大值;其他均为软链接元信息。
名称 | 类型 | 描述 |
---|---|---|
x-oss-meta-* | 字符串 | 以x-oss-meta-为前缀的参数作为用户自定义meta header。当用户在PutObject时设置了以x-oss-meta-为前缀的自定义meta,则响应中会包含这些自定义meta。 |
非x-oss-meta-开头的自定义header | 字符串 | 当用户在PutObject时,自定义一些非x-oss-meta为前缀的Header,如x-oss-persistent-headers:key1:base64_encode(value1),key2:base64_encode(value2).... ,响应中会增加相应的自定义Header。 |
x-oss-server-side-encryption | 字符串 | 若该Object为进行服务器端熵编码加密存储的,则在响应头头中会返回此参数,其值表明该Object的服务器端加密算法。 |
x-oss-server-side-encryption-key-id | 字符串 | 如果用户在创建Object时使用了服务端加密,且加密方法为KMS,则响应中会包含此Header,表示加密所使用的用户KMS key ID。 |
x-oss-storage-class | 字符串 | 表示Object的存储类型,分别为:标准存储类型(Standard)、低频访问存储类型(Infrequent Access)、归档存储类型(Archive)。
|
x-oss-object-type | 字符串 | 表示Object的类型。
|
x-oss-next-append-position | 字符串 | 对于Appendable类型的Object会返回此Header,指明下一次请求应当提供的position。 |
x-oss-hash-crc64ecma | 字符串 | 表示该Object的64位CRC值。该64位CRC根据ECMA-182标准计算得出。请注意,有些较老的Object可能没有这个Header。 |
x-oss-expiration | 字符串 | 如果用户为该Object设置了生命周期规则(Lifecycle),响应中将包含x-oss-expiration header。其中expiry-date的值表示该Object的过期日期,rule-id的值表示相匹配的规则ID。 |
x-oss-restore | 字符串 | 如果Bucket类型为Archive,且用户已经提交Restore请求,则响应头中会以x-oss-restore返回该Object的Restore状态,分如下几种情况:
|
x-oss-process-status | 字符串 | 当用户通过MNS消息服务创建OSS事件通知后,在进行请求OSS相关操作时如果有匹配的事件通知规则,则响应中会携带这个Header,值为经过Base64编码json格式的事件通知结果。 |
x-oss-request-charged | 字符串 | 当Object所属的Bucket被设置为请求者付费模式,且请求者不是Bucket的拥有者时,响应中将携带此Header,值为requester。 |
Content-Md5 | 字符串 | 对于Normal类型的Object,根据RFC 1864标准对消息内容(不包括Header)计算Md5值获得128比特位数字,对该数字进行base64编码作为一个消息的Content-Md5值。Multipart和Appendable类型的文件不会返回这个Header。 |
Last-Modified | 字符串 | Object最后一次修改的日期,格式为HTTP 1.1协议中规定的GMT时间。 |
Access-Control-Allow-Origin | 字符串 | 当Object所在的Bucket配置了CORS规则,如果请求的Origin满足指定的CORS规则时会在响应中包含这个Origin。 |
Access-Control-Allow-Methods | 字符串 | 当Object所在的Bucket配置了CORS规则,如果请求的Access-Control-Request-Method满足指定的CORS规则时会在响应中包含允许的Methods。 |
Access-Control-Max-Age | 字符串 | 当Object所在的Bucket配置了CORS规则,如果请求满足Bucket配置的CORS规则时会在响应中包含MaxAgeSeconds。 |
Access-Control-Allow-Headers | 字符串 | 当Object所在的Bucket配置了CORS规则,如果请求满足指定的CORS规则时会在响应中包含这些Headers。 |
Access-Control-Expose-Headers | 字符串 | 表示允许访问客户端JavaScript程序的headers列表。当Object所在的Bucket配置了CORS规则,如果请求满足指定的CORS规则时会在响应中包含ExposeHeader。 |
x‑oss‑tagging‑count | 字符串 | 对象关联的标签的个数。仅当用户有读取标签权限时返回。 |
示例
- 正常请求示例
HEAD /oss.jpg HTTP/1.1 Host: oss-example.oss-cn-hangzhou.aliyuncs.com Date: Fri, 24 Feb 2012 07:32:52 GMT Authorization: OSS qn6qrrqxo2oawuk53otfjbyc:JbzF2LxZUtanlJ5dLA092wpD****
返回示例HTTP/1.1 200 OK x-oss-request-id: 559CC9BDC755F95A64485981 x-oss-object-type: Normal x-oss-storage-class: Archive Date: Fri, 24 Feb 2012 07:32:52 GMT Last-Modified: Fri, 24 Feb 2012 06:07:48 GMT ETag: "fba9dede5f27731c9771645a3986****" Content-Length: 344606 Content-Type: image/jpg Connection: keep-alive Server: AliyunOSS
- 提交Restore请求但Restore没有完成时的请求示例
HEAD /oss.jpg HTTP/1.1 Host: oss-archive-example.oss-cn-hangzhou.aliyuncs.com Date: Sat, 15 Apr 2017 07:32:52 GMT Authorization: OSS e1Unnbm1rgdnpI:KKxkdNrUBu2t1kqlDh0MLbDb****
返回示例HTTP/1.1 200 OK x-oss-request-id: 58F71A164529F18D7F000045 x-oss-object-type: Normal x-oss-storage-class: Archive x-oss-restore: ongoing-request="true" Date: Sat, 15 Apr 2017 07:32:52 GMT Last-Modified: Sat, 15 Apr 2017 06:07:48 GMT ETag: "fba9dede5f27731c9771645a3986****" Content-Length: 344606 Content-Type: image/jpg Connection: keep-alive Server: AliyunOSS
- 提交Restore请求且Restore已经完成时的请求示例
HEAD /oss.jpg HTTP/1.1 Host: oss-archive-example.oss-cn-hangzhou.aliyuncs.com Date: Sat, 15 Apr 2017 09:35:51 GMT Authorization: OSS e1Unnbm1rgdnpI:21qtGJ+ykDVmdu6O6FMJnn+W****
返回示例HTTP/1.1 200 OK x-oss-request-id: 58F725344529F18D7F000055 x-oss-object-type: Normal x-oss-storage-class: Archive x-oss-restore: ongoing-request="false", expiry-date="Sun, 16 Apr 2017 08:12:33 GMT" Date: Sat, 15 Apr 2017 09:35:51 GMT Last-Modified: Sat, 15 Apr 2017 06:07:48 GMT ETag: "fba9dede5f27731c9771645a3986****" Content-Length: 344606
错误码
错误码 | HTTP 状态码 | 描述 |
---|---|---|
NoSuchKey | 404 | 文件不存在。 |
SymlinkTargetNotExist | 404 | 文件类型为软链接。 |
InvalidTargetType | 400 | 文件类型为软链接,且目标文件类型是软链接。 |
Not Modified | 304 |
|
Precondition Failed | 412 |
|
版权声明
本文仅代表作者观点,不代表本站立场。
本文系作者授权发表,未经许可,不得转载。
评论