HTTP Status Code Reference for ESA - Edge Security Acceleration

When versioning is enabled for a bucket, you can restore an object to any of its previous versions if the object is accidentally overwritten or deleted. Versioning applies to all objects in a bucket.

Prerequisites

Before you begin, ensure that you have:

An OSS bucket
The oss:PutBucketVersioning permission to enable or suspend versioning, or the oss:GetBucketVersioning permission to query the versioning state. For details, see Grant a custom access policy to a RAM user

Usage notes

The sample code uses the China (Hangzhou) region (cn-hangzhou) and the public endpoint by default. To access OSS from other Alibaba Cloud services in the same region, use an internal endpoint instead. For a full list of regions and endpoints, see OSS regions and endpoints.

Enable versioning

The following code enables versioning for a bucket by calling put_bucket_versioning with status set to Enabled.

import argparse
import alibabacloud_oss_v2 as oss

parser = argparse.ArgumentParser(description="put bucket versioning sample")
parser.add_argument('--region', help='The region in which the bucket is located.', required=True)
parser.add_argument('--bucket', help='The name of the bucket.', required=True)
parser.add_argument('--endpoint', help='The domain names that other services can use to access OSS')

def main():
    args = parser.parse_args()

    # Load credentials from environment variables.
    credentials_provider = oss.credentials.EnvironmentVariableCredentialsProvider()

    cfg = oss.config.load_default()
    cfg.credentials_provider = credentials_provider
    cfg.region = args.region

    if args.endpoint is not None:
        cfg.endpoint = args.endpoint

    client = oss.Client(cfg)

    result = client.put_bucket_versioning(oss.PutBucketVersioningRequest(
        bucket=args.bucket,
        versioning_configuration=oss.VersioningConfiguration(
            status='Enabled'
        )
    ))

    print(f'status code: {result.status_code},'
          f' request id: {result.request_id},'
          )

if __name__ == "__main__":
    main()

For the complete sample code, see put_bucket_version.py.

Get the versioning state of a bucket

The following code retrieves the versioning state of a bucket by calling get_bucket_versioning. The response field version_status returns Enabled, Suspended, or no value if versioning has never been set.

import argparse
import alibabacloud_oss_v2 as oss

parser = argparse.ArgumentParser(description="get bucket versioning sample")
parser.add_argument('--region', help='The region in which the bucket is located.', required=True)
parser.add_argument('--bucket', help='The name of the bucket.', required=True)
parser.add_argument('--endpoint', help='The domain names that other services can use to access OSS')

def main():
    args = parser.parse_args()

    # Load credentials from environment variables.
    credentials_provider = oss.credentials.EnvironmentVariableCredentialsProvider()

    cfg = oss.config.load_default()
    cfg.credentials_provider = credentials_provider
    cfg.region = args.region

    if args.endpoint is not None:
        cfg.endpoint = args.endpoint

    client = oss.Client(cfg)

    result = client.get_bucket_versioning(oss.GetBucketVersioningRequest(
        bucket=args.bucket,
    ))

    print(f'status code: {result.status_code},'
          f' request id: {result.request_id},'
          f' version status: {result.version_status},'
          )

if __name__ == "__main__":
    main()

The key fields in the response are:

Field	Type	Values	Description
`status_code`	int	HTTP status code	HTTP status of the request.
`request_id`	string	—	Unique identifier for the request, used for troubleshooting.
`version_status`	string	`Enabled`, `Suspended`, or empty	Current versioning state of the bucket. Empty if versioning has never been configured.

For the complete sample code, see get_bucket_cors.py.