HCP Tenant Management Help
The table below describes the XML elements in the response body that is returned in response to a request to list the contents of a bucket. The elements are listed in alphabetical order.
Element | Description |
---|---|
CommonPrefixes |
Child of the ListBucketResult element and container for the Prefix element. The response body contains one CommonPrefixes element for each common prefix in the bucket listing. |
Contents |
Child of the ListBucketResult element and container for the elements that describe a current item in the bucket. The response body contains one Contents element for each item that satisfies the request criteria. |
ContinuationToken |
Child of the ListBucketResult element. If sent with the request, the ContinuationToken element specifies the continuation token for listing the next set of objects. |
Delimiter |
Child of the ListBucketResult element. The Delimiter element specifies the value of the delimiter query parameter included in the request. If the request did not include the delimiter query parameter, the response body does not include the Delimiter element. |
DisplayName |
Child of the Owner element. If the item owner is identified by an HCP user account, the value of the DisplayName element is the username for that account. If the item owner is identified by an AD user account, the value of the DisplayName element is the username of that account followed by an at sign (@) and the AD domain name. If the item has no owner, the value of the DisplayName element is nobody. For folders, the value of the DisplayName element is always nobody. |
Encoding-Type |
Child of the ListBucketResult element. The Encoding-Type element specifies the type of encoding used by the S3 compatible API to encode the key names of objects. |
ETag |
Child of the Contents element. The ETag element specifies the ETag of the applicable item. The response body includes ETag elements for the listed folders. However, because they have no content, all folders have the same value for this element. For information about ETags, see Storing an object. |
ID |
Child of the Owner element. If the item owner is identified by an HCP user account, the value of the ID element is the user ID for that account. If the item owner is identified by an AD user account, the value of the ID element is the SID for that account. If the item has no owner, the value of the ID element is nobody. For folders, the value of the ID element is always nobody. |
IsTruncated |
Child of the ListBucketResult element. The IsTruncated element indicates whether the returned bucket listing includes the last item that satisfies the request criteria. Possible values are: •true — The returned listing includes the last item that satisfies the request criteria. •false — The returned listing does not include the last item that satisfies the request criteria. |
Key |
Child of the Contents element. The Key element specifies the name of an item in the bucket listing. |
KeyCount |
Child of the ListBucketResult element. The KeyCount element specifies the number of keys in the response. The value of the KeyCount element is always less than or equal to the value of the MaxKeys element. |
LastModified |
Child of the Contents element. The LastModified element specifies the date and time when the applicable item was last modified, in Greenwich Mean Time (GMT). The date and time are expressed in this format: yyyy-MM-ddTHH:mm:ss.SSSZ For example: 2019-02-18T19:46:03.856Z Modifying an object means modifying its metadata. You cannot modify the content of an object. |
ListBucketResult | Root element for a listing of current items. |
MaxKeys |
Child of the ListBucketResult element. The MaxKeys element specifies the value of the max-keys query parameter included in the request. If the request did not include the max-keys query parameter, the value of the MaxKeys element is 1000. |
Name |
Child of the ListBucketResult element. The Name element specifies the name of the applicable bucket. |
NextContinuationToken |
Child of the ListBucketResult element. If the response is truncated, the NextContinuationToken element is included in the response. The value of this element can be used in your next request as the continuation token to list the next set of objects. |
Owner |
Child of the Contents element and container for the DisplayName and ID elements. The Owner element identifies the owner of the applicable item. |
Prefix |
One of these: •Child of the ListBucketResult element. In this case, the Prefix element specifies the value of the prefix query parameter included in the request. If the request did not include the prefix query parameter, the response body includes Prefix as an empty element. •Child of the CommonPrefixes element. In this case, the Prefix element specifies a common prefix. |
Size |
Child of the Contents element. The Size element specifies the size, in bytes, of the content of the item. The response body includes Size elements for the listed folders. However, because folders have no content, the value of this element for a folder is always 0 (zero). |
StartAfter |
Child of the ListBucketResult element. If sent with the request, the StartAfter element includes the specific object key after which the S3 compatible API returns key names. |
StorageClass |
Child of the Contents element. The value of the StorageClass element is always STANDARD. |
Trademarks and Legal Disclaimer
© 2015, 2019 Hitachi Vantara Corporation. All rights reserved.