Get Image Store Upload Session By Id

  • Article

Get the image store upload session by ID.

Gets the image store upload session identified by the given ID. User can query the upload session at any time during uploading.

Request

Method Request URI
GET /ImageStore/$/GetUploadSession?api-version=6.0&session-id={session-id}&timeout={timeout}

Parameters

Name Type Required Location
api-version string Yes Query
session-id string (uuid) Yes Query
timeout integer (int64) No Query

api-version

Type: string
Required: Yes
Default: 6.0

The version of the API. This parameter is required and its value must be '6.0'.

Service Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime supports more than one version of the API. This is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification.

Additionally the runtime accept any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0, but if the runtime is 6.1, in order to make it easier to write the clients, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version.

session-id

Type: string (uuid)
Required: Yes

A GUID generated by the user for a file uploading. It identifies an image store upload session which keeps track of all file chunks until it is committed.

timeout

Type: integer (int64)
Required: No
Default: 60
InclusiveMaximum: 4294967295
InclusiveMinimum: 1

The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.

Responses

HTTP Status Code Description Response Schema
200 (OK) A successful operation will return 200 status code and the requested image store upload session information.
 UploadSession
All other status codes The detailed error response.
 FabricError

Examples

Get information about image store upload session by a given ID

This example shows how to get image store upload session by a given ID.

Request

GET http://localhost:19080/ImageStore/$/GetUploadSession?api-version=6.0&session-id=4a2340e8-d8d8-497c-95fe-cdaa1052f33b

200 Response

Body
{
  "UploadSessions": [
    {
      "StoreRelativePath": "SwaggerTest\\Common.dll",
      "SessionId": "4a2340e8-d8d8-497c-95fe-cdaa1052f33b",
      "FileSize": "2097152",
      "ModifiedDate": "2017-09-28T17:06:37.26Z",
      "ExpectedRanges": [
        {
          "StartPosition": "0",
          "EndPosition": "402128"
        },
        {
          "StartPosition": "730105",
          "EndPosition": "2097151"
        }
      ]
    }
  ]
}