This appendix contains a quick reference to the HSwift API methods. For each method, the appendix shows:
•The query parameters you can use in requests that use the method. Required parameters are listed first followed by optional parameters enclosed in square brackets ([]).
•The request headers for request that use the method. The required headers are listed first followed by optional headers enclosed in square brackets.
The methods are grouped by the level of access (HSwift account (that is, tenant), container, or object). Within each grouping, the methods are presented in alphabetical order.
For general information on HSwift requests, see Requests and responses
Description and permission | Query parameters | Request headers |
---|---|---|
Account-level operation |
||
GET account |
||
Description: Returns a list of containers owned by the requester. Permission: None; Requester must be an authenticated user. More information: Listing containers |
limit = integer marker=string end_marker=string format=string prefix=string |
"X-Auth-Token: Keystone-Authentication-Token" "Accept: application/xml |
HEAD account |
||
Description: Returns the number of containers, objects, and bytes on an account. Permission: None; Requester must be an authenticated user. More information:Listing account metadata |
N/A | "X-Auth-Token: Keystone-Authentication-Token" |
Container-level operations |
||
DELETE container |
||
Description: Deletes a container. Permission: Write. More information: Deleting a container |
N/A | "X-Auth-Token: Keystone-Authentication-Token" |
GET container |
||
Description: Lists object and directories in a container, along with the container's acl. Permission: Browse. More information: Listing container contents |
limit = integer marker=string end_marker=string prefix=string format=string delimiter=character path=string |
"X-Auth-Token: Keystone-Authentication-Token" "Accept: application/xml |
HEAD container |
||
Description:Checks the existence of a container. Permission: Read. More information: Checking a container's metadata |
N/A | "X-Auth-Token: Keystone-Authentication-Token" |
POST container |
||
Description: Adds an ACL to a container and sets the container quota. Permission: Write. More information: Adding an ACL to a container (data access permission only) |
N/A | "X-Auth-Token: Keystone-Authentication-Token"
"X-Container-Write: Keystone-account-user "X-Container-Meta-Quota-Bytes: Bytes-Quota" "X-Remove-Container-name" |
PUT container |
||
Description: Creates a container and optionally adds an acl to it. Permission: Write. More information: Creating a container |
N/A | "X-Auth-Token: Keystone-Authentication-Token"
"X-Container-Write: Keystone-account-user "X-Container-Meta-Quota-Bytes: Bytes-Quota" |
Object-level operations |
||
COPY object |
||
Description: Creates a copy of an object and its metadata. Permission: Write. More information: Copying an object |
N/A |
"X-Auth-Token: Keystone-Authentication-Token" "Destination: /container-destination/object-destination" "X-Object-Meta-name" |
DELETE object |
||
Description:Deletes an object or directory. Permission: Write. More information: Deleting an object or directory |
N/A | "X-Auth-Token: Keystone-Authentication-Token" |
GET object |
||
Description:Retrieves an object. Permission: Read. More information: Retrieving an object |
N/A |
"X-Auth-Token: Keystone-Authentication-Token" "Range: first-byte-offset-last-byte-offset" "If-Match: "ETag-value[,"ETag value"]" "If-None-Match: "ETag value[,"ETag value"]" "If-Modified-Since: DDD, dd MMM yyyy HH:mm:ss (+0000|GMT) "If-Unmodified-Since: DDD, dd MMM yyyy HH:mm:ss (+0000|GMT) |
HEAD object |
||
Description:Checks the existence of an object or directory. Permission: Read. More information: Checking the metadata of an object or directory |
N/A | "X-Auth-Token: Keystone-Authentication-Token" |
PUT object or directory |
||
Description:Stores an object or directory. Permission: Write. More information: Storing an object and Creating a directory |
N/A |
"X-Auth-Token: Keystone-Authentication-Token" "Content-Length: data-size-in-bytes" "Transfer-Encoding: chunked" "X-Copy-From: Container/Object" "ETag: MD5-checksum-value" "Content-Encoding: gzip" "X-Object-Meta-name" "If-None-Match: "ETag-value[,"ETag-value"]" "Except: 100-Continue" |
© 2015, 2020 Hitachi Vantara LLC. All rights reserved.