HCP returns the list of in-progress multipart uploads in an XML response body, in this format:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ListMultipartUploadsResult xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
<Bucket>bucket-name</Bucket>
<KeyMarker>key-marker</KeyMarker>
<UploadIdMarker>upload-id-marker</UploadIdMarker>
<NextKeyMarker>object-name-for-last-multipart-upload-in-listing
</NextKeyMarker>
<NextUploadIdMarker>upload-id-of-last-multipart-upload-in-listing
</NextUploadIdMarker>
<Delimiter>delimiter</Delimiter>
<Prefix>prefix</Prefix>
<MaxUploads>maximum-multipart-uploads-to-list</MaxUploads>
<IsTruncated>false</IsTruncated>
Format for a multipart upload:
<Upload>
<Key>object-name</Key>
<UploadId>upload-id</UploadId>
<Initiator>
<ID>initiator-user-id</ID>
<DisplayName>initiator-username</DisplayName>
</Initiator>
<Owner>
<ID>owner-user-id</ID>
<DisplayName>owner-username</DisplayName>
</Owner>
<StorageClass>STANDARD</StorageClass>
<Initiated>date-and-time-initiated</Initiated>
</Upload>
.
.
.
Format for a common prefix:
<CommonPrefixes>
<Prefix>prefix</Prefix>
</CommonPrefixes>
.
.
.
</ListMultipartUploadsResult>
The table below describes the XML elements in the response body returned in response to a request to list the multipart uploads that are in progress in a bucket. The elements are listed in alphabetical order.
Element | Description |
---|---|
Bucket |
Child of the ListMultipartUploadsResult element. The Bucket element specifies the name of the bucket targeted by the request. |
CommonPrefixes |
Child of the ListMultipartUploadsResult and container for the Prefix element. The response body contains one CommonPrefixes element for each common prefix in the multipart upload listing. |
Delimiter |
Child of the ListMultipartUploadsResult 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 Initiator or Owner element. If the initiator or owner is identified by an HCP user account, the value of the DisplayName element is the username for that account. If the initiator or 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. |
ID |
Child of the Initiator or Owner element. If the initiator or owner is identified by an HCP user account, the value of the ID element is the user ID for that account. If the initiator or owner is identified by an AD user account, the value of the ID element is the SID for that account. |
Initiated |
Child of the Upload element. The Initiated element specifies the date and time when the applicable multipart upload was initiated, in Greenwich Mean Time (GMT). The date and time are expressed in this format: yyyy-MM-ddTHH:mm:ss.SSSZ For example: 2020-02-18T19:46:03.856Z |
Initiator |
Child of the Upload element and container for the DisplayName and ID elements. The Initiator element identifies the user who initiated the applicable multipart upload. |
IsTruncated |
Child of the ListMultipartUploadsResult element. The IsTruncated element indicates whether the returned listing includes the last multipart upload that satisfies the request criteria. Possible values are: •true — The returned listing includes the last multipart upload that satisfies the request criteria. •false — The returned listing does not include the last multipart upload that satisfies the request criteria. |
Key |
Child of the Upload element. The Key element specifies the name of the object to be created by the applicable multipart upload. |
KeyMarker |
Child of the ListMultipartUploadsResult 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. |
ListMultipartUploads Result |
Root element. |
MaxUploads |
Child of the ListMultipartUploadsResult element. The MaxUploads element specifies the value of the max-uploads query parameter included in the request. If the request did not include the max-uploads query parameter, the value of the MaxUploads element is 1000. |
NextKeyMarker |
Child of the ListMultipartUploadsResult element. The NextKeyMarker element specifies the object name for the last multipart upload included in the returned 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 multipart uploads that satisfy the request criteria. |
NextUploadIdMarker |
Child of the ListMultipartUploadsResult element. The NextUploadIdMarker element specifies the upload ID of the last multipart upload included in the returned 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 NextUploadIdMarker element as the value of the upload-id-marker query parameter in a new request to retrieve the next set of multipart uploads that satisfy the request criteria. |
Owner |
Child of the Upload element and container for the DisplayName and ID elements. The Owner element identifies the user who will own the object created by the applicable multipart upload. |
Prefix |
One of these: •Child of the ListMultipartUploadsResult. 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. |
StorageClass |
Child of the Upload element. The value of the StorageClass element is always STANDARD. |
Upload |
Child of the ListMultipartUploadsResult and container for the elements that describe a multipart upload. The response body contains one Upload element for each multipart upload in the returned listing. |
UploadId |
Child of the Upload element. The UploadId element specifies the upload ID of the applicable multipart upload. |
UploadIdMarker |
Child of the ListMultipartUploadsResult element. The UploadIdMarker element specifies the value of the upload-id-marker query parameter included in the request. If the request did not include the upload-id-marker query parameter, the response body does not include the KeyMarker element. |
© 2015, 2020 Hitachi Vantara LLC. All rights reserved.