The table below describes the XML elements in the two formats of the response body 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 or ListVersionsResult 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. |
DeleteMarker |
Child of the ListVersionsResult element and container for the elements that describe a delete marker. The response body contains one DeleteMarker element for each delete marker that satisfies the request criteria. |
Delimiter |
Child of the ListBucketResult or ListVersionsResult 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. |
ETag |
Child of the Contents or Version element. The ETag element specifies the ETag of the applicable item or item version. 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. |
IsLatest |
Child of the Version or DeleteMarker element. The IsLatest element indicates whether the item version is the current version of the item. Possible values are: •true — The item version is the current version of the item. •false — The item version is an old version of the item. |
IsTruncated |
Child of the ListBucketResult or ListVersionsResult 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, Version, or DeleteMarker element. The Key element specifies the name of an item or item version in the bucket listing. For a delete marker, the value of the Key element is the name of the object or object version that was deleted. |
KeyMarker |
Child of the ListVersionsResult element. The KeyMarker element specifies the value of the key-marker query parameter included in the request. If the request did not include the key-marker query parameter, the response body includes KeyMarker as an empty element. |
LastModified |
Child of the Contents, Version, or DeleteMarker element. The LastModified element specifies the date and time when the applicable item or item version was last modified, in Greenwich Mean Time (GMT). For a delete marker, this is the date and time when the delete marker was created. The date and time are expressed in this format: yyyy-MM-ddTHH:mm:ss.SSSZ For example: 2020-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. |
ListVersionsResult | Root element for a version listing. |
Marker |
Child of the ListBucketResult element. The Marker element specifies the value of the marker query parameter included in the request. If the request did not include the marker query parameter, the response body includes Marker as an empty element. |
MaxKeys |
Child of the ListBucketResult or ListVersionsResult 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 or ListVersionsResult element. The Name element specifies the name of the applicable bucket. |
NextMarker |
Child of the ListBucketResult element. If the returned listing is truncated, you can use the NextMarker element as the value of the marker query parameter in a new request to retrieve the next set of items that satisfy the request criteria. The NextMarker element is returned only if you have specified a delimiter request parameter. |
NextKeyMarker |
Child of the ListVersionsResult element. The NextKeyMarker element specifies the name of the last item included in the returned bucket listing. This element is included in the response body only when the value of the IsTruncated element is true. If the returned listing is truncated, you can use the value of the NextKeyMarker element as the value of the key-marker query parameter in a new request to retrieve the next set of items that satisfy the request criteria. |
NextVersionId Marker |
Child of the ListVersionsResult element. The NextVersionIdMarker element specifies the version ID of the last item included in the returned bucket listing. This element is included in the response body only when the value of the IsTruncated element is true. If the returned listing is truncated, you can use the value of the NextVersionIdMarker element as the value of the version-id-marker query parameter in a new request to retrieve the next set of items that satisfy the request criteria. |
Owner |
Child of the Contents, Version, or DeleteMarker 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 or ListVersionsResult 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 or Version element. The Size element specifies the size, in bytes, of the content of the item or item version. 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). |
StorageClass |
Child of the Contents or Version element. The value of the StorageClass element is always STANDARD. |
Version |
Child of the ListVersionsResult element and container for the elements that describe a version of an item in the bucket. The response body contains one Version element for each item version that satisfies the request criteria. |
VersionId |
Child of the Version or DeleteMarker element. The VersionId element specifies the version ID of an item version. |
VersionIdMarker |
Child of the ListVersionsResult element. The VersionIdMarker element specifies the value of the version-id-marker query parameter included in the request. If the request did not include the version-id-marker query parameter, the response body includes VersionIdMarker as an empty element. |
© 2015, 2020 Hitachi Vantara LLC. All rights reserved.