Retrieving annotations for objects and versions request contents

The GET request to retrieve an annotation for an object or version includes these elements:

If you’re accessing the namespace as an authenticated user, an Authorization header.

The URL of the object.

A type=custom-metadata query parameter.

An annotation=annotation-name query parameter, where annotation-name is the name of the specific annotation you are retrieving. If you’re retrieving the default annotation, you can omit this query parameter.

Choosing not to wait for delayed retrievals

HCP may detect that a GET request will take a significant amount of time to return the annotation. You can choose to have the request fail in this situation instead of waiting for HCP to return the annotation. To do this, in addition to specifying the request elements listed above, use the nowait URL query parameter.

When a GET request fails because the request would take a significant amount of time to return the annotation and the nowait parameter is specified, HCP returns an HTTP 503 (Service Unavailable) error code.

Tip: If the request specifies nowait and HCP returns a error code, retry the request a few times, waiting about thirty seconds in between retries.

Retrieving an annotation for a specific version

If an object has multiple versions, specify this optional URL query parameter to retrieve an annotation for a specific version of the object:

version=version-id

If you omit the version parameter, HCP retrieves the annotation for the current version of the object.

Retrieving an annotation in compressed format

To request that HCP return the annotation in gzip-compressed format, use an Accept-Encoding header containing the value gzip or *. The header can specify additional compression algorithms, but HCP uses only gzip.

Trademark and LegalDisclaimer

© 2016 Hitachi Data Systems Corporation. All rights reserved.