接口介绍
查询对象是否存在。
接口约束
支持的线上资源池 ：上海7、南京3、南京5、杭州2、合肥2、九江、广州6、武汉4、福州25、厦门3、郴州2、海口2、北京5、雄安2、石家庄20、内蒙6、晋中、辽阳1、西安5、乌鲁木齐4、乌鲁木齐27、中卫5、兰州2、西宁2、拉萨3、昆明2、重庆2、成都4、贵州3、上海33、宁波边缘云、华东1、上海36、南昌5、青岛20、武汉41、长沙42、长沙37、南宁23、北京行业云20、华北2、西南1、上海32。
URI
GET /v4/oss/head-object
请求参数
请求 Query 参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 |
|---|---|---|---|---|
| bucket | 是 | String | 桶名 | bucket1 |
| regionID | 是 | String | 区域 ID | 332232eb-63aa-465e-9028-52e5123866f0 |
| key | 是 | String | 对象名 | obj1 |
| versionID | 否 | String | 版本ID，在开启多版本时可使用 | USzD.sN0vODAsQ84ncdT20oRiY2lFCD |
响应参数
| 参数 | 参数类型 | 说明 | 示例 |
|---|---|---|---|
| returnObj | Object | 响应对象 | 见下级对象 |
| statusCode | Integer | 返回码 取值范围：800 成功 |
800 |
| message | String | 状态描述 | SUCCESS |
| description | String | 状态描述，一般为中文 | 成功 |
| errorCode | String | 业务细分码（仅失败时具有此参数），为product.module.code三段式码 | openapi.userPermission.accessFailed |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 |
|---|---|---|---|
| deleteMarker | Boolean | 指定检索到的对象是 (true) 还是不是 (false) 删除标记。如果为 false，则此响应标头不会出现在响应中 | false |
| acceptRanges | String | 表示指定了一个字节范围 | bytes |
| expiration | String | 如果配置了对象过期（请参阅 PUT Bucket 生命周期），则响应包含此标头。它包括提供对象过期信息的过期日期和规则 ID 键值对。 rule-id 的值是 URL 编码的 | string |
| restore | String | 如果对象是存档对象（其存储类为 GLACIER 的对象），则如果存档恢复正在进行（请参阅 RestoreObject 或存档副本已恢复），则响应将包含此标头。如果存档副本已恢复，则标头值指示对象存储计划何时删除对象副本。例如：x-amz-restore: concurrent-request="false", expiry-date="Fri, 21 Dec 2012 00:00:00 GMT"。如果对象恢复正在进行中，标头返回值 concurrent-request="true" | concurrent-request="true" |
| archiveStatus | String | head 对象的归档状态。可能的值为 ARCHIVE_ACCESS,DEEP_ARCHIVE_ACCESS | DEEP_ARCHIVE_ACCESS |
| lastModified | String | 对象创建日期， ISO8601 格式字符串 | 2022-10-18T02:24:40Z |
| contentLength | Integer | 内容长度 | 3191 |
| ETag | String | ETag | 6805f2cfc46c0f04559748bb039d69ae |
| missingMeta | Integer | 这设置为 x-amz-meta 标头中未返回的元数据条目数。如果您使用像 SOAP 这样支持比 REST API 更灵活的元数据的 API 创建元数据，就会发生这种情况。例如，使用 SOAP，您可以创建其值不是合法 HTTP 标头的元数据 | 233 |
| versionID | String | 版本ID，在开启多版本时可使用 | USzD.sN0vODAsQ84ncdT20oRiY2lFCD |
| cacheControl | String | 指定沿请求/响应链的缓存行为 | max-age=604800 |
| contentDisposition | String | 指定对象的表示信息 | inline |
| contentEncoding | String | 内容编码 | gzip |
| contentLanguage | String | 内容语言 | en-US |
| contentType | String | 内容类型，枚举值可参考HTTP content-type类型 | image/jpeg |
| expires | String | 对象不再可缓存的日期和时间。 ISO8601 格式字符串。 | 2022-10-18T02:24:40Z |
| websiteRedirectLocation | String | 网站重定向位置 | /sdf/sdf |
| serverSideEncryption | String | 服务端加密算法, AES256,aws:kms | AES256 |
| metadata | Object | 与 S3 中的对象一起存储的元数据映射 | {"key": "value"} |
| SSECustomerAlgorithm | String | 如果请求使用客户提供的加密密钥进行服务器端加密，则响应将包含此参数，以确认所使用的加密算法 | AES256 |
| SSECustomerKeyMD5 | String | 如果请求使用客户提供的加密密钥进行服务器端加密，则响应将包含此标头以提供往返消息的完整性验证 | xcvubyisdebuhert |
| SSEKMSKeyID | String | SSEKMSKeyID | xcvuibshidubert |
| bucketKeyEnabled | Boolean | 指示对象是否通过服务端加密 | true |
| storageClass | String | 存储类，可能的值有 STANDARD,REDUCED_REDUNDANCY,STANDARD_IA,ONEZONE_IA,INTELLIGENT_TIERING,GLACIER,DEEP_ARCHIVE,OUTPOSTS,GLACIER_IR | STANDARD |
| requestCharged | String | 如果存在，则表明请求者已成功为请求收费 | requester |
| replicationStatus | String | 复制状态,如COMPLETE,PENDING,FAILED,REPLICA | COMPLETE |
| partsCount | Integer | 此对象拥有的分段数 | 32 |
| objectLockMode | String | 对象锁定模式，GOVERNANCE,COMPLIANCE | COMPLIANCE |
| objectLockRetainUntilDate | 对象锁定保留期到期的日期和时间。ISO8601 格式字符串 | 2022-10-18T02:24:40Z | |
| objectLockLegalHoldStatus | String | 指定此对象的合法保留是否有效, 可能的值是 ON,OFF | ON |
请求示例
GET https://zos-global.ctapi.ctyun.cn/v4/oss/head-object?bucket=bucket1®ionID=332232eb-63aa-465e-9028-52e5123866f0&key=obj1&versionID=USzD.sN0vODAsQ84ncdT20oRiY2lFCD
响应示例
{
"returnObj": {
"acceptRanges": "bytes",
"contentLength": 3191,
"contentType": "image/jpeg",
"ETag": "6805f2cfc46c0f04559748bb039d69ae",
"lastModified": "2022-10-18T02:24:40Z",
"metadata": {"key": "value"},
"versionID": "USzD.sN0vODAsQ84ncdT20oRiY2lFCD"
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
| 状态码 | 描述 |
|---|---|
| 800 | 表示请求成功。 |
| 900 | 表示对象无权访问或不存在或请求失败，详情查看返回的 message 参数。 |
错误码
errorCode 枚举值，见错误码总表
