Harmony list buckets - Object Storage Service: Central de Documentação do Alibaba Cloud

Um bucket é um contêiner que armazena objetos, e todos os objetos são armazenados em um bucket. É possível listar buckets que atendam a condições específicas em todas as regiões da sua conta Alibaba Cloud. Os buckets listados aparecem em ordem alfabética.

Precauções

Para obter mais informações sobre as regiões compatíveis com o OSS e seus endpoints, consulte Regions and Endpoints.
Para listar buckets, é necessária a permissão oss:ListBuckets. Para obter mais informações, consulte Grant custom access policies to RAM users.
O código a seguir lista buckets em todas as regiões da sua conta Alibaba Cloud. Esta operação não permite listar buckets em uma região específica. A região do endpoint especificado não afeta o resultado.

Código de exemplo

O código a seguir mostra como listar todos os buckets de todas as regiões da sua conta Alibaba Cloud.

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

// Create an OSS client instance.
const client = new Client({
  // Replace with the Access Key ID of the Security Token Service (STS) temporary access credential.
  accessKeyId: 'yourAccessKeyId',
  // Replace with the Access Key Secret of the STS temporary access credential.
  accessKeySecret: 'yourAccessKeySecret',
  // Replace with the Security Token of the STS temporary access credential.
  securityToken: 'yourSecurityToken',
});

// List all buckets.
const listBuckets = async () => {
  try {
    // Call the listBuckets method to list all buckets.
    const res = await client.listBuckets({});

    // Print the result.
    console.log(JSON.stringify(res));
  } catch (err) {
    // Catch and handle request errors.
    if (err instanceof RequestError) {
      console.log('Error code: ', err.code); // Error code
      console.log('Error message: ', err.message); // Error description
      console.log('Request ID: ', err.requestId); // Unique identifier of the request
      console.log('HTTP status code: ', err.status); // HTTP response status code
      console.log('Error category: ', err.ec); // Error category
    } else {
      console.log('Unknown error: ', err); // Error that is not of the RequestError type
    }
  }
};

// Call the function to list all buckets.
listBuckets();

Outros cenários

Listar buckets com um prefixo específico

O código a seguir mostra como listar buckets com o prefixo bucketNamePrefix de todas as regiões da sua conta Alibaba Cloud.

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

// Create an OSS client instance.
const client = new Client({
  // Replace with the Access Key ID of the STS temporary access credential.
  accessKeyId: 'yourAccessKeyId',
  // Replace with the Access Key Secret of the STS temporary access credential.
  accessKeySecret: 'yourAccessKeySecret',
  // Replace with the Security Token of the STS temporary access credential.
  securityToken: 'yourSecurityToken',
});

// List buckets that start with a specific prefix.
const listBucketsWithPrefix = async () => {
  try {
    // Call the listBuckets method and specify the prefix parameter to filter bucket names.
    const res = await client.listBuckets({
      prefix: 'bucketNamePrefix' // Specify the prefix for bucket names.
    });

    // Print the result.
    console.log(JSON.stringify(res));
  } catch (err) {
    if (err instanceof RequestError) {
      console.log('Error code: ', err.code);
      console.log('Error message: ', err.message);
      console.log('Request ID: ', err.requestId);
      console.log('HTTP status code: ', err.status);
      console.log('Error category: ', err.ec);
    } else {
      console.log('Unknown error: ', err);
    }
  }
};

// Call the function to list buckets that start with a specific prefix.
listBucketsWithPrefix();

Listar todos os buckets usando um token de paginação (marker)

O código a seguir mostra como listar todos os buckets com um token de paginação (marker).

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

// Create an OSS client instance.
const client = new Client({
  // Replace with the Access Key ID of the STS temporary access credential.
  accessKeyId: 'yourAccessKeyId',
  // Replace with the Access Key Secret of the STS temporary access credential.
  accessKeySecret: 'yourAccessKeySecret',
  // Replace with the Security Token of the STS temporary access credential.
  securityToken: 'yourSecurityToken',
});

// List all buckets using a pagination token (marker).
const listBucketsWithMarker = async () => {
  try {
    let marker: string | undefined; // The pagination token. It is initially empty.
    let isTruncated = true; // Indicates whether there is more data to retrieve.

    // Loop to retrieve all buckets until there is no more data.
    while (isTruncated) {
      const res = await client.listBuckets({
        marker // The current pagination token.
      });

      // Print the result.
      console.log(JSON.stringify(res));

      // Update the pagination status.
      isTruncated = res.data.isTruncated; // Indicates whether there is more data.
      marker = res.data.nextMarker; // The next pagination token.
    }
  } catch (err) {
    if (err instanceof RequestError) {
      console.log('Error code: ', err.code);
      console.log('Error message: ', err.message);
      console.log('Request ID: ', err.requestId);
      console.log('HTTP status code: ', err.status);
      console.log('Error category: ', err.ec);
    } else {
      console.log('Unknown error: ', err);
    }
  }
};

// Call the function to list all buckets using a pagination token.
listBucketsWithMarker();

Referências

Para obter mais informações sobre a operação de API para listar buckets, consulte ListBuckets (GetService).