ListParts
Last update：2022-03-01 18:01:11
- You can list parts of a multipartupload task by calling this interface.
- At most 1000 parts can be listed in a response and you can set this number with parameter
max-parts(default at 1000). If there are over 1000 parts of a multipartupload task,IsTruncatedandNextPartNumberMarkerwill be returned in response(IsTruncatedis True this way). And you can get the following parts by setting parameterpart-number-markerat the value ofNextPartNumberMarkerin next ListParts request.
Request syntax
GET /ObjectName?uploadId=uploadid&max-parts=max&part-number-marker=marker HTTP/1
Host: Bucket.Endpoint
Date: date
Authorization: authorization
URI request parameters
| Name | Description | Required |
|---|---|---|
| uploadId | The upload ID which identify the upload task. | Yes |
| max-parts | The maximum number of parts you can list in one request. Type: String Default value: 1000 | No |
| part-number-marker | Specifies the start position of the List. Only Parts with a Part Number greater than this parameter will be listed. Type: String | No |
Request header
Please use Common request headers .
Request body
None
Response syntax
HTTP/1.1 status_code
x-wos-request-id: request id
Date: date
Content-Length: length
Connection: state
Server:WS-web-server
<?xml version="1.0" encoding="UTF-8" standalone="yes"?
<ListPartsResult xmlns=" https://www.wangsu.com/document">
<Bucket>BucketName</Bucket>
<Key>object</Key>
<UploadId>uploadid</UploadId>
<Initiator>
<ID>initiatorid</ID>
<DisplayName>displayname</DisplayName>
</Initiator>
<Owner>
<ID>ownerid</ID>
<DisplayName>ownername</DisplayName>
</Owner>
<PartNumberMarker>partNmebermarker</PartNumberMarker>
<NextPartNumberMarker>nextpartnumbermarker</NextPartNumberMarker>
<MaxParts>2</MaxParts>
<IsTruncated>true</IsTruncated>
<Part>
<PartNumber>partnumber1</PartNumber>
<LastModified>modifieddate</LastModified>
<ETag>etag</ETag>
<Size>size</Size>
</Part>
<Part>
<PartNumber>partnumber2</PartNumber>
<LastModified>modifieddate</LastModified>
<ETag>etag</ETag>
<Size>size</Size>
</Part>
...
</ListPartsResult>
Response header
Please use Common response headers .
Response body
| Name | Description |
|---|---|
| ListPartsResult | Type: XML namespace Child nodes: Bucket, Key, UploadId, PartNumberMarker, NextPartNumberMarker, MaxParts, IsTruncated, Part. Parent node: None |
| Bucket | Bucket Name. Type: String Parent node: ListPartsResult |
| Key | Object Name. Type: String Parent node: ListPartsResult |
| UploadId | Type: string Parent node: ListPartsResult |
| Initiator | Creator of the Upload task. Type: XML namespace Child nodes: ID, DisplayName Parent node: ListPartsResult |
| ID | Creator’s DomainID. Type: String Parent nodes: Initiator, Owner |
| DisplayName | Creator’s name. Type: String Parent nodes: Initiator , Owner |
| PartNumberMarker | Start position of the list for this request. Type: Integer Parent node: ListPartsResult |
| NextPartNumberMarker | If not all results are returned in this request, NextPartNumberMarker is in the response, which indicating the start position of the list in next request. Type: Integer Parent Node: ListPartsResult |
| MaxParts | Biggest number of parts listed in one request. The range is [ 1,1000]. Type: Integer Parent Node: ListPartsResult |
| IsTruncated | IsTruncated indicates whether the list of parts is truncated or not. “true” means that not all parts are listed in this request. Type: Boolean Parent Node: ListPartsResult |
| Part | Type: XML namespace Child nodes: PartNumber, LastModified, ETag, Size. Parent node: ListPartsResult |
| PartNumber | The number of an uploaded part. Type: Integer Parent node: ListPartsResult |
| LastModified | Time when the part is uploaded. Type: Date Parent node: ListPartsResult |
| ETag | The ETag of an uploaded part . Type: String. Parent node: ListPartsResult |
| Size | Size of an uploaded part. Type: Integer. Parent node: ListPartsResult |
Special error
| Http Status | Error Code | Message |
|---|---|---|
| 404 Not Found | NoSuchUpload | The specified upload does not exist. The upload ID may be invalid, or the upload may have been aborted or completed. |
| 404 Not Found | NoSuchUpload | The specified upload does not exist. The upload ID may be invalid, or the upload may have been aborted or completed. |
| 400 Bad Request | InvalidArgument | Argument maxParts must be an integer between 0 and 1000 |
| 400 Bad Request | InvalidArgument | Provided maxParts not an integer or within integer range. |
| 400 Bad Request | InvalidArgument | Provided part-number-marker not an integer |
Example
GET /example-object?uploadId=XXBsb2FkIElEIGZvciBlbHZpbmcncyVcdS1tb3ZpZS5tMnRzEEEwbG9hZA&max-parts=2&part-number-marker=1 HTTP/1.1
Host: bucket.s3-cn-east-1.wcsapi.com
Date: Mon, 1 Nov 2010 20:34:56 GMT
Authorization: WOS AKIAIOSFODNN7EXAMPLE:0RQf4/cRonhpaBX5sCYVf1bNRuU=
HTTP/1.1 200 OK
x-wos-request-id: 656c76696e6727732072657175657374
Date: Mon, 1 Nov 2010 20:34:56 GMT
Content-Length: 985
Connection: keep-alive
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ListPartsResult xmlns=" https://www.wangsu.com/document">
<Bucket>example-bucket</Bucket>
<Key>example-object</Key>
<UploadId>XXBsb2FkIElEIGZvciBlbHZpbmcncyVcdS1tb3ZpZS5tMnRzEEEwbG9hZA</UploadId>
<Initiator>
<ID> 11116a31-17b5-4fb7-9df5-b288870f11xx</ID>
<DisplayName>umat-user-11116a31-17b5-4fb7-9df5-b288870f11xx</DisplayName>
</Initiator>
<PartNumberMarker>1</PartNumberMarker>
<NextPartNumberMarker>3</NextPartNumberMarker>
<MaxParts>2</MaxParts>
<IsTruncated>true</IsTruncated>
<Part>
<PartNumber>1</PartNumber>
<LastModified>2020-11-10T20:48:000Z</LastModified>
<ETag>"5678aef83f66abc1fa1e8477fsfsda6d394"</ETag>
<Size>10485760</Size>
</Part>
<Part>
<PartNumber>2</PartNumber>
<LastModified>2020-11-10T20:49:000Z</LastModified>
<ETag>"7778aef83f66abc1fa1e8477f296d394"</ETag>
<Size>10485760</Size>
</Part>
<Part>
<PartNumber>3</PartNumber>
<LastModified>2020-11-10T20:50:000Z</LastModified>
<ETag>"aaaa18db4cc2f85cedef654fccc4a4x8"</ETag>
<Size>10485760</Size>
</Part>
</ListPartsResult>
Is the content of this document helpful to you?
Yes
I have suggestion