Help Center/ Object Storage Service/ API Reference/ Bucket APIs/ Versioning/ Obtaining Bucket Versioning Status
Updated on 2026-04-16 GMT+08:00

Obtaining Bucket Versioning Status

Functions

This API is used to obtain the versioning status of a bucket. If versioning is not configured for the bucket, no versioning status of the bucket will be returned. For more information about versioning, see Versioning.

Authorization Information

To call this API, you must be the bucket owner or have the permission to obtain the versioning status of a bucket. You are advised to use IAM or bucket policies for authorization. For details about OBS authorization methods, see Differences Between OBS Permissions Control Methods.

  • If you use IAM for authorization, you need to use either role/policy-based authorization or identity policy-based authorization and configure the required permissions:
    • If you use role/policy-based authorization (IAM v3 APIs in the old IAM version), you need to grant the obs:bucket:GetBucketVersioning permission. For details, see Creating a Custom IAM Policy.
  • If you use bucket policies for authorization, you need to grant the obs:bucket:GetBucketVersioning permission. For details, see Creating a Custom Bucket Policy.

Request Syntax

1
2
3
4
GET /?versioning HTTP/1.1 
Host: bucketname.obs.region.myhuaweicloud.com 
Date: date
Authorization: authorization

URI Parameters

This request contains no message parameters.

Request Headers

This request uses common headers. For details, see Table 3.

Request Body

This request contains no request body parameters.

Response Syntax

1
2
3
4
5
6
7
8
HTTP/1.1 status_code
Date: date
Content-Type: type
Content-Length: length

<VersioningConfiguration xmlns="http://obs.region.myhuaweicloud.com/doc/2015-06-30/">
    <Status>status</Status> 
</VersioningConfiguration>

Response Headers

This response uses common headers. For details, see Table 1.

Response Body

This response contains elements to specify the bucket versioning status. Table 1 describes the elements.

Table 1 Response body parameters

Parameter

Type

Description

VersioningConfiguration

XML

Definition

Root node of versioning configuration, which is the parent node of Status.

Constraints

N/A

Status

String

Definition

Versioning status of the bucket.

Constraints

N/A

Range

  • Enabled: Versioning is enabled.
  • Suspended: Versioning is suspended.

Default Value

N/A

Error Responses

No special error responses are returned. For details about error responses, see Table 2.

Sample Request

1
2
3
4
5
6
GET /?versioning HTTP/1.1
User-Agent: curl/7.29.0
Host: examplebucket.obs.region.myhuaweicloud.com
Accept: */*
Date: WED, 01 Jul 2015 03:15:20 GMT
Authorization: OBS H4IPJX0TQTHTHEBQQCEC:4N5qQIoluLO9xMY0m+8lIn/UWXM=

Sample Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
HTTP/1.1 200 OK
Server: OBS
x-obs-request-id: BF260000016436BBA4930622B4FC9F17
x-obs-id-2: 32AAAQAAEAABAAAQAAEAABAAAQAAEAABCSQIrNJ5/Ag6EPN8DAwWlPWgBc/xfBnx
Content-Type: application/xml
Date: WED, 01 Jul 2015 03:15:20 GMT
Content-Length: 180

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<VersioningConfiguration xmlns="http://obs.ap-southeast-1.myhuaweicloud.com/doc/2015-06-30/">
  <Status>Enabled</Status>
</VersioningConfiguration>

Using SDKs to Call APIs

You are advised to use OBS SDKs to call APIs. SDKs encapsulate APIs to simplify development. You can call SDK API functions to access OBS without manually calculating signatures.

Java

Python

C

Go

BrowserJS

.NET

Android

iOS

PHP

Node.js

Harmony: not supported

References

  • For more information about versioning, see Versioning.
  • For details about the billing items involved in API operations, see Billing Items.