< Previous | Contents | Next >

Quick reference


This appendix contains a quick reference to the HS3 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 requests that use the method. Required headers are listed first followed by optional headers enclosed in square brackets.


The methods are grouped by the level of access (service (that is, tenant), bucket, or object). Within each grouping, the methods are presented in alphabetical order.


For general information on HS3 requests, see “Requests” on page 54.


Appendix A: Quick reference 197


Description and permission

Query parameters

Request headers

Service-level operation

GET service

Description: Returns a list of buckets owned by the requester


Permission: None; requester must be an authenticated user


More information: “Listing the buckets you own” on page 71

N/A

Authorization:

AWS access-key:signature


Date: DDD, dd MMM yyyy HH:mm:ss

(+0000|GMT)

OR

x-amz-date: DDD, dd MMM yyyy HH:mm:ss

(+0000|GMT)


Host: hostname.hcp-domain-name


[x-hcp-pretty-print: (true|false)]

Bucket-level operations

DELETE bucket

Description: Deletes a bucket


Permission: None; requester must be the bucket owner


More information: “Deleting a bucket” on page 121

N/A

Authorization:

AWS access-key:signature


Date: DDD, dd MMM yyyy HH:mm:ss

(+0000|GMT)

OR

x-amz-date: DDD, dd MMM yyyy HH:mm:ss

(+0000|GMT)


Host: hostname.hcp-domain-name

GET bucket

Description: Lists objects and folders in a bucket


Permission: Browse


More information: “Listing bucket contents” on page 97

[delimiter=string] [marker=string] [max-keys=integer] [prefix=string]

Authorization:

AWS access-key:signature


Date: DDD, dd MMM yyyy HH:mm:ss

(+0000|GMT)

OR

x-amz-date: DDD, dd MMM yyyy HH:mm:ss

(+0000|GMT)


Host: hostname.hcp-domain-name


[x-hcp-pretty-print: (true|false)]


198 Appendix A: Quick reference


Description and permission

Query parameters

Request headers

GET bucket acl

Description: Retrieves the ACL for a bucket


Permission: Read ACL


More information: “Retrieving the ACL for a bucket” on

page 85

acl

Authorization:

AWS access-key:signature


Date: DDD, dd MMM yyyy HH:mm:ss

(+0000|GMT)

OR

x-amz-date: DDD, dd MMM yyyy HH:mm:ss

(+0000|GMT)


Host: hostname.hcp-domain-name


[x-hcp-pretty-print: (true|false)]

GET bucket versioning

Description: Checks the versioning status of a bucket


Permission: None; requester must be the bucket owner


More information: “Checking the versioning status of a bucket” on page 93

versioning

Authorization:

AWS access-key:signature


Date: DDD, dd MMM yyyy HH:mm:ss

(+0000|GMT)

OR

x-amz-date: DDD, dd MMM yyyy HH:mm:ss

(+0000|GMT)


Host: hostname.hcp-domain-name


[x-hcp-pretty-print: (true|false)]

GET bucket versions

Description: Lists versions of objects in a bucket


Permission: Browse


More information: “Listing bucket contents” on page 97

versions [delimiter=string] [key-marker=string] [max-keys=integer] [prefix=string]

[version-id-marker=

integer]

Authorization:

AWS access-key:signature


Date: DDD, dd MMM yyyy HH:mm:ss

(+0000|GMT)

OR

x-amz-date: DDD, dd MMM yyyy HH:mm:ss

(+0000|GMT)


Host: hostname.hcp-domain-name


[x-hcp-pretty-print: (true|false)]


Appendix A: Quick reference 199


Description and permission

Query parameters

Request headers

HEAD bucket

Description: Checks the existence of a bucket


Permission: Read


More information: “Checking the existence of a bucket” on page 76

N/A

Authorization:

AWS access-key:signature


Date: DDD, dd MMM yyyy HH:mm:ss

(+0000|GMT)

OR

x-amz-date: DDD, dd MMM yyyy HH:mm:ss

(+0000|GMT)


Host: hostname.hcp-domain-name

PUT bucket

Description: Creates a bucket and optionally adds an ACL to it


Permission: None; requester must be an authenticated user


More information: “Creating a bucket” on page 66

N/A

Authorization:

AWS access-key:signature


Content-Length: 0


Date: DDD, dd MMM yyyy HH:mm:ss

(+0000|GMT)

OR

x-amz-date: DDD, dd MMM yyyy HH:mm:ss

(+0000|GMT)


Host: hostname.hcp-domain-name

[x-amz-acl: canned-acl-name] [x-amz-grant-full-control:

identifier-type=grantee-identifier

[, identifier-type=grantee-identifier]...]


[x-amz-grant-read:

identifier-type=grantee-identifier

[, identifier-type=grantee-identifier]...]


