全部產品
Search
文件中心

Object Storage Service:列舉儲存空間

更新時間:Oct 22, 2025

儲存空間(Bucket)按字母序排列。當儲存空間數量龐大時,手動管理效率低且易出錯。通過列舉儲存空間(ListBuckets)功能,可程式化式地擷取帳號下全部或部分儲存空間的列表,以實現自動化的資產盤點、大量操作和許可權審計。

工作原理

列舉儲存空間的行為由請求參數和分頁機制共同決定。

請求參數

通過在請求中設定以下參數,可以篩選和控制返回的結果。

參數名稱

描述

prefix

首碼篩選:限制返回的儲存空間名稱必須以此字串為首碼。

marker

分頁標記:指定列表的起始位置。返回結果將從該標記之後按字母序排列的第一個開始。

max-keys

單頁數量:限定單次請求返回的儲存空間最大數量。取值範圍為1-1000,預設值為 100。

分頁機制

基礎的列舉操作預設僅返回一頁資料。如果儲存空間數量超過單頁最大限制(由max-keys決定),必須採用分頁機制才能擷取完整列表。

分頁的實現依賴於服務端在響應中返回的兩個關鍵字段:

  • isTruncated (布爾值): 若為 true,表示還有後續資料頁。

  • nextMarker (字串): 下一頁資料的起始標記。

分頁的核心邏輯是:檢查 isTruncated 標誌。若為 true,則將返回的 nextMarker 作為下一次請求的 marker 參數,迴圈此過程,直至 isTruncated 返回 false。

