vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/obs/api-swift/obs_03_0017.html
zhangyue 894279c39a Object Storage Service API Reference Swift V1 
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: zhangyue <zhangyue164@huawei.com>
Co-committed-by: zhangyue <zhangyue164@huawei.com>
2023-02-02 08:50:48 +00:00

11 KiB
Raw Permalink Blame History

Request

Method

Table 1 Method description

Method

URI

Description

GET

/v1/{account}{?limit,marker,end_marker,format,prefix,delimiter}

Shows details of a specified account and lists the containers, sorted by name in ascending order, in the account.

{account} indicates the name of an account.

This operation does not involve a request body.

Example Request

Show account details and list containers, and ask for a JSON response:

curl -i $publicURL?format=json -X GET -H "X-Auth-Token:$token"

Request Headers

Request URI parameters

Parameter

Type

Description

{account}

String

(Required)

A unique account name. In the current version, it indicates a unique ID for the account.

Request header parameters

Parameter

Type

Description

X-Auth-Token

String

(Required)

Authentication token.

Accept

String

(Optional)

Similar to the format query parameter, set this header to application/json, application/xml, or text/xml.

If the value of Accept is invalid, OBS (compatible with OpenStack Swift) returns the 406 (Not Acceptable) error code. Then, OpenStack Swift will process the request based on the default value of Accept.

Request Query Parameters

Table 2 Request query parameters

Parameter

Type

Description

limit

Int

(Optional)

Limits the number of containers in a query result.

Value range: 0 to 10000

Default value: 10000

If this parameter is set to a value larger than 10000, an error is reported.

marker

String

(Optional)

Returns container names that are greater than the specified marker.

end_marker

String

(Optional)

Returns container names that are smaller than the specified marker.

format

String

(Optional)

Sets the format of the returned container list. The valid values are plain (default), json, and xml. Its function is the same as Accept.

prefix

String

(Optional)

Returns containers that have the specified prefix.

delimiter

Char

(Optional)

Returns the container names that are nested in the account.