All Products
Search
Document Center

Object Storage Service:Delete buckets, Delete buckets

Last Updated:Feb 26, 2024

If you no longer use an Object Storage Service (OSS) bucket, you can delete the bucket to stop unnecessary charges.

Warning

Deleted buckets cannot be restored. Make sure that the data in the buckets is no longer needed before you delete the buckets. If you want to continue using the data in the buckets, back up the data in advance. For more information, see Back up buckets.

Prerequisites

  • The access points of the bucket are deleted. For more information, see Overview.

  • All objects in the bucket are deleted.

    Important

    To delete a versioning-enabled bucket, make sure that all current and previous versions of objects in the bucket are deleted. For more information, see Overview.

    • If the bucket contains a small number of objects, we recommend that you manually delete them. For more information, see Delete objects.

    • If the bucket contains a large number of objects, we recommend that you configure lifecycle rules to delete the objects. For more information, see Overview.

  • Parts generated by multipart upload or resumable upload tasks in the bucket are deleted. For more information, see Delete parts.

  • All LiveChannels in the bucket are deleted. For more information, see DeleteLiveChannel.

  • The oss:DeleteBucket permission is granted to a RAM user if you want to use the RAM user to delete the bucket. For more information, see Attach a custom policy to a RAM user.

    Note

    If the RAM user has the oss:DeleteBucket permission in a RAM policy but cannot delete the bucket, a bucket policy may contain the oss:DeleteBucket permission whose effect is Deny. In this case, you need to change Deny to Allow or delete the bucket policy. Then, you can delete the bucket.

Usage notes

  • In this topic, the public endpoint of the China (Hangzhou) region is used. If you want to access OSS from other Alibaba Cloud services in the same region as OSS, use an internal endpoint. For more information about OSS regions and endpoints, see Regions and endpoints.

  • In this topic, an OSSClient instance is created by using an OSS endpoint. If you want to create an OSSClient instance by using custom domain names or Security Token Service (STS), see Create an OSSClient instance.

  • To delete a bucket, you must have the oss:DeleteBucket permission. For more information, see Attach a custom policy to a RAM user.

Examples

The following sample code shows how to delete a bucket named examplebucket:

<?php
if (is_file(__DIR__ . '/../autoload.php')) {
    require_once __DIR__ . '/../autoload.php';
}
if (is_file(__DIR__ . '/../vendor/autoload.php')) {
    require_once __DIR__ . '/../vendor/autoload.php';
}

use OSS\Credentials\EnvironmentVariableCredentialsProvider;
use OSS\OssClient;
use OSS\CoreOssException;

// Obtain access credentials from environment variables. Before you run the sample code, make sure that the OSS_ACCESS_KEY_ID and OSS_ACCESS_KEY_SECRET environment variables are configured. 
$provider = new EnvironmentVariableCredentialsProvider();
// Specify the endpoint of the region in which the bucket is located. For example, if the bucket is located in the China (Hangzhou) region, set the endpoint to https://oss-cn-hangzhou.aliyuncs.com. 
$endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
// Specify the name of the bucket. Example: examplebucket. 
$bucket= "examplebucket";

try{
    $config = array(
        "provider" => $provider,
        "endpoint" => $endpoint,
    );
    $ossClient = new OssClient($config);

    $ossClient->deleteBucket($bucket);
} catch(OssException $e) {
    printf(__FUNCTION__ . ": FAILED\n");
    printf($e->getMessage() . "\n");
    return;
}
print(__FUNCTION__ . ": OK" . "\n");        

References

  • For the complete sample code that is used to delete a bucket, visit GitHub.

  • For more information about the API operation that you can call to delete a bucket, see DeleteBucket.