部分SDK(如Python v2,Go v2,PHP v2,C# V2)提供了分頁器(Paginator)來自動處理此迴圈,其他SDK則需要自行實現。

列舉所有儲存空間

最基礎的列舉操作。

控制台

  1. 登入OSS管理主控台

  2. 在左側導覽列,單擊Bucket 列表

    Bucket列表頁面預設顯示當前帳號下的所有儲存空間。如果您需要快速擷取儲存空間的個數以及儲存空間的相關屬性資訊,請單擊右上方的匯出CSV表徵圖download

ossutil

您可以使用命令列工具ossutil來列舉儲存空間,ossutil的安裝請參見安裝ossutil

以下命令用於列舉要求者擁有的所有儲存空間。

ossutil api list-buckets

關於該命令的更多資訊,請參見list-buckets(get-service)

SDK

以下僅給出常見SDK的列舉儲存空間程式碼範例。關於其他SDK的列舉儲存空間程式碼範例,請參見SDK簡介

Java

import com.aliyun.oss.*;
import com.aliyun.oss.common.auth.*;
import com.aliyun.oss.common.comm.SignVersion;
import com.aliyun.oss.model.Bucket;

import java.util.List;

public class Demo {

    public static void main(String[] args) throws Exception {
        // 以華東1(杭州)為例,Endpoint填寫為https://oss-cn-hangzhou.aliyuncs.com。
        String endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
        // 填寫Bucket所在地區。以華東1(杭州)為例,Region填寫為cn-hangzhou。
        String region = "cn-hangzhou";
        
        // 從環境變數中擷取訪問憑證。運行本程式碼範例之前,請確保已設定環境變數OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
        EnvironmentVariableCredentialsProvider credentialsProvider = CredentialsProviderFactory.newEnvironmentVariableCredentialsProvider();

        // 建立OSSClient執行個體。
        // 當OSSClient執行個體不再使用時,調用shutdown方法以釋放資源。
        ClientBuilderConfiguration clientBuilderConfiguration = new ClientBuilderConfiguration();
        clientBuilderConfiguration.setSignatureVersion(SignVersion.V4);        
        OSS ossClient = OSSClientBuilder.create()
        .endpoint(endpoint)
        .credentialsProvider(credentialsProvider)
        .clientConfiguration(clientBuilderConfiguration)
        .region(region)               
        .build();

        try {
            // 列舉當前帳號所有地區下的儲存空間。
            List<Bucket> buckets = ossClient.listBuckets();
            for (Bucket bucket : buckets) {
                System.out.println(" - " + bucket.getName());
            }
        } catch (OSSException oe) {
            System.out.println("Caught an OSSException, which means your request made it to OSS, "
                    + "but was rejected with an error response for some reason.");
            System.out.println("Error Message:" + oe.getErrorMessage());
            System.out.println("Error Code:" + oe.getErrorCode());
            System.out.println("Request ID:" + oe.getRequestId());
            System.out.println("Host ID:" + oe.getHostId());
        } catch (ClientException ce) {
            System.out.println("Caught an ClientException, which means the client encountered "
                    + "a serious internal problem while trying to communicate with OSS, "
                    + "such as not being able to access the network.");
            System.out.println("Error Message:" + ce.getMessage());
        } finally {
            if (ossClient != null) {
                ossClient.shutdown();
            }
        }
    }
}

Python

import argparse
import alibabacloud_oss_v2 as oss

# 建立命令列參數解析器,並描述指令碼用途:樣本展示如何列出OSS中的所有儲存空間
parser = argparse.ArgumentParser(description="list buckets sample")

# 添加命令列參數 --region,表示儲存空間所在的地區,必需參數
parser.add_argument('--region', help='The region in which the bucket is located.', required=True)
# 添加命令列參數 --endpoint,表示其他服務可用來訪問OSS的網域名稱,非必需參數
parser.add_argument('--endpoint', help='The domain names that other services can use to access OSS')

def main():
    # 解析命令列提供的參數,擷取使用者輸入的值
    args = parser.parse_args()

    # 從環境變數中載入訪問OSS所需的認證資訊,用於身分識別驗證
    credentials_provider = oss.credentials.EnvironmentVariableCredentialsProvider()

    # 使用SDK的預設配置建立設定物件,並設定認證提供者
    cfg = oss.config.load_default()
    cfg.credentials_provider = credentials_provider
    cfg.region = args.region

    # 如果提供了自訂endpoint,則更新設定物件中的endpoint屬性
    if args.endpoint is not None:
        cfg.endpoint = args.endpoint

    # 使用上述配置初始化OSS用戶端,準備與OSS互動
    client = oss.Client(cfg)

    # 建立ListBuckets操作的分頁器(Paginator),以便處理大量儲存空間
    paginator = client.list_buckets_paginator()

    # 遍曆分頁結果
    for page in paginator.iter_page(oss.ListBucketsRequest()):
        # 對於每一頁中的每一個儲存空間,列印其名稱、位置、建立日期
        for o in page.buckets:
            print(f'Bucket: {o.name}, Location: {o.location}, Created: {o.creation_date}')

# 當此指令碼被直接執行時,調用main函數開始處理邏輯
if __name__ == "__main__":
    main()  # 指令碼進入點,控製程序流程從這裡開始

Go

package main

import (
	"context"
	"flag"
	"log"

	"github.com/aliyun/alibabacloud-oss-go-sdk-v2/oss"
	"github.com/aliyun/alibabacloud-oss-go-sdk-v2/oss/credentials"
)

// 定義全域變數
var (
	region string // 儲存地區
)

// init函數用於初始化命令列參數
func init() {
	flag.StringVar(&region, "region", "", "The region in which the bucket is located.")
}

func main() {
	// 解析命令列參數
	flag.Parse()

	// 檢查region是否為空白
	if len(region) == 0 {
		flag.PrintDefaults()
		log.Fatalf("invalid parameters, region required")
	}

	// 載入預設配置並設定憑證提供者和地區
	cfg := oss.LoadDefaultConfig().
		WithCredentialsProvider(credentials.NewEnvironmentVariableCredentialsProvider()).
		WithRegion(region)

	// 建立OSS用戶端
	client := oss.NewClient(cfg)

	// 建立列出儲存空間的請求
	request := &oss.ListBucketsRequest{}

	// 建立分頁器
	p := client.NewListBucketsPaginator(request)

	var i int
	log.Println("Buckets:")

	// 遍曆分頁器中的每一頁
	for p.HasNext() {
		i++

		// 擷取下一頁的資料
		page, err := p.NextPage(context.TODO())
		if err != nil {
			log.Fatalf("failed to get page %v, %v", i, err)
		}

		// 列印該頁中的每個儲存空間的資訊
		for _, b := range page.Buckets {
			log.Printf("Bucket: %v, StorageClass: %v, Location: %v\n", oss.ToString(b.Name), oss.ToString(b.StorageClass), oss.ToString(b.Location))
		}
	}

}

PHP

<?php

require_once __DIR__ . '/../vendor/autoload.php'; // 引入自動負載檔案,載入依賴庫

use AlibabaCloud\Oss\V2 as Oss;

// 定義命令列參數描述
$optsdesc = [
    "region" => ['help' => 'The region in which the bucket is located.', 'required' => True], // 地區是必填項,儲存空間所在的地區,例如 oss-cn-hangzhou。
    "endpoint" => ['help' => 'The domain names that other services can use to access OSS.', 'required' => False], // 終端節點是可選項,其他服務可以用來訪問OSS的網域名稱。
];
$longopts = \array_map(function ($key) {
    return "$key:"; 
}, array_keys($optsdesc));

// 解析命令列參數
$options = getopt("", $longopts); 

// 檢查必填參數是否缺失
foreach ($optsdesc as $key => $value) {
    if ($value['required'] === True && empty($options[$key])) {
        $help = $value['help'];
        echo "Error: the following arguments are required: --$key, $help"; // 提示缺少必填參數
        exit(1); 
    }
}

// 擷取命令列參數值
$region = $options["region"]; // 儲存空間所在地區。

// 使用環境變數載入憑證資訊(AccessKeyId 和 AccessKeySecret)
$credentialsProvider = new Oss\Credentials\EnvironmentVariableCredentialsProvider(); // 從環境變數中載入憑證資訊。

// 使用SDK的預設配置
$cfg = Oss\Config::loadDefault(); // 載入SDK的預設配置。
$cfg->setCredentialsProvider($credentialsProvider); // 設定憑證提供者。
$cfg->setRegion($region); // 設定地區。
if (isset($options["endpoint"])) {
    $cfg->setEndpoint($options["endpoint"]); // 如果提供了終端節點,則設定終端節點。
}

// 建立OSS用戶端執行個體
$client = new Oss\Client($cfg); // 建立OSS用戶端執行個體。

// 建立用於ListBuckets操作的分頁器
$paginator = new Oss\Paginator\ListBucketsPaginator($client); // 建立分頁器,用於列出儲存空間。
$iter = $paginator->iterPage(new Oss\Models\ListBucketsRequest()); // 擷取分頁迭代器。


// 遍曆儲存空間分頁結果

foreach ($iter as $page) { // 遍曆每一頁的儲存空間列表。
    foreach ($page->buckets ?? [] as $bucket) { // 遍曆當前頁中的每個儲存空間。
        print ("Bucket: $bucket->name, $bucket->location\n"); // 列印儲存空間名稱和所在地區。
    }
}

C#

using OSS = AlibabaCloud.OSS.V2; // 為阿里雲OSS SDK建立別名,簡化後續使用

var region = "cn-hangzhou"; // 必須項,設定Bucket所在的地區(Region)。以華東1(杭州)為例,Region填寫為cn-hangzhou
var endpoint = null as string;  // 可選項,指定訪問OSS服務的網域名稱。以華東1(杭州)為例,Endpoint填寫為https://oss-cn-hangzhou.aliyuncs.com

// 載入OSS SDK的預設配置,此配置會自動從環境變數中讀取憑證資訊(如AccessKey)
var cfg = OSS.Configuration.LoadDefault();
// 顯式設定使用環境變數擷取憑證,用於身分識別驗證(格式:OSS_ACCESS_KEY_ID、OSS_ACCESS_KEY_SECRET)
cfg.CredentialsProvider = new OSS.Credentials.EnvironmentVariableCredentialsProvider();
// 設定配置的Bucket地區
cfg.Region = region;
// 若已指定了endpoint,則覆蓋預設的endpoint
if(endpoint != null)
{
    cfg.Endpoint = endpoint;
}

// 使用配置資訊建立OSS用戶端執行個體
using var client = new OSS.Client(cfg);

// 建立ListBuckets操作的分頁器(Paginator),用於處理分頁結果
// ListBucketsRequest是SDK定義的請求模型,此處使用預設建構函式(擷取所有Bucket) 
var paginator = client.ListBucketsPaginator(new OSS.Models.ListBucketsRequest());

Console.WriteLine("Buckets:");
await foreach (var page in paginator.IterPageAsync())
{
// 遍曆當前頁中的每個Bucket
    foreach (var bucket in page.Buckets ?? [])
    {
    // 列印儲存桶資訊:名稱、儲存類型、所在地區
    Console.WriteLine($"Bucket:{bucket.Name}, {bucket.StorageClass}, {bucket.Location}");
    }
}

Node.js

const OSS = require('ali-oss');

const client = new OSS({
  // yourregion填寫Bucket所在地區。以華東1(杭州)為例,Region填寫為oss-cn-hangzhou。
  region: 'yourregion',
  // 從環境變數中擷取訪問憑證。運行本程式碼範例之前,請確保已設定環境變數OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
  accessKeyId: process.env.OSS_ACCESS_KEY_ID,
  accessKeySecret: process.env.OSS_ACCESS_KEY_SECRET,
  authorizationV4: true,
  // yourBucketName填寫Bucket名稱。
  bucket: 'yourBucketName',
});

async function listBuckets() {
  try {
    // 列舉當前帳號所有地區下的儲存空間。
    const result = await client.listBuckets();
    console.log(result);
  } catch (err) {
    console.log(err);
  }
}

listBuckets();

Harmony

import Client, { RequestError } from '@aliyun/oss';

// 建立OSS用戶端執行個體
const client = new Client({
  // 請替換為STS臨時訪問憑證的Access Key ID
  accessKeyId: 'yourAccessKeyId',
  // 請替換為STS臨時訪問憑證的Access Key Secret
  accessKeySecret: 'yourAccessKeySecret',
  // 請替換為STS臨時訪問憑證的Security Token
  securityToken: 'yourSecurityToken',
});

// 列出所有bucket
const listBuckets = async () => {
  try {
    // 調用listBuckets方法列出所有的bucket
    const res = await client.listBuckets({});

    // 列印返回結果
    console.log(JSON.stringify(res));
  } catch (err) {
    // 捕獲並處理請求錯誤
    if (err instanceof RequestError) {
      console.log('錯誤碼: ', err.code); // 錯誤碼
      console.log('錯誤資訊: ', err.message); // 錯誤描述
      console.log('請求ID: ', err.requestId); // 請求的唯一標識
      console.log('HTTP狀態代碼: ', err.status); // HTTP響應狀態代碼
      console.log('錯誤類別: ', err.ec); // 錯誤類別
    } else {
      console.log('未知錯誤: ', err); // 非RequestError類型的錯誤
    }
  }
};

// 調用函數,列出所有bucket
listBuckets();

Swift

import AlibabaCloudOSS
import Foundation

@main
struct Main {
    static func main() async {
        do {
            // 填寫Bucket所在地區。以華東1(杭州)為例,Region填寫為cn-hangzhou。
            let region = "cn-hangzhou"
            // 可選項,指定訪問OSS服務的網域名稱。以華東1(杭州)為例,Endpoint填寫為https://oss-cn-hangzhou.aliyuncs.com
            let endpoint: String? = nil

            // 從環境變數載入憑證(需提前設定 OSS_ACCESS_KEY_ID 和 OSS_ACCESS_KEY_SECRET)
            let credentialsProvider = EnvironmentCredentialsProvider()

            // 配置OSS用戶端參數
            let config = Configuration.default()
                .withRegion(region) // 設定地區
                .withCredentialsProvider(credentialsProvider) // 設定憑證
                
            // 設定Endpoint
            if let endpoint = endpoint {
                config.withEndpoint(endpoint)
            }

            // 建立OSS用戶端執行個體
            let client = Client(config)

            // 建立分頁遍曆儲存空間(Bucket)的Paginator
            let paginator = client.listBucketsPaginator(ListBucketsRequest())

            // 遍曆所有儲存空間並輸出資訊
            for try await page in paginator {
                for bucket in page.buckets ?? [] {
                    print("Bucket名稱: \(bucket.name ?? ""), 儲存類型: \(bucket.storageClass ?? ""), 所屬地區: \(bucket.location ?? "")")
                }
            }

        } catch {
            // 捕獲並處理異常
            print("error:\n\(error)")
        }
    }
}

Ruby

require 'aliyun/oss'

client = Aliyun::OSS::Client.new(
  # Endpoint以華東1(杭州)為例,其它Region請按實際情況填寫。
  endpoint: 'https://oss-cn-hangzhou.aliyuncs.com',
  # 從環境變數中擷取訪問憑證。運行本程式碼範例之前,請確保已設定環境變數OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
  access_key_id: ENV['OSS_ACCESS_KEY_ID'],
  access_key_secret: ENV['OSS_ACCESS_KEY_SECRET']
)
# 列舉當前帳號所有地區下的儲存空間。
buckets = client.list_buckets
buckets.each { |b| puts b.name }

Android

完整範例程式碼請參見列舉儲存空間

// 列舉當前帳號所有地區下的儲存空間。
ListBucketsRequest request = new ListBucketsRequest();
ossClient.asyncListBuckets(request, new OSSCompletedCallback<ListBucketsRequest, ListBucketsResult>() {
    @Override
    public void onSuccess(ListBucketsRequest request, ListBucketsResult result) {
        List<OSSBucketSummary> buckets = result.getBuckets();
        for (int i = 0; i < buckets.size(); i++) {
            Log.i("info", "name: " + buckets.get(i).name + " "
                    + "location: " + buckets.get(i).location);
        }
    }

    @Override
    public void onFailure(ListBucketsRequest request, ClientException clientException, ServiceException serviceException) {
        // 請求異常。
        if (clientException != null) {
            // 用戶端異常,例如網路異常等。
            clientException.printStackTrace();
        }
        if (serviceException != null) {
            // 服務端異常。
            Log.e("ErrorCode", serviceException.getErrorCode());
            Log.e("RequestId", serviceException.getRequestId());
            Log.e("HostId", serviceException.getHostId());
            Log.e("RawMessage", serviceException.getRawMessage());
        }
    }
});

C++

#include <alibabacloud/oss/OssClient.h>
using namespace AlibabaCloud::OSS;

int main(void)
{
    /*初始化OSS帳號資訊。*/
    
    /*yourEndpoint填寫Bucket所在地區對應的Endpoint。以華東1(杭州)為例,Endpoint填寫為https://oss-cn-hangzhou.aliyuncs.com。*/
    std::string Endpoint = "yourEndpoint";
    
    / *yourRegion填寫Bucket所在地區對應的Region。以華東1(杭州)為例,Region填寫為cn - hangzhou。 * /
    std::string Region = "yourRegion";

    /*初始化網路等資源。*/
    InitializeSdk();

    ClientConfiguration conf;
    conf.signatureVersion = SignatureVersionType::V4;
    /* 從環境變數中擷取訪問憑證。運行本程式碼範例之前,請確保已設定環境變數OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。*/
    auto credentialsProvider = std::make_shared<EnvironmentVariableCredentialsProvider>();
    OssClient client(Endpoint, credentialsProvider, conf);
    client.SetRegion(Region);

    /*列舉當前帳號下的所有儲存空間。*/
    ListBucketsRequest request;
    auto outcome = client.ListBuckets(request);

    if (outcome.isSuccess()) {
        /*列印儲存空間資訊。*/
        std::cout <<" success, and bucket count is" << outcome.result().Buckets().size() << std::endl;
        std::cout << "Bucket name is" << std::endl;
        for (auto result : outcome.result().Buckets())
        {
            std::cout << result.Name() << std::endl;
        }
    }
    else {
        /*異常處理。*/
        std::cout << "ListBuckets fail" <<
        ",code:" << outcome.error().Code() <<
        ",message:" << outcome.error().Message() <<
        ",requestId:" << outcome.error().RequestId() << std::endl;
        return -1;
    }

    /*釋放網路等資源。*/
    ShutdownSdk();
    return 0;
}

iOS

OSSGetServiceRequest * getService = [OSSGetServiceRequest new];
// 列舉當前帳號所有地區下的儲存空間。    
OSSTask * getServiceTask = [client getService:getService];
[getServiceTask continueWithBlock:^id(OSSTask *task) {
    if (!task.error) {
        OSSGetServiceResult * result = task.result;
        NSLog(@"buckets: %@", result.buckets);
        NSLog(@"owner: %@, %@", result.ownerId, result.ownerDispName);
        [result.buckets enumerateObjectsUsingBlock:^(id  _Nonnull obj, NSUInteger idx, BOOL * _Nonnull stop) {
            NSDictionary * bucketInfo = obj;
            NSLog(@"BucketName: %@", [bucketInfo objectForKey:@"Name"]);
            NSLog(@"CreationDate: %@", [bucketInfo objectForKey:@"CreationDate"]);
            NSLog(@"Location: %@", [bucketInfo objectForKey:@"Location"]);
        }];
    } else {
        NSLog(@"get service failed, error: %@", task.error);
    }
    return nil;
}];
// 實現同步阻塞等待任務完成。
// [getServiceTask waitUntilFinished];

C

#include "oss_api.h"
#include "aos_http_io.h"
/* yourEndpoint填寫Bucket所在地區對應的Endpoint。以華東1(杭州)為例,Endpoint填寫為https://oss-cn-hangzhou.aliyuncs.com。*/
const char *endpoint = "yourEndpoint";
/* yourRegion填寫Bucket所在地區對應的Region。以華東1(杭州)為例,Region填寫為cn-hangzhou。*/
const char *region = "yourRegion";
void init_options(oss_request_options_t *options)
{
    options->config = oss_config_create(options->pool);
    /* 用char*類型的字串初始化aos_string_t類型。*/
    aos_str_set(&options->config->endpoint, endpoint);
    /* 從環境變數中擷取訪問憑證。運行本程式碼範例之前,請確保已設定環境變數OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。*/
    aos_str_set(&options->config->access_key_id, getenv("OSS_ACCESS_KEY_ID"));
    aos_str_set(&options->config->access_key_secret, getenv("OSS_ACCESS_KEY_SECRET"));
    //需要額外配置以下兩個參數
    aos_str_set(&options->config->region, region);
    options->config->signature_version = 4;
    /* 是否使用CNAME網域名稱訪問OSS服務。0表示不使用。*/
    options->config->is_cname = 0;
    /* 設定網路相關參數,比如逾時時間等*/
    options->ctl = aos_http_controller_create(options->pool, 0);
}
int main(int argc, char *argv[])
{
    /* 在程式入口調用aos_http_io_initialize方法來初始化網路、記憶體等全域資源。*/
    if (aos_http_io_initialize(NULL, 0) != AOSE_OK) {
        exit(1);
    }
    /* 用於記憶體管理的記憶體池(pool),等價於apr_pool_t。其實現代碼在apr庫中。*/
    aos_pool_t *pool;
    /* 重新建立一個記憶體池,第二個參數是NULL,表示沒有繼承其它記憶體池。*/
    aos_pool_create(&pool, NULL);
    /* 建立並初始化options,該參數包括endpoint、access_key_id、acces_key_secret、is_cname、curl等全域配置資訊。*/
    oss_request_options_t *oss_client_options;
    /* 在記憶體池中分配記憶體給options。*/
    oss_client_options = oss_request_options_create(pool);
    /* 初始化Client的選項oss_client_options。*/
    init_options(oss_client_options);
    /* 初始化參數。*/
    aos_table_t *resp_headers = NULL; 
    aos_status_t *resp_status = NULL; 
    oss_list_buckets_params_t *params = NULL;
    oss_list_bucket_content_t *content = NULL;
    int size = 0;
    params = oss_create_list_buckets_params(pool);
    /* 列舉儲存空間。*/
    resp_status = oss_list_bucket(oss_client_options, params, &resp_headers);
    if (aos_status_is_ok(resp_status)) {
        printf("list buckets succeeded\n");
    } else {
        printf("list buckets failed\n");
    }
    /* 列印儲存空間。*/
    aos_list_for_each_entry(oss_list_bucket_content_t, content, &params->bucket_list, node) {
        printf("BucketName: %s\n", content->name.data);
        ++size;
    }
    /* 釋放記憶體池,相當於釋放了請求過程中各資源分派的記憶體。*/
    aos_pool_destroy(pool);
    /* 釋放之前分配的全域資源。*/
    aos_http_io_deinitialize();
    return 0;
}

ossbrowser

登入ossbrowser 2.0後,單擊頁面左側全部按鈕顯示當前帳號下的所有儲存空間。有關ossbrowser 2.0的安裝與登入,請參見安裝ossbrowser 2.0登入ossbrowser 2.0

image

API

以上操作方式底層基於API實現,如果您的程式自訂要求較高,您可以直接發起REST API請求。直接發起REST API請求需要手動編寫代碼計算簽名。更多資訊,請參見ListBuckets(GetService)

列舉指定首碼的儲存空間

通過設定prefix參數進行服務端篩選,僅返回名稱匹配指定首碼的儲存空間。

ossutil

列舉要求者擁有的以example為首碼的所有儲存空間。

ossutil api list-buckets --prefix example

更多用法請參見list-buckets(get-service)

SDK

Java

完整範例程式碼見列舉儲存空間(Java SDK)

// 1. 建立請求對象
ListBucketsRequest listBucketsRequest = new ListBucketsRequest();

// 2. 設定首碼參數
listBucketsRequest.setPrefix("example");

// 3. 執行請求
BucketList bucketList = ossClient.listBuckets(listBucketsRequest);

Python

完整範例程式碼請參見列舉儲存空間(Python SDK V2)

# 在分頁器的 iter_page 方法中傳入帶 prefix 參數的請求對象
for page in paginator.iter_page(oss.ListBucketsRequest(
    prefix='example'
)):
    # ... 迴圈處理 ...

Go

完整範例程式碼請參見列舉儲存空間(Go SDK V2)

// 1. 建立請求對象,並設定 Prefix 欄位
request := &oss.ListBucketsRequest{
    Prefix: oss.Ptr("example"), 
}

// 2. 使用該請求對象建立分頁器
p := client.NewListBucketsPaginator(request)

Node.js

完整範例程式碼請參見列舉儲存空間(Node.js SDK)

// 在 listBuckets 方法的參數對象中指定 prefix
const result = await client.listBuckets({
  prefix: 'example' 
});

Harmony

完整範例程式碼請參見列舉儲存空間(Harmony SDK)

// 關鍵代碼:在調用 listBuckets 時傳入一個含 prefix 的對象
const res = await client.listBuckets({
  prefix: 'bucketNamePrefix'
});

Ruby

完整範例程式碼請參見列舉儲存空間

# 關鍵代碼:以 :prefix 作為參數調用 list_buckets
buckets = client.list_buckets(:prefix => 'example')

列舉指定位置後的儲存空間

通過設定marker參數指定列表的起始位置,是實現手動分頁的核心步驟。

ossutil

列舉要求者擁有的從examplebucket之後的所有儲存空間。

ossutil api list-buckets --marker examplebucket

更多用法請參見list-buckets(get-service)

SDK

Java

完整範例程式碼見列舉儲存空間(Java SDK)

// 1. marker設定為"examplebucket",列出"examplebucket"之後的bucket。
String nextMarker = "examplebucket"; 
BucketList bucketListing;

do {
    // 2. 使用當前 marker 發起請求。
    bucketListing = ossClient.listBuckets(new ListBucketsRequest()
            .withMarker(nextMarker)
            .withMaxKeys(200));

    // 3. 更新 marker 以便擷取下一頁。
    nextMarker = bucketListing.getNextMarker(); 
} while (bucketListing.isTruncated());

Python

完整範例程式碼請參見列舉儲存空間(Python SDK V2)

# marker設定為"example-bucket",列出"example-bucket"之後的bucket。
for page in paginator.iter_page(oss.ListBucketsRequest(
    marker="example-bucket"
)):
    # ... 遍曆 page ...

Go

完整範例程式碼請參見列舉儲存空間(Go SDK V2)

// marker設定為"example-bucket",列出"example-bucket"之後的bucket。
request := &oss.ListBucketsRequest{
    Marker: oss.Ptr("example-bucket"), 
}

// 使用該請求建立分頁器
p := client.NewListBucketsPaginator(request)

Harmony

完整範例程式碼請參見列舉儲存空間(Harmony SDK)

// marker的初始值設定為"examplebucket",指定列舉的起始點。
let marker: string | undefined = "examplebucket"; 
let isTruncated = true;

while (isTruncated) {
  // 在請求中使用當前的 marker
  const res = await client.listBuckets({
    marker 
  });
  // ...
  // 更新 marker 以便下一次迴圈
  marker = res.data.nextMarker; 
  isTruncated = res.data.isTruncated;
}

Node.js

完整範例程式碼請參見列舉儲存空間(Node.js SDK)

// marker設定為'examplebucket',列出'examplebucket'之後的bucket。
const result = await client.listBuckets({
  marker: 'examplebucket' 
});

Android

完整範例程式碼請參見列舉儲存空間

ListBucketsRequest request = new ListBucketsRequest();
// marker設定為"examplebucket",列出"examplebucket"之後的bucket。
request.setMarker("examplebucket");

ossClient.asyncListBuckets(request, ...);```

#### **iOS (Objective-C)**
```objectivec
OSSGetServiceRequest * getService = [OSSGetServiceRequest new];
// marker設定為"examplebucket",列出"examplebucket"之後的bucket。
getService.marker = @"examplebucket";

OSSTask * getServiceTask = [client getService:getService];

iOS

完整範例程式碼請參見列舉儲存空間

OSSGetServiceRequest * getService = [OSSGetServiceRequest new];

// marker設定為"examplebucket",列出"examplebucket"之後的bucket。
getService.marker = @"examplebucket";

// 使用該請求對象發起非同步任務
OSSTask * getServiceTask = [client getService:getService];

列舉指定資源群組內的儲存空間

根據指定的資源群組ID精確尋找Bucket。

ossutil

列舉要求者指定資源群組ID為rg-123的所有儲存空間。

ossutil api list-buckets --resource-group-id rg-123

更多用法請參見list-buckets(get-service)

SDK

Java

完整範例程式碼見列舉儲存空間(Java SDK)

ListBucketsRequest listBucketsRequest = new ListBucketsRequest();

// 關鍵代碼:設定要篩選的資源群組ID。
listBucketsRequest.setResourceGroupId("rg-aek27tc****");

// 將配置好的請求對象傳入 listBuckets 方法
BucketList bucketList = ossClient.listBuckets(listBucketsRequest);

Python

完整範例程式碼請參見列舉儲存空間(Python SDK V2)

# 關鍵代碼:在 iter_page 方法中構造請求並指定 resource_group_id。
for page in paginator.iter_page(oss.ListBucketsRequest(
    resource_group_id="rg-aek27tc********"
)):
    # ... 遍曆 page ...

Go

完整範例程式碼請參見列舉儲存空間(Go SDK V2)

// 關鍵代碼:建立請求並設定 ResourceGroupId 欄位。
request := &oss.ListBucketsRequest{
    ResourceGroupId: oss.Ptr("rg-aek27tc********"), 
}

// 使用該請求建立分頁器
p := client.NewListBucketsPaginator(request)

PHP

完整範例程式碼參見列舉儲存空間(PHP SDK V2)

// 關鍵代碼:在 iterPage 方法中構造請求並指定 resourceGroupId。
$iter = $paginator->iterPage(new Oss\Models\ListBucketsRequest(
    resourceGroupId: "rg-aekzfalvmw2sxby"
));

控制單次返回數量

通過設定max-keys參數,控制單次請求返回的Bucket數量,即定義分頁大小。

ossutil

限定本次調用最多返回100個儲存空間。

ossutil api list-buckets --max-keys 100

更多用法請參見list-buckets(get-service)

SDK

Java

完整範例程式碼見列舉儲存空間(Java SDK)

ListBucketsRequest listBucketsRequest = new ListBucketsRequest();

// 關鍵代碼:設定maxKeys參數為500,限定本次最多返回500個Bucket。
listBucketsRequest.setMaxKeys(500);

// 將配置好的請求對象傳入方法
BucketList bucketList = ossClient.listBuckets(listBucketsRequest);

Python

完整範例程式碼請參見列舉儲存空間(Python SDK V2)

# 關鍵代碼:在建立ListBucketsRequest時,傳入max_keys參數為10。
# 這會使得分頁器每次請求最多擷取10個Bucket。
for page in paginator.iter_page(oss.ListBucketsRequest(
    max_keys=10
)):
    # ... 遍曆 page ...

Go

完整範例程式碼請參見列舉儲存空間(Go SDK V2)

// 關鍵代碼:在建立ListBucketsRequest時,設定MaxKeys欄位為5。
// 分頁器將使用此設定,每次請求最多擷取5個Bucket。
request := &oss.ListBucketsRequest{
    MaxKeys: 5,
}

p := client.NewListBucketsPaginator(request)

Node.js

完整範例程式碼請參見列舉儲存空間(Node.js SDK)

// 關鍵代碼:在調用listBuckets時,傳入一個包含'max-keys'屬性的對象。
// 'max-keys'被設定為500,限定本次最多返回500個Bucket。
const result = await client.listBuckets({
  'max-keys': 500
});

Android

完整範例程式碼請參見列舉儲存空間

ListBucketsRequest request = new ListBucketsRequest();

// 關鍵代碼:設定maxKeys參數為500,限定本次非同步請求最多返回500個Bucket。
request.setMaxKeys(500);

ossClient.asyncListBuckets(request, ...);

iOS

完整範例程式碼請參見列舉儲存空間

OSSGetServiceRequest * getService = [OSSGetServiceRequest new];

// 關鍵更代碼:設定getService請求對象的maxKeys屬性為500。
getService.maxKeys = 500;

OSSTask * getServiceTask = [client getService:getService];

使用限制

不支援使用傳輸加速 Endpoint 列舉 Bucket。因為傳輸加速服務僅解析攜帶Bucket名稱的第三層網域名(例如 https://BucketName.oss-accelerate.aliyuncs.com),而列舉Bucket 的請求網域名稱中不攜帶Bucket名稱(格式為 https://oss-cn-hangzhou.aliyuncs.com)。