tencent cloud

Cloud Object Storage

DocumentaçãoCloud Object StorageSDK DocumentationC++ SDKBucket operationsGET Service

GET Service

PDF
Modo Foco
Tamanho da Fonte
Última atualização: 2026-03-05 16:44:05

Introduction

This document provides an overview of the API for querying bucket lists and SDK sample code.

Must-Knows

Before performing bucket-related operations, you need to have the relevant permissions:
If you want to query the bucket list, when configuring the authorization policy, set action to cos:GetService. For more authorization, see CAM-supported business APIs.

Related Examples

Function Name
Description
Example code
Querying the Bucket List
Querying the List of All Buckets Under the Specified Account

Preliminary Preparation

Using Permanent Key to Create CosAPI

Before calling the COS API, you must first create an instance of CosAPI for subsequent call requests.
qcloud_cos::CosAPI InitCosAPI() {
    uint64_t appid = 12500000000;
    std::string region = "ap-guangzhou";// Region of the bucket, see https://www.tencentcloud.com/document/product/436/62?from_cn_redirect=1
    std::string secret_id = "************************************"; // User's SecretId. It is recommended to use sub-account keys, with authorization following the least privilege principle to mitigate usage risks. For information on how to obtain sub-account keys, see https://www.tencentcloud.com/document/product/598/37140?from_cn_redirect=1
    std::string secret_key = "************************************"; // User's SecretKey. It is recommended to use sub-account keys, with authorization following the least privilege principle to mitigate usage risks. For information on how to obtain sub-account keys, see https://www.tencentcloud.com/document/product/598/37140?from_cn_redirect=1
        
    qcloud_cos::CosConfig config(appid, secret_id, secret_key, region);
    qcloud_cos::CosAPI cos_tmp(config);
    return cos_tmp;
}

Create CosAPI Using a Temporary Key

To access COS with a temporary key, you need to create a CosAPI instance using the temporary key.
qcloud_cos::CosAPI InitCosAPI() {
    // You need to have obtained the temporary key results: tmp_secret_id, tmp_secret_key,
    // For generating temporary keys, see https://www.tencentcloud.com/document/product/436/14048?from_cn_redirect=1#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;
}

Use Case: Query Bucket List

Querying the list of all buckets under the specified account.

Method Prototype

CosResult CosAPI::GetService(const GetServiceReq& req, GetServiceResp* resp)

Request Example

void GetService(qcloud_cos::CosAPI& cos) {
    qcloud_cos::GetServiceReq req;
    qcloud_cos::GetServiceResp resp; 
    qcloud_cos::CosResult result = cos.GetService(req, &resp);

    std::cout << "===================GetService====================="
                << std::endl;
    PrintResult(result, resp);
    const qcloud_cos::Owner& owner = resp.GetOwner();
    const std::vector<qcloud_cos::Bucket>& buckets = resp.GetBuckets();
    std::cout << "owner.m_id=" << owner.m_id << ", owner.display_name=" << owner.m_display_name << std::endl;
    for (std::vector<qcloud_cos::Bucket>::const_iterator itr = buckets.begin();
        itr != buckets.end(); ++itr) {
        const qcloud_cos::Bucket& bucket = *itr;
        std::cout << "Bucket name=" << bucket.m_name
                << ", location=" << bucket.m_location
                << ", create_date=" << bucket.m_create_date << std::endl;
    }
    std::cout << "=========================================================" << std::endl;
}

Parameter Description

Parameter Name
Description
Type
req
Querying bucket list request.
GetServiceReq
resp
Querying bucket list response.
GetServiceResp
GetServiceResp Member or Function Description:
Member or Function
Description
Parameter Type
GetXCosRequestId
Obtain the request ID.
string
GetOwner
Owner holder information.
struct
GetBuckets
Bucket list information.
vector

Returning Description

CosResult main member functions are as follows:
Member functions
Description
Return Type
IsSucc
Indicates whether the operation is successful; returns true for success, false for failure.
bool
GetHttpStatus
Obtain the HTTP status code.
int
GetErrorCode
Obtain the error code when the request fails.
string
GetErrorMsg
Obtain the error message when the request fails.
string
GetXCosRequestId
Obtain the request ID.
string
Usage examples for CosResult are as follows. Users may choose to utilize them based on their needs:
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 Operations

For the description of the API for querying the bucket list, see the GET Service (List Buckets) document.

Anterior: DELETE BucketPróximo: HEAD Bucket

Ajuda e Suporte

Esta página foi útil?

comentários