产品动态
产品公告
// 创建 COSClient 实例，这个实例用来后续调用请求COSClient createCOSClient() {// 这里需要已经获取到临时密钥的结果。// 临时密钥的生成参见 https://www.tencentcloud.com/document/product/436/14048#cos-sts-sdkString 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://www.tencentcloud.com/document/product/436/6224?from_cn_redirect=1clientConfig.setRegion(new Region("COS_REGION"));// 设置请求协议, http 或者 https// 5.6.53 及更低的版本，建议设置使用 https 协议// 5.6.54 及更高版本，默认使用了 httpsclientConfig.setHttpProtocol(HttpProtocol.https);// 以下的设置，是可选的：// 设置 socket 读取超时，默认 30sclientConfig.setSocketTimeout(30*1000);// 设置建立连接超时，默认 30sclientConfig.setConnectionTimeout(30*1000);// 如果需要的话，设置 http 代理，ip 以及 portclientConfig.setHttpProxyIp("httpProxyIp");clientConfig.setHttpProxyPort(80);// 生成 cos 客户端。return new COSClient(cred, clientConfig);}
// 创建 COSClient 实例，这个实例用来后续调用请求COSClient createCOSClient() {// 设置用户身份信息。// SECRETID 和 SECRETKEY 请登录访问管理控制台 https://console.tencentcloud.com/cam/capi 进行查看和管理String secretId = System.getenv("secretId");//用户的 SecretId，建议使用子账号密钥，授权遵循最小权限指引，降低使用风险。子账号密钥获取可参见 https://www.tencentcloud.com/document/product/598/37140?from_cn_redirect=1String secretKey = System.getenv("secretKey");//用户的 SecretKey，建议使用子账号密钥，授权遵循最小权限指引，降低使用风险。子账号密钥获取可参见 https://www.tencentcloud.com/document/product/598/37140?from_cn_redirect=1COSCredentials cred = new BasicCOSCredentials(secretId, secretKey);// ClientConfig 中包含了后续请求 COS 的客户端设置：ClientConfig clientConfig = new ClientConfig();// 设置 bucket 的地域// COS_REGION 请参见 https://www.tencentcloud.com/document/product/436/6224?from_cn_redirect=1clientConfig.setRegion(new Region("COS_REGION"));// 设置请求协议, http 或者 https// 5.6.53 及更低的版本，建议设置使用 https 协议// 5.6.54 及更高版本，默认使用了 httpsclientConfig.setHttpProtocol(HttpProtocol.https);// 以下的设置，是可选的：// 设置 socket 读取超时，默认 30sclientConfig.setSocketTimeout(30*1000);// 设置建立连接超时，默认 30sclientConfig.setConnectionTimeout(30*1000);// 如果需要的话，设置 http 代理，ip 以及 portclientConfig.setHttpProxyIp("httpProxyIp");clientConfig.setHttpProxyPort(80);// 生成 cos 客户端。return new COSClient(cred, clientConfig);}
public URL generatePresignedUrl(String bucketName, String key, Date expiration, HttpMethodName method, Map<String, String> headers, Map<String, String> params, Boolean signPrefixMode, Boolean signHost) throws CosClientException
// 调用 COS 接口之前必须保证本进程存在一个 COSClient 实例，如果没有则创建// 详细代码参见本页：简单操作 -> 创建 COSClientCOSClient cosClient = createCOSClient();// 存储桶的命名格式为 BucketName-APPID，此处填写的存储桶名称必须为此格式String bucketName = "examplebucket-1250000000";// 对象键(Key)是对象在存储桶中的唯一标识。详情请参见 [对象键](https://www.tencentcloud.com/document/product/436/13324)String key = "exampleobject";// 设置签名过期时间(可选), 若未进行设置则默认使用 ClientConfig 中的签名过期时间(1小时)// 这里设置签名在半个小时后过期Date expirationDate = new Date(System.currentTimeMillis() + 30 * 60 * 1000);// 填写本次请求的参数，需与实际请求相同，能够防止用户篡改此签名的 HTTP 请求的参数Map<String, String> params = new HashMap<String, String>();params.put("param1", "value1");// 填写本次请求的头部，需与实际请求相同，能够防止用户篡改此签名的 HTTP 请求的头部Map<String, String> headers = new HashMap<String, String>();headers.put("header1", "value1");// 请求的 HTTP 方法，上传请求用 PUT，下载请求用 GET，删除请求用 DELETEHttpMethodName method = HttpMethodName.GET;URL url = cosClient.generatePresignedUrl(bucketName, key, expirationDate, method, headers, params);System.out.println(url.toString());// 确认本进程不再使用 cosClient 实例之后，关闭之cosClient.shutdown();
参数名称 | 描述 | 类型 | 是否必填 |
method | HTTP 方法，可选：GET、POST、PUT、DELETE、HEAD | HttpMethodName | 是 |
bucketName | 存储桶名称，存储桶的命名格式为 BucketName-APPID，详情请参见 命名规范 | String | 是 |
key | String | 是 | |
expiration | 签名过期的时间，可以设置任意一个未来的时间，不设置则默认是1小时之后过期 | Date | 否 |
headers | 签名头部 | Map<String, String> | 否 |
params | 签名参数 | Map<String, String> | 否 |
signPrefixMode | 是否以 sign 参数指定签名（不推荐），默认 false | boolean | 否 |
signHost | 是否签入 Host 头部（推荐），默认 true | boolean | 否 |
public URL generatePresignedUrl(GeneratePresignedUrlRequest req, boolean signHost) throws CosClientException
// 调用 COS 接口之前必须保证本进程存在一个 COSClient 实例，如果没有则创建// 详细代码参见本页：简单操作 -> 创建 COSClientCOSClient cosClient = createCOSClient();// 存储桶的命名格式为 BucketName-APPID，此处填写的存储桶名称必须为此格式String bucketName = "examplebucket-1250000000";// 对象键(Key)是对象在存储桶中的唯一标识。详情请参见 [对象键](https://www.tencentcloud.com/document/product/436/13324)String key = "exampleobject";GeneratePresignedUrlRequest req =new GeneratePresignedUrlRequest(bucketName, key, HttpMethodName.GET);// 设置下载时返回的 http 头ResponseHeaderOverrides responseHeaders = new ResponseHeaderOverrides();String responseContentType = "image/x-icon";String responseContentLanguage = "zh-CN";// 设置返回头部里包含文件名信息String responseContentDispositon = "filename=exampleobject";String responseCacheControl = "no-cache";String cacheExpireStr =DateUtils.formatRFC822Date(new Date(System.currentTimeMillis() + 24L * 3600L * 1000L));responseHeaders.setContentType(responseContentType);responseHeaders.setContentLanguage(responseContentLanguage);responseHeaders.setContentDisposition(responseContentDispositon);responseHeaders.setCacheControl(responseCacheControl);responseHeaders.setExpires(cacheExpireStr);req.setResponseHeaders(responseHeaders);// 设置签名过期时间(可选)，若未进行设置，则默认使用 ClientConfig 中的签名过期时间(1小时)// 这里设置签名在半个小时后过期Date expirationDate = new Date(System.currentTimeMillis() + 30L * 60L * 1000L);req.setExpiration(expirationDate);// 填写本次请求的参数req.addRequestParameter("param1", "value1");// 填写本次请求的头部// host 必填req.putCustomRequestHeader(Headers.HOST, cosClient.getClientConfig().getEndpointBuilder().buildGeneralApiEndpoint(bucketName));req.putCustomRequestHeader("header1", "value1");URL url = cosClient.generatePresignedUrl(req);System.out.println(url.toString());// 确认本进程不再使用 cosClient 实例之后，关闭之cosClient.shutdown();
参数名称 | 描述 | 类型 | 是否必填 |
req | 预签名请求类 | GeneratePresignedUrlRequest | 是 |
signHost | 是否签入 Host 头部（推荐）默认 true | boolean | 否 |
Request 成员 | 设置方法 | 描述 | 类型 |
method | 构造函数或 set 方法 | HTTP 方法，可选：GET、POST、PUT、DELETE、HEAD | HttpMethodName |
bucketName | 构造函数或 set 方法 | 存储桶名称，存储桶的命名格式为 BucketName-APPID，详情请参见 命名规范 | String |
key | 构造函数或 set 方法 | String | |
expiration | set 方法 | 签名过期的时间，可以设置任意一个未来的时间，不设置则默认是1小时之后过期 | Date |
contentType | set 方法 | 要签名的请求中的 Content-Type | String |
contentMd5 | set 方法 | 要签名的请求中的 Content-Md5 | String |
responseHeaders | set 方法 | 签名的下载请求中要覆盖的返回的 HTTP 头 | ResponseHeaderOverrides |
versionId | set 方法 | 在存储桶开启版本控制的时候，指定对象的版本号 | String |
// 这里需要已经获取到临时密钥的结果。// 临时密钥的生成参见 https://www.tencentcloud.com/document/product/436/14048#cos-sts-sdkString tmpSecretId = "TMPSECRETID";String tmpSecretKey = "TMPSECRETKEY";String sessionToken = "SESSIONTOKEN";COSCredentials cred = new BasicSessionCredentials(tmpSecretId, tmpSecretKey, sessionToken);// 存储桶的命名格式为 BucketName-APPID，此处填写的存储桶名称必须为此格式String bucketName = "examplebucket-1250000000";// 对象键(Key)是对象在存储桶中的唯一标识。详情请参见 [对象键](https://www.tencentcloud.com/document/product/436/13324)String key = "exampleobject";//若key不是以“/”开头，则需要在 key 的开头加上“/”，否则直接 resource_path=keyString resource_path="/" + key;ClientConfig clientConfig = new ClientConfig(new Region("ap-beijing-1"));// 用来生成签名COSSigner signer = new COSSigner();// 设置签名过期时间(可选)，若未进行设置，则默认使用 ClientConfig 中的签名过期时间(1小时)// 这里设置签名在半个小时后过期Date expirationDate = new Date(System.currentTimeMillis() + 30L * 60L * 1000L);// 填写本次请求的参数Map<String, String> params = new HashMap<String, String>();params.put("param1", "value1");// 填写本次请求的头部Map<String, String> headers = new HashMap<String, String>();// host 必填headers.put(Headers.HOST, clientConfig.getEndpointBuilder().buildGeneralApiEndpoint(bucketName));headers.put("header1", "value1");// 请求的 HTTP 方法，上传请求用 PUT，下载请求用 GET，删除请求用 DELETEHttpMethodName method = HttpMethodName.GET;String sign = signer.buildAuthorizationStr(method, resource_path, headers, params, cred, expirationDate, true);
// 设置用户身份信息。// SECRETID 和 SECRETKEY 请登录访问管理控制台 https://console.tencentcloud.com/cam/capi 进行查看和管理String secretId = System.getenv("secretId");//用户的 SecretId，建议使用子账号密钥，授权遵循最小权限指引，降低使用风险。子账号密钥获取可参见 https://www.tencentcloud.com/document/product/598/37140?from_cn_redirect=1String secretKey = System.getenv("secretKey");//用户的 SecretKey，建议使用子账号密钥，授权遵循最小权限指引，降低使用风险。子账号密钥获取可参见 https://www.tencentcloud.com/document/product/598/37140?from_cn_redirect=1COSCredentials cred = new BasicCOSCredentials(secretId, secretKey);// 存储桶的命名格式为 BucketName-APPID，此处填写的存储桶名称必须为此格式String bucketName = "examplebucket-1250000000";// 对象键(Key)是对象在存储桶中的唯一标识。详情请参见 [对象键](https://www.tencentcloud.com/document/product/436/13324)String key = "exampleobject";//若 key不是以“/”开头，则需要在 key 的开头加上“/”，否则直接 resource_path=keyString resource_path="/" + key;ClientConfig clientConfig = new ClientConfig(new Region("ap-beijing-1"));// 用来生成签名COSSigner signer = new COSSigner();// 设置签名过期时间(可选)，若未进行设置，则默认使用 ClientConfig 中的签名过期时间(1小时)// 这里设置签名在半个小时后过期Date expirationDate = new Date(System.currentTimeMillis() + 30L * 60L * 1000L);// 填写本次请求的参数Map<String, String> params = new HashMap<String, String>();params.put("param1", "value1");// 填写本次请求的头部Map<String, String> headers = new HashMap<String, String>();// host 必填headers.put(Headers.HOST, clientConfig.getEndpointBuilder().buildGeneralApiEndpoint(bucketName));headers.put("header1", "value1");// 请求的 HTTP 方法，上传请求用 PUT，下载请求用 GET，删除请求用 DELETEHttpMethodName method = HttpMethodName.GET;String sign = signer.buildAuthorizationStr(method, resource_path, headers, params, cred, expirationDate, true);
public static void GenerateSimplePresignedDownloadUrl() {// 1 初始化用户身份信息(secretId, secretKey)// SECRETID 和 SECRETKEY 请登录访问管理控制台 https://console.tencentcloud.com/cam/capi 进行查看和管理String secretId = System.getenv("secretId");//用户的 SecretId，建议使用子账号密钥，授权遵循最小权限指引，降低使用风险。子账号密钥获取可参见 https://www.tencentcloud.com/document/product/598/37140?from_cn_redirect=1String secretKey = System.getenv("secretKey");//用户的 SecretKey，建议使用子账号密钥，授权遵循最小权限指引，降低使用风险。子账号密钥获取可参见 https://www.tencentcloud.com/document/product/598/37140?from_cn_redirect=1COSCredentials cred = new BasicCOSCredentials(secretId, secretKey);// 2 设置 bucket的区域// COS_REGION 参数：配置成存储桶 bucket 的实际地域，例如 ap-beijing，更多 COS 地域的简称请参见 https://www.tencentcloud.com/document/product/436/6224?from_cn_redirect=1ClientConfig clientConfig = new ClientConfig(new Region("COS_REGION"));// 3 生成 cos 客户端COSClient cosclient = new COSClient(cred, clientConfig);// bucket 名需包含 appidString bucketName = "examplebucket-1250000000";String key = "exampleobject";GeneratePresignedUrlRequest req =new GeneratePresignedUrlRequest(bucketName, key, HttpMethodName.GET);// 设置签名过期时间(可选), 若未进行设置则默认使用 ClientConfig 中的签名过期时间(1小时)// 这里设置签名在半个小时后过期Date expirationDate = new Date(System.currentTimeMillis() + 30 * 60 * 1000);req.setExpiration(expirationDate);// 填写本次请求的参数// 设定限速值，例如128KB/sreq.addRequestParameter("x-cos-traffic-limit", "1048576");// 填写本次请求的头部。Host 必填req.putCustomRequestHeader(Headers.HOST,cosclient.getClientConfig().getEndpointBuilder().buildGeneralApiEndpoint(bucketName));//req.putCustomRequestHeader("header1", "value1");URL url = cosclient.generatePresignedUrl(req);System.out.println(url.toString());cosclient.shutdown();}
文档反馈