控制台指南

最佳实践

开发者指南

API 文档

SDK 文档

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

简介

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

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

查询对象元数据

功能说明

查询对象的元数据信息(HEAD Object)。

方法原型

head_object(Bucket, Key, **kwargs)

请求示例

# -*- coding=utf-8
from qcloud_cos import CosConfig
from qcloud_cos import CosS3Client
import sys
import logging

# 正常情况日志级别使用INFO,需要定位时可以修改为DEBUG,此时SDK会打印和服务端的通信信息
logging.basicConfig(level=logging.INFO, stream=sys.stdout)

# 1. 设置用户属性, 包括 secret_id, secret_key, region等。Appid 已在CosConfig中移除,请在参数 Bucket 中带上 Appid。Bucket 由 BucketName-Appid 组成
secret_id = 'SecretId'     # 替换为用户的 SecretId,请登录访问管理控制台进行查看和管理,https://console.cloud.tencent.com/cam/capi
secret_key = 'SecretKey'   # 替换为用户的 SecretKey,请登录访问管理控制台进行查看和管理,https://console.cloud.tencent.com/cam/capi
region = 'ap-beijing'      # 替换为用户的 region,已创建桶归属的region可以在控制台查看,https://console.cloud.tencent.com/cos5/bucket
                           # COS支持的所有region列表参见https://cloud.tencent.com/document/product/436/6224
token = None               # 如果使用永久密钥不需要填入token,如果使用临时密钥需要填入,临时密钥生成和使用指引参见https://cloud.tencent.com/document/product/436/14048
scheme = 'https'           # 指定使用 http/https 协议来访问 COS,默认为 https,可不填

config = CosConfig(Region=region, SecretId=secret_id, SecretKey=secret_key, Token=token, Scheme=scheme)
client = CosS3Client(config)

response = client.head_object(
    Bucket='examplebucket-1250000000',
    Key='exampleobject'
)
print(response)

全部请求参数示例

response = client.head_object(
    Bucket='examplebucket-1250000000',
    Key='exampleobject',
    VersionId='string',
    IfModifiedSince='Wed, 28 Oct 2020 20:30:00 GMT',
)

参数说明

参数名称 参数描述 类型 是否必填
Bucket Bucket 名称,由 BucketName-APPID 构成 String
Key 对象键(Key)是对象在存储桶中的唯一标识。例如,在对象的访问域名 examplebucket-1250000000.cos.ap-guangzhou.myqcloud.com/doc/pic.jpg 中,对象键为 doc/pic.jpg String
VersionId 开启版本控制后,指定对象的具体版本 String
IfModifiedSince 在指定时间后被修改才返回,时间格式为 GMT String

返回结果说明

获取对象的元信息,类型为 dict:

{
    'ETag': '"9a4802d5c99dafe1c04da0a8e7e166bf"',
    'Last-Modified': 'Wed, 28 Oct 2014 20:30:00 GMT',
    'Cache-Control': 'max-age=1000000',
    'Content-Type': 'application/octet-stream',
    'Content-Disposition': 'attachment; filename="filename.jpg"',
    'Content-Encoding': 'gzip',
    'Content-Language': 'zh-cn',
    'Content-Length': '16807',
    'Expires': 'Wed, 28 Oct 2019 20:30:00 GMT',
    'x-cos-meta-test': 'test',
    'x-cos-version-id': 'MTg0NDUxODMzMTMwMDM2Njc1ODA',
    'x-cos-request-id': 'NTg3NzQ3ZmVfYmRjMzVfMzE5N182NzczMQ=='
}

参数名称 参数描述 类型
ETag 分块上传时,该值不是对象内容的 MD5 校验值,仅能用于检查对象唯一性 String
Last-Modified 对象最后修改时间 String
Cache-Control 缓存策略, HTTP 标准头部 String
Content-Type 内容类型,HTTP 标准头部 String
Content-Disposition 文件名称,HTTP 标准头部 String
Content-Encoding 编码格式,HTTP 标准头部 String
Content-Language 语言类型,HTTP 标准头部 String
Content-Length 对象大小 String
Expires 缓存过期时间, HTTP 标准头部 String
x-cos-meta-* 用户自定义的对象元数据, 必须以 x-cos-meta 开头,否则会被忽略 String
x-cos-version-id 开启版本控制后,对象的版本号 String
目录