文档反馈官招募中，报名立赚积分兑换代金券！> HOT
文档中心>对象存储>SDK 文档>C++ SDK>存储桶操作>检索存储桶

检索存储桶

最近更新时间：2024-12-13 19:20:04

我的收藏

本页目录：

简介

本文档提供关于检索存储桶的 API 概览以及 SDK 示例代码。

注意事项

在您使用存储桶相关操作之前，需要先具有相关权限：
若想检索存储桶，在您进行 授权策略 时，action 需要设置为 cos:HeadBucket，更多授权请参见 支持 CAM 的业务接口。

相关示例

功能名称
描述
示例代码
检索存储桶
检索存储桶是否存在且是否有权限访问

前期准备

使用永久密钥创建 CosAPI

调用 COS 的接口之前，必须先创建一个 CosAPI 的实例。这个实例用来后续调用请求。
qcloud_cos::CosAPI InitCosAPI() {
    uint64_t appid = 12500000000;
    std::string region = "ap-guangzhou";// bucket 的地域，请参见 https://cloud.tencent.com/document/product/436/62
    std::string secret_id = "************************************"; //用户的 SecretId，建议使用子账号密钥，授权遵循最小权限指引，降低使用风险。子账号密钥获取可参见 https://cloud.tencent.com/document/product/598/37140
    std::string secret_key = "************************************"; //用户的 SecretKey，建议使用子账号密钥，授权遵循最小权限指引，降低使用风险。子账号密钥获取可参见 https://cloud.tencent.com/document/product/598/37140
        
    qcloud_cos::CosConfig config(appid, secret_id, secret_key, region);
    qcloud_cos::CosAPI cos_tmp(config);
    return cos_tmp;
}

使用临时密钥创建 CosAPI

如果要使用临时密钥请求 COS，则需要用临时密钥创建 CosAPI 实例。
qcloud_cos::CosAPI InitCosAPI() {
    // 需要已经获取到临时密钥的结果：tmp_secret_id、tmp_secret_key、
    // 临时密钥的生成参见 https://cloud.tencent.com/document/product/436/14048#cos-sts-sdk
    uint64_t appid = 12500000000;
    std::string region = "ap-guangzhou";
    std::string tmp_secret_id = "************************************";
    std::string tmp_secret_key = "************************************";
    std::string tmp_token = "token";
    
    qcloud_cos::CosConfig config(appid, tmp_secret_id, tmp_secret_key, region);
    config.SetTmpToken(tmp_token);
    qcloud_cos::CosAPI cos_tmp(config);
    return cos_tmp;
}

使用案例：检索存储桶

检索存储桶是否存在且是否有权限访问。

方法原型

CosResult CosAPI::HeadBucket(const HeadBucketReq& req, HeadBucketResp* resp)

请求示例

void HeadBucket(qcloud_cos::CosAPI& cos) {
  qcloud_cos::HeadBucketReq req(bucket_name);
  qcloud_cos::HeadBucketResp resp;
  qcloud_cos::CosResult result = cos.HeadBucket(req, &resp);

  std::cout << "===================HeadBucketResponse====================="
            << std::endl;
  PrintResult(result, resp);
  std::cout << "=========================================================="
            << std::endl;
}

参数说明

参数名称
描述
类型
req
检索存储桶请求。
HeadBucketReq
resp
检索存储桶响应。
HeadBucketResp
HeadBucketReq 成员或函数说明：
成员或函数
描述
参数类型
bucket_name
存储桶名，可通过构造函数或 set 方法进行设置。
存储桶的命名格式为 BucketName-APPID，详情请参见 命名规范。
string
HeadBucketResp 成员或函数说明：
成员或函数
描述
参数类型
GetXCosRequestId
获取请求 ID。
string

返回说明

CosResult 主要成员函数说明如下：
成员函数
描述
返回类型
IsSucc
判断是否成功，成功返回 true，失败返回 false。
bool
GetHttpStatus
获取 HTTP 状态码。
int
GetErrorCode
获取请求失败时获取错误码。
string
GetErrorMsg
获取请求失败时获取错误信息。
string
GetXCosRequestId
获取请求 ID。
string
对 CosResult 的使用样例如下，用户可根据信息选择使用：
void PrintResult(const qcloud_cos::CosResult& result, const qcloud_cos::BaseResp& resp) {
    if (result.IsSucc()) {
        std::cout << "Request Succ." << std::endl;
        std::cout << resp.DebugString() << std::endl;
    } else {
        std::cout << "ErrorMsg=" << result.GetErrorMsg() << std::endl;
        std::cout << "HttpStatus=" << result.GetHttpStatus() << std::endl;
        std::cout << "ErrorCode=" << result.GetErrorCode() << std::endl;
        std::cout << "ErrorMsg=" << result.GetErrorMsg() << std::endl;
        std::cout << "ResourceAddr=" << result.GetResourceAddr() << std::endl;
        std::cout << "XCosRequestId=" << result.GetXCosRequestId() << std::endl;
        std::cout << "XCosTraceId=" << result.GetXCosTraceId() << std::endl;
    }
}

API 操作

关于检索存储桶的 API 接口说明，请参见 HEAD Bucket 文档。

中国站
目录