Updated on 2025-12-17 GMT+08:00

Listing General-Purpose File Systems

Function

This API is used to list general-purpose file systems.

Authorization

Each account has all of the permissions required to call all APIs, but IAM users must have the required permissions specifically assigned. For the specific permissions required, see Permissions Policies and Supported Actions.

URI

GET /

Request Parameters

Table 1 Request header parameters

Parameter

Mandatory

Type

Description

x-obs-bucket-type

Yes

String

This header field is used to specify the content to be obtained. The value is SFS, which lists all general-purpose file systems.

Authorization

Yes

String

The signature information.

Date

Yes

String

The request time.

Host

Yes

String

The host address.

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

Owner

Owner object

The owner information of the general-purpose file system, including the tenant ID.

Buckets

Buckets object

The general-purpose file systems owned by the user.

Table 3 Owner

Parameter

Type

Description

ID

String

The domain ID (account ID) of a user.

Table 4 Buckets

Parameter

Type

Description

Bucket

Bucket object

The detailed information of the general-purpose file system.

Table 5 Bucket

Parameter

Type

Description

Name

String

The name of the general-purpose file system.

CreationDate

String

The time when the general-purpose file system was created.

Location

String

The location of the general-purpose file system.

Example Request

GET / HTTP/1.1 
Host: sfs3.example.region.com
Date: date
x-obs-bucket-type: SFS
Authorization: authorization

Example Response

HTTP/1.1 200 OK
Server: OBS
X-Obs-Request-Id: 0000018893B8126DC048B06DD3816BD4
X-Obs-Id-2: 32AAAQAAEAABAAAQAAEAABAAAQAAEAABCTMZh3Thi7lcDxuGWu9Qtp9PJbYXa7lb
Date: Wed, 07 Jun 2023 02:38:14 GMT
Content-Type: application/xml
Content-Length: 377

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ListAllMyBucketsResult xmlns="http://obs.myhwclouds.com/doc/2015-06-30/">
  <Owner>
    <ID>783fc6652cf246c096ea836694f71855</ID>
  </Owner>
  <Buckets>
    <Bucket>
      <Name>examplebucket01</Name>
      <CreationDate>2018-06-21T09:15:01.032Z</CreationDate>
      <Location>example-region-1</Location>
      <BucketType>SFS</BucketType>
    </Bucket>
    <Bucket>
      <Name>examplebucket02</Name>
      <CreationDate>2018-06-22T03:56:33.700Z</CreationDate>
      <Location>example-region-2</Location>
      <BucketType>SFS</BucketType>
    </Bucket>
  </Buckets>
</ListAllMyBucketsResult>

Status Codes

Status Code

Description

200

General-purpose file systems are listed.

Error Codes

See Error Codes.