Help Center/ Object Storage Service/ API Reference/ APIs/ Advanced Bucket Settings/ Obtaining the Direct Reading Policy of Archive Objects in a Bucket
Updated on 2026-03-06 GMT+08:00

Obtaining the Direct Reading Policy of Archive Objects in a Bucket

Functions

The owner of a bucket can obtain the direct reading status of Archive objects in the bucket.

If the direct reading has never been configured for Archive objects or the configured direct reading policy has been deleted, no status will be returned after this operation.

To perform this operation, you must have the GetDirectColdAccessConfiguration permission. By default, only the bucket owner can perform this operation. The bucket owner can grant the permission to other users by configuring the bucket policy or user policy.

Authorization Information

To call this API, you must be the bucket owner or have the permission to obtain the direct reading policy of Archive objects in 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:GetDirectColdAccessConfiguration permission. For details, see Creating a Custom IAM Policy.
    • If you use identity policy-based authorization (IAM v5 APIs in the new IAM version), you need to grant the obs:bucket:getDirectColdAccessConfiguration permission, as shown in the following table. For details, see Creating a Custom IAM Identity Policy.

      Action

      Access Level

      Resource Type (*: Required)

      Condition Key

      Alias

      Dependencies

      obs:bucket:getDirectColdAccessConfiguration

      Read

      bucket *

      -

      -

      -

      • obs:EpochTime
      • obs:SourceIp
      • obs:TlsVersion
      • obs:CustomDomain
  • If you use bucket policies for authorization, you need to grant the obs:bucket:GetDirectColdAccessConfiguration permission. For details, see Creating a Custom Bucket Policy.

Request Syntax

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

Request Parameters

This request contains no message parameters.

Request Headers

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

Request Elements

This request involves no elements.

Response Syntax

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

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

Response Headers

The response to the request uses common headers. For details, see Table 1.

Response Elements

This response contains elements to indicate the direct reading status of Archive objects. Table 1 describes the elements.

Table 1 Response elements

Parameter

Type

Description

DirectColdAccessConfiguration

Container

Definition:

Indicates the direct reading information of Archive objects.

Range:

None

Status

String

Definition:

Indicates the direct reading status for a bucket. If direct reading has never been configured for Archive objects or the direct reading configuration has been deleted, no direct reading status will be returned.

Range:

  • Enabled: The direct reading policy is enabled for Archive objects.
  • Disabled: The direct reading policy is disabled for Archive objects.
  • If the Status parameter is not specified, the direct reading policy is disabled for Archive objects in the bucket.

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 /?directcoldaccess 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: 0000016A6C21AD79654C09D9AA45EB5D
x-obs-id-2: 32AAAQAAEAABAAAQAAEAABAAAQAAEAABCSmfq4hegf1QZv8/ewfveE4B566v5DZ8
Content-Type: application/xml
Date: Tue, 30 Apr 2019 02:45:07 GMT
Content-Length: 192

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