HeadObject--对象存储-火山引擎

文档中心

导航

对象存储

HeadObject

最近更新时间：2024.11.14 16:39:30首次发布时间：2021.10.13 16:14:08

功能描述

此接口用于获取对象的元数据，而不返回对象本身。如果您只对对象的元数据感兴趣，则此操作非常有用。要使用 HEAD，您必须具有对对象的 READ 访问权限。
HEAD 请求与对象的 GET 操作具有相同的选项。响应与 GET 响应相同，只是没有响应主体。因此，如果 HEAD 请求生成错误，它将返回一个通用的 404 Not Found 或 403 Forbidden 代码。

服务端加密

如果对象使用 TOS 托管加密密钥的服务端加密（SSE-TOS）或使用 KMS 托管加密密钥的服务端加密（SSE-KMS），则不应在 HEAD 请求中携带加密请求头域，如：x-tos-server-side-encryption，如果携带了该加密头域，会收到 HTTP 400 BadRequest 错误。
如果客户端在对象上传时，使用客户提供的加密密钥（SSE-C）进行服务端加密，当下载对象时，你必须携带以下头域：

x-tos-server-side-encryption-customer-algorithm
x-tos-server-side-encryption-customer-key
x-tos-server-side-encryption-customer-key-MD5

关于服务端加密的更多详细信息，请参见服务端加密概述。

请求消息样式

HEAD /objectName HTTP/1.1
Host: bucketname.tos-cn-beijing.volces.com
Date: GMT Date
Authorization: authorization string

请求参数和消息头

该请求使用的公共请求消息头，请参见公共参数。

名称	位置	参数类型	是否必选	示例值	说明
If-Match	Header	String	否	8a36be0d764367db4eea2deb16b71543	只有当传入期望的 ETag 与对象的 ETag 相等才返回对象元信息，否则返回 412 Precondition Failed。
If-Modified-Since	Header	String	否	Mon, 04 Jul 2022 02:57:31 GMT	只有传入参数中的时间早于对象实际修改时间才返回该对象元信息，否则返回 304 Not Modified。时间格式为 RFC1123 GMT。
If-None-Match	Header	String	否	8a36be0d764367db4eea2deb16b71543	只有当传入期望的 ETag 与对象的 ETag 不相等才返回对象元信息，否则返回 304 Not Modified。
If-Unmodified-Since	Header	String	否	Mon, 04 Jul 2022 02:57:31 GMT	只有传入参数中的时间等于或者晚于对象实际修改时间才返回该对象元信息，否则返回 412 Precondition Failed。时间格式为 RFC1123 GMT。
x-tos-server-side-encryption-customer-algorithm	Header	String	否	AES256	对象是 SSE-C 加密时使用该头域，该头域表示解密对象使用的算法，取值说明如下： `AES256`：使用 AES256 算法加密对象。
x-tos-server-side-encryption-customer-key	Header	String	否，使用 SSE-C 加密时，必选。	YWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFh****	与 `x-tos-server-side-encryption-customer-algorithm` 配套使用，指定 SSE-C 加密目标对象的密钥，格式为 base64 编码的 256 bit 的加密密钥。
x-tos-server-side-encryption-customer-key-MD5	Header	String	否	0gYVWExOAz67jX5A6qY****	对象是 SSE-C 加密时使用该头域，与 x-tos-server-side-encryption-customer-key 配套使用，该头域表示解密对象使用的密钥的 MD5 值。该头域由密钥的 128-bit MD5 值经过 base64-encoded 得到，该值用于消息完整性检查，确认加密密钥在传输过程中没有出错。
versionId	Query	String	否	57AF1A32CECB56721267	对象的版本号。标识获取指定版本的对象元数据。

请求元素

该请求消息中无请求元素。

响应消息头

该请求返回的公共响应消息头，请参见公共参数。

说明

使用 HeadObject 获取对象元数据时，如果对象类型是软链接对象，则不同的响应头返回的内容不同，说明如下：

ETag、 x-tos-storage-class 、 x-tos-hash-crc64ecma 和 x-tos-symlink-target-size：返回软链接对象指向的目标对象信息。
Last-Modified：返回软链接对象和目标对象两者之间更新较晚的日期。
其他响应头：返回软链接对象信息。