[x-amz-grant-read-acp:

identifier-type=grantee-identifier

[, identifier-type=grantee-identifier]...]


[x-amz-grant-write:

identifier-type=grantee-identifier

[, identifier-type=grantee-identifier]...]


[x-amz-grant-write-acp:

identifier-type=grantee-identifier

[, identifier-type=grantee-identifier]...]


200 Appendix A: Quick reference


Description and permission

Query parameters

Request headers

PUT bucket acl

Description: Adds an ACL to a bucket; removes an ACL from a bucket; changes the bucket owner


Permission: To add or remove an ACL, write ACL; to change the bucket owner, write ACl and change owner


More information: “Adding an ACL to a bucket” on page 79

acl

Authorization:

AWS access-key:signature


Date: DDD, dd MMM yyyy HH:mm:ss

(+0000|GMT)

OR

x-amz-date: DDD, dd MMM yyyy HH:mm:ss

(+0000|GMT)


Host: hostname.hcp-domain-name


[Content-Length:

acl-request-body-size-in-bytes] (Required with an ACL request body)

[Content-Type: application/xml] [x-amz-acl: canned-acl-name] [x-amz-grant-full-control:

identifier-type=grantee-identifier

[, identifier-type=grantee-identifier]...]


[x-amz-grant-read:

identifier-type=grantee-identifier

[, identifier-type=grantee-identifier]...]


[x-amz-grant-read-acp:

identifier-type=grantee-identifier

[, identifier-type=grantee-identifier]...]


[x-amz-grant-write:

identifier-type=grantee-identifier

[, identifier-type=grantee-identifier]...]


[x-amz-grant-write-acp:

identifier-type=grantee-identifier

[, identifier-type=grantee-identifier]...]


Appendix A: Quick reference 201


Description and permission

Query parameters

Request headers

PUT bucket versioning

Description: Enables or disables versioning for a bucket


Permission: None; requester must be the bucket owner


More information: “Enabling or disabling versioning for a bucket” on page 89

versioning

Authorization:

AWS access-key:signature


Content-Length:

versioning-request-body-size-in-bytes


Date: DDD, dd MMM yyyy HH:mm:ss

(+0000|GMT)

OR

x-amz-date: DDD, dd MMM yyyy HH:mm:ss

(+0000|GMT)


Host: hostname.hcp-domain-name


[Content-Type: application/xml]

Object-level operations

DELETE object

Description: Deletes an object or folder


Permission: Delete


More information: “Deleting an object or folder” on page 185

N/A

Authorization:

AWS access-key:signature


Date: DDD, dd MMM yyyy HH:mm:ss

(+0000|GMT)

OR

x-amz-date: DDD, dd MMM yyyy HH:mm:ss

(+0000|GMT)


Host: hostname.hcp-domain-name


202 Appendix A: Quick reference


Description and permission

Query parameters

Request headers

GET object

Description: Retrieves an object or object version


Permission: Read


More information: “Retrieving an object” on page 173

[versionId=

version-id]

Authorization:

AWS access-key:signature


Date: DDD, dd MMM yyyy HH:mm:ss

(+0000|GMT)

OR

x-amz-date: DDD, dd MMM yyyy HH:mm:ss

(+0000|GMT)


Host: hostname.hcp-domain-name


[If-Match: "value"[, "value"]...]


[If-Modified-Since: datetime-value]

(For formats for datetime-value, see the description of If-Modified-Since on

page 178)

[If-None-Match: "value"[, "value"]...] [If-Unmodified-Since: datetime-value] [response-cache-control:

cache-control-header-value]


[response-content-disposition:

content-disposition-header-value]


[response-content-encoding:

content-encoding-header-value]


[response-content-language:

content-language-header-value]


[response-content-type:

content-type-header-value]


[response-expires: expires-header-value]


Appendix A: Quick reference 203


Description and permission

Query parameters

Request headers

GET object acl

Description: Retrieves the ACL for an object


Permission: Read ACL


More information: “Retrieving the ACL for an object” on

page 154

acl

Authorization:

AWS access-key:signature


Date: DDD, dd MMM yyyy HH:mm:ss

(+0000|GMT)

OR

x-amz-date: DDD, dd MMM yyyy HH:mm:ss

(+0000|GMT)


Host: hostname.hcp-domain-name


[x-hcp-pretty-print: (true|false)]

HEAD object

Description: Checks the existence of an object, object version, or folder


Permission: Read


More information: “Checking the existence of an object or folder” on page 137

[versionId=

version-id]

Authorization:

AWS access-key:signature


Date: DDD, dd MMM yyyy HH:mm:ss

(+0000|GMT)

OR

x-amz-date: DDD, dd MMM yyyy HH:mm:ss

(+0000|GMT)


Host: hostname.hcp-domain-name


[If-Match: "value"[, "value"]...]


[If-Modified-Since: datetime-value]

