控制台指南

最佳实践

开发者指南

API 文档

SDK 文档

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

简介

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

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

简单操作

简单操作由 COSClient 类型发起请求,使用简单操作之前必须先创建一个 COSClient 实例。

COSClient 实例是并发安全的,这里推荐一个进程只创建一个 COSClient 实例,当不会再通过这个实例发起请求的时候,再选择关闭这个实例。

创建 COSClient

调用 COS 的接口之前,必须先创建一个 COSClient 的实例。

// 创建 COSClient 实例,这个实例用来后续调用请求
COSClient createCOSClient() {
    // 设置用户身份信息。
    // SECRETID 和 SECRETKEY 请登录访问管理控制台 https://console.cloud.tencent.com/cam/capi 进行查看和管理
    String secretId = "SECRETID";
    String secretKey = "SECRETKEY";
    COSCredentials cred = new BasicCOSCredentials(secretId, secretKey);

    // ClientConfig 中包含了后续请求 COS 的客户端设置:
    ClientConfig clientConfig = new ClientConfig();

    // 设置 bucket 的地域
    // COS_REGION 请参照 https://cloud.tencent.com/document/product/436/6224
    clientConfig.setRegion(new Region("COS_REGION"));

    // 设置请求协议, http 或者 https
    // 5.6.53 及更低的版本,建议设置使用 https 协议
    // 5.6.54 及更高版本,默认使用了 https
    clientConfig.setHttpProtocol(HttpProtocol.https);

    // 以下的设置,是可选的:

    // 设置 socket 读取超时,默认 30s
    clientConfig.setSocketTimeout(30*1000);
    // 设置建立连接超时,默认 30s
    clientConfig.setConnectionTimeout(30*1000);

    // 如果需要的话,设置 http 代理,ip 以及 port
    clientConfig.setHttpProxyIp("httpProxyIp");
    clientConfig.setHttpProxyPort(80);

    // 生成 cos 客户端。
    return new COSClient(cred, clientConfig);
}

使用临时密钥创建 COSClient

如果要使用临时密钥请求 COS,则需要用临时密钥创建 COSClient。
本 SDK 并不能生成临时密钥,而需要使用额外的操作来生成,参考 临时密钥生成


// 创建 COSClient 实例,这个实例用来后续调用请求
COSClient createCOSClient() {
    // 这里需要已经获取到临时密钥的结果。
    // 临时密钥的生成参考 https://cloud.tencent.com/document/product/436/14048#cos-sts-sdk
    String tmpSecretId = "TMPSECRETID";
    String tmpSecretKey = "TMPSECRETKEY";
    String sessionToken = "SESSIONTOKEN";

    COSCredentials cred = new BasicSessionCredentials(tmpSecretId, tmpSecretKey, sessionToken);

    // ClientConfig 中包含了后续请求 COS 的客户端设置:
    ClientConfig clientConfig = new ClientConfig();

    // 设置 bucket 的地域
    // COS_REGION 请参照 https://cloud.tencent.com/document/product/436/6224
    clientConfig.setRegion(new Region("COS_REGION"));

    // 设置请求协议, http 或者 https
    // 5.6.53 及更低的版本,建议设置使用 https 协议
    // 5.6.54 及更高版本,默认使用了 https
    clientConfig.setHttpProtocol(HttpProtocol.https);

    // 以下的设置,是可选的:

    // 设置 socket 读取超时,默认 30s
    clientConfig.setSocketTimeout(30*1000);
    // 设置建立连接超时,默认 30s
    clientConfig.setConnectionTimeout(30*1000);

    // 如果需要的话,设置 http 代理,ip 以及 port
    clientConfig.setHttpProxyIp("httpProxyIp");
    clientConfig.setHttpProxyPort(80);

    // 生成 cos 客户端。
    return new COSClient(cred, clientConfig);
}

查询对象元数据

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

方法原型

public ObjectMetadata getObjectMetadata(String bucketName, String key)
            throws CosClientException, CosServiceException;

请求示例

// 调用 COS 接口之前必须保证本进程存在一个 COSClient 实例,如果没有则创建
// 详细代码参见本页:简单操作 -> 创建 COSClient
COSClient cosClient = createCOSClient();

// 存储桶的命名格式为 BucketName-APPID,此处填写的存储桶名称必须为此格式
String bucketName = "examplebucket-1250000000";
// 对象键(Key)是对象在存储桶中的唯一标识。详情请参见 [对象键](https://cloud.tencent.com/document/product/436/13324)
String key = "exampleobject";

try {
    ObjectMetadata objectMetadata = cosClient.getObjectMetadata(bucketName, key);
    System.out.println(objectMetadata.getCrc64Ecma());
    System.out.println(objectMetadata.getLastModified());
} catch (CosServiceException e) {
    e.printStackTrace();
} catch (CosClientException e) {
    e.printStackTrace();
}

// 确认本进程不再使用 cosClient 实例之后,关闭之
cosClient.shutdown();

参数说明

参数名称 描述 类型
bucketName Bucket 的命名格式为 BucketName-APPID ,详情请参见 命名规范 String
key 对象键(Key)是对象在存储桶中的唯一标识。例如,在对象的访问域名 examplebucket-1250000000.cos.ap-guangzhou.myqcloud.com/doc/picture.jpg 中,对象键为 doc/picture.jpg,详情请参见 对象键 String

返回结果说明

  • 成功:返回 ObjectMetadata 类型, 包含用户自定义头部、Etag等对象元信息。
  • 失败:发生错误(如身份认证失败),抛出异常 CosClientException 或者 CosServiceException。详情请参见 异常处理

返回参数说明

ObjectMetadata 类用于记录对象的元信息,其主要成员说明如下:

成员名称 描述 类型
httpExpiresDate 缓存的超时时间,为 HTTP 响应头部中 Expires 字段的值 Date
ongoingRestore 正在从归档存储类型恢复该对象 Boolean
userMetadata 前缀为 x-cos-meta- 的用户自定义元信息 Map<String, String>
metadata 除用户自定义元信息以外的其他头部 Map<String, String>
restoreExpirationTime 归档对象恢复副本的过期时间 Date
目录