名称	参数类型	示例值	说明
Last-Modified	String	Mon, 02 Jul 2021 10:29:28 GMT	对象的最后更新时间。
x-tos-delete-marker	Bool	true	标识对象是否标记删除。如果不是，则响应中不会出现该消息头。
x-tos-server-side-encryption	String	kms	对象是 SSE-TOS 加密或 SSE-KMS 时返回该头域，该头域表示对象的服务端加密方式，取值如下： `AES256`：使用 SSE-TOS 加密方式。 `kms`：使用 SSE-KMS 加密方式。关于 SSE-TOS、 SSE-KMS 加密方式详细说明，请参见服务端加密概述。
x-tos-server-side-encryption-kms-key-id	String	trn:kms:cn-beijing:****:keyrings/ring-test/keys/key-test	对象采用 SSE-KMS 加密方式时返回该头域，该头域表示 SSE-KMS 加密使用的 KMS 主密钥 ID。
x-tos-server-side-encryption-customer-algorithm	String	AES256	对象是 SSE-C 加密时返回此头域，该头域表示解密使用的算法。
x-tos-server-side-encryption-customer-key-MD5	String	0gYVWExOAz67jX5A6qY4+A==	对象是 SSE-C 加密时返回此头域，该头域表示解密使用的密钥的 MD5 值。
x-tos-version-id	String	57AF1A32CECB56721267	对象的版本号。如果不存在版本号，则该消息头不会出现在响应消息中。
x-tos-website-redirect-location	String	/abc	当桶设置了 Website 配置，可以将获取这个对象的请求重定向到桶内另一个对象或一个外部的 URL，TOS 将这个值从头域中取出，保存在对象的元数据中。
x-tos-object-type	String	Symlink	对象为非 Normal 对象时，会返回此响应头，取值说明如下： `Appendable`：该对象为追加写接口上传的对象。 `Symlink`：该对象为软链接对象。
x-tos-symlink-target-size	Integer	10000	对象为软链接对象时，返回该头域，表示软链接对象所指向的目标对象大小。
x-tos-storage-class	String	STANDARD	对象的存储类型，取值说明如下： `STANDARD`：标准存储。 `IA`：低频访问存储。 `INTELLIGENT_TIERING`：智能分层存储。 `ARCHIVE_FR`：归档闪回存储。 `ARCHIVE`：归档存储。 `COLD_ARCHIVE`：冷归档存储。 `DEEP_COLD_ARCHIVE`：深度冷归档存储。
x-tos-hash-crc64ecma	Integer	6186290338114851376	表示该对象的 64 位 CRC 值。该 64 位 CRC 根据 ECMA-182 标准计算得出。说明对 TOS 服务端支持 64 位 CRC 校验前创建的对象，则该消息头不会出现在响应消息中。
x‑tos‑tagging‑count	String	3	对象的标签个数。仅当拥有对象标签读取权限时返回。
X-Tos-Expiration	String	expiry-date="Sun, 25 Dec 2022 00:00:00 GMT"	对象的过期日期，存在以下两种情况：如果该对象匹配生命周期的删除规则，则返回以下参数： `expiry-date`：对象的过期日期。 `rule-id`：生命周期规则 ID。如果该对象设置了过期时间，则会返回 `expiry-date` 参数，表示对象的过期日期，`rule-id` 参数则为空。
x-tos-replication-status	String	COMPLETE	对象的跨区域复制或同区域复制状态，存在以下两种情况：如果是源存储桶的对象，该参数取值如下： `COMPLETE`：该对象已成功复制到目标桶。 `PENDING`：该对象正在复制中。 `FAILED`：该对象复制失败。如果是目标存储桶的对象，该参数只有一个取值，即 `REPLICA`，表示该对象是通过跨区域复制或同区域复制功能同步过来的。注意查询对象跨区域复制或同区域复制状态功能（即 x-tos-replication-status 参数）目前处于邀测状态，如您需要使用该功能，请联系客户经理。仅该对象为跨区域复制或同区域复制规则中源存储桶或目标存储桶的对象时，才会返回该参数。仅支持查询配置了一条跨区域复制规则或同区域复制规则的源存储桶的对象复制状态，例如在源存储桶设置了多条跨区域复制规则，将 A 对象复制到 B、C、D 存储桶，则不支持查询 A 对象的复制状态。目标存储桶的对象则没有该限制。
x-tos-restore	String	ARCHIVE	如果对象为归档、冷归档或深度冷归档对象（即存储类型为 `ARCHIVE` 、 `COLD_ARCHIVE` 或 `DEEP_COLD_ARCHIVE`）且执行了 Restore Object 操作后，会返回该头域，说明如下：如果副本生成中，返回值为 `ongoing-request="true"`。如果副本已生成，则返回副本的过期时间，例如 `ongoing-request="false", expiry-date="Sat, 1 Jan 2022 00:00:00 GMT"`。
x-tos-restore-request-date	String	Sat, 1 Jan 2022 00:00:00 GMT	如果对象为归档、冷归档或深度冷归档对象（即存储类型为 `ARCHIVE` 、 `COLD_ARCHIVE` 或 `DEEP_COLD_ARCHIVE`）且执行了 Restore Object 操作后，副本生成中，会返回该头域，表示执行 Restore Object 操作的时间。例如 `Sat, 1 Jan 2022 00:00:00 GMT`。
x-tos-restore-expiry-days	Integer	7	如果对象为归档、冷归档或深度冷归档对象（即存储类型为 `ARCHIVE` 、 `COLD_ARCHIVE` 或 `DEEP_COLD_ARCHIVE`）且执行了 Restore Object 操作后，副本生成中，会返回该头域，表示副本有效天数。
x-tos-restore-tier	String	Standard	归档存储对象的恢复优先级只能为 `Standard`，表示归档存储对象在 1 分钟内完成恢复。冷归档对象的恢复优先级取值如下： `Expedited`：快速取回，1～5 分钟内完成恢复。 `Standard`：标准取回，2～5 小时内完成恢复。 `Bulk`：批量取回，5～12 小时内完成恢复。深度冷归档对象的恢复优先级取值如下： `Standard`：标准取回，12 小时内完成恢复。 `Bulk`：批量取回，48 小时内完成恢复。

响应元素

该请求响应中无消息元素。

请求示例

HEAD /objectName HTTP/1.1
Host: bucketname.tos-cn-beijing.volces.com
Date: Fri, 30 Jul 2021 08:05:36 GMT
Authorization: authorization string

响应示例

HTTP/1.1 200 OK
Content-Type: text/plain
Content-Length: 120
Date: Fri, 30 Jul 2021 08:05:36 GMT
ETag: "900150983cd24fb0d6963f7d28e17f72"
Last-Modified: Mon, 02 Jul 2021 10:29:28 GMT
server: TosServer
x-tos-id-2: ea2ceb08a4e30021-a444ed0
x-tos-request-id: ea2ceb08a4e30021-a444ed0
x-tos-storage-class: STANDARD
x-tos-hash-crc64ecma: 6186290338114851376