(For formats for datetime-value, see the description of If-Modified-Since on

page 140)

[If-None-Match: "value"[, "value"]...] [If-Unmodified-Since: datetime-value]


204 Appendix A: Quick reference


Description and permission

Query parameters

Request headers

PUT object

Description: Stores an object or new version of an object


Permission: Write


More information: “Storing an object” on page 126

N/A

Authorization:

AWS access-key:signature


Content-Length: data-size-in-bytes


Date: DDD, dd MMM yyyy HH:mm:ss

(+0000|GMT)

OR

x-amz-date: DDD, dd MMM yyyy HH:mm:ss

(+0000|GMT)


Host: hostname.hcp-domain-name


[Content-MD5:

base64-encoded-md5-hash-of-data] [Content-Type: internet-media-type] [Expect: 100-continue]

[x-amz-acl: canned-acl-name]


[x-amz-grant-full-control:

identifier-type=grantee-identifier

[, identifier-type=grantee-identifier]...]


[x-amz-grant-read:

identifier-type=grantee-identifier

[, identifier-type=grantee-identifier]...]


[x-amz-grant-read-acp:

identifier-type=grantee-identifier

[, identifier-type=grantee-identifier]...]


[x-amz-grant-write:

identifier-type=grantee-identifier

[, identifier-type=grantee-identifier]...]


[x-amz-grant-write-acp:

identifier-type=grantee-identifier

[, identifier-type=grantee-identifier]...] [x-amz-meta-property-name: value]

[x-amz-server-side-encryption: encryption-algorithm-name-and-key- length]


Appendix A: Quick reference 205


Description and permission

Query parameters

Request headers

PUT object acl

Description: Adds an ACL to an object; removes an ACL from an object; changes the object owner


Permission: To add or remove an ACL, write ACL; to change the object owner, write ACl and change owner


More information: “Adding an ACL to an object” on page 147

acl

Authorization:

AWS access-key:signature


Date: DDD, dd MMM yyyy HH:mm:ss

(+0000|GMT)

OR

x-amz-date: DDD, dd MMM yyyy HH:mm:ss

(+0000|GMT)


Host: hostname.hcp-domain-name


[Content-Length:

acl-request-body-size-in-bytes] (Required with an ACL request body)

[Content-Type: application/xml] [x-amz-acl: canned-acl-name] [x-amz-grant-full-control:

identifier-type=grantee-identifier

[, identifier-type=grantee-identifier]...]


[x-amz-grant-read:

identifier-type=grantee-identifier

[, identifier-type=grantee-identifier]...]


[x-amz-grant-read-acp:

identifier-type=grantee-identifier

[, identifier-type=grantee-identifier]...]


[x-amz-grant-write:

identifier-type=grantee-identifier

[, identifier-type=grantee-identifier]...]


[x-amz-grant-write-acp:

identifier-type=grantee-identifier

[, identifier-type=grantee-identifier]...]


206 Appendix A: Quick reference


Description and permission

Query parameters

Request headers

PUT object copy

Description: Copies an object; replaces custom metadata for an object


Permission: Read for the source object; write for the target bucket


More information: “Copying an object” on page 158

N/A

Authorization:

AWS access-key:signature


Date: DDD, dd MMM yyyy HH:mm:ss

(+0000|GMT)

OR

x-amz-date: DDD, dd MMM yyyy HH:mm:ss

(+0000|GMT)


Host: hostname.hcp-domain-name


x-amz-copy-source:

/bucket-name/source-object-name [?versionId=source-object-version-id]

[x-amz-acl: canned-acl-name] [x-amz-copy-source-if-match:

"value"[, "value"]...]


[x-amz-copy-source-if-modified-since:

datetime-value]

(For formats for datetime-value, see the description of

x-amz-copy-source-if-modified-since on page 163)


[x-amz-copy-source-if-none-match: "value"[, "value"]...]


[x-amz-copy-source-if-unmodified-since:

datetime-value]


[x-amz-server-side-encryption: encryption-algorithm-name-and-key- length]


[x-amz-grant-full-control:

identifier-type=grantee-identifier

[, identifier-type=grantee-identifier]...]


[x-amz-grant-read:

identifier-type=grantee-identifier

[, identifier-type=grantee-identifier]...]


[x-amz-grant-read-acp:

identifier-type=grantee-identifier

[, identifier-type=grantee-identifier]...]


Appendix A: Quick reference 207


Description and permission

Query parameters

Request headers

PUT object copy (continued)

[x-amz-grant-write:

identifier-type=grantee-identifier

[, identifier-type=grantee-identifier]...]


[x-amz-grant-write-acp:

identifier-type=grantee-identifier

[, identifier-type=grantee-identifier]...] [x-amz-meta-property-name: value]

[x-amz-metadata-directive: (COPY|REPLACE)]


208 Appendix A: Quick reference

image