List Transfers¶

List transfers

URI Template

GET /api/filetransfer/{instance}/{serviceName}/transfers

{instance}: Yamcs instance name
{serviceName}: File transfer service name

Query Parameters

start: Filter the lower bound of the transfer's creation time. Specify a date string in ISO 8601 format. This bound is inclusive.
stop: Filter the upper bound of the transfer's creation time. Specify a date string in ISO 8601 format. This bound is exclusive.
localEntityId: Filter by local entity identifier
remoteEntityId: Filter by remote entity identifier
state: Filter by transfer state. Leave empty to return any.
direction: Filter by transfer direction (UPLOAD or DOWNLOAD)
limit: The maximum number of returned records per page. Choose this value too high and you risk hitting the maximum response size limit enforced by the server. Default: 100
order: The order of the returned results. Can be either asc or desc. Default: desc

Response Type

interface ListTransfersResponse {
  transfers: TransferInfo[];
}

Related Types

interface TransferInfo {

  //unique identifier assigned by the file transfer service
  id: string;  // String decimal

  //when the transfer has started. Note that this will not be set for QUEUED transfers.
  startTime: string;  // RFC 3339 timestamp
  state: TransferState;
  bucket: string;
  objectName: string;
  remotePath: string;
  direction: TransferDirection;
  totalSize: string;  // String decimal
  sizeTransferred: string;  // String decimal

  //reliable = true -> class 2 transfer
  //reliable = false -> class 1 transfer
  reliable: boolean;

  //in case the transcation is failed, this provides more information
  failureReason: string;

  // valid for CFDP: transaction id;
  // for the incoming transfers it is assigned by the remote peer so therefore might not be unique
  transactionId: TransactionId;

  // when the transfer has been created.
  creationTime: string;  // RFC 3339 timestamp

  // depending on the implementation, can mean normal file transfer, directory listing request, file download request, etc.
  transferType: string;

  // Local entity, may be empty if there is only one such entity.
  localEntity: EntityInfo;

  // Remote entity, may be empty if there is only one such entity.
  remoteEntity: EntityInfo;
}

interface TransactionId {
  sequenceNumber: number;
  initiatorEntity: string;  // String decimal
}

interface EntityInfo {
  name: string;
  id: string;  // String decimal
}

enum TransferState {
  RUNNING = "RUNNING",
  PAUSED = "PAUSED",
  FAILED = "FAILED",
  COMPLETED = "COMPLETED",
  QUEUED = "QUEUED",
  CANCELLING = "CANCELLING",
}

enum TransferDirection {
  UPLOAD = "UPLOAD",
  DOWNLOAD = "DOWNLOAD",
}

enum TransferState {
  RUNNING = "RUNNING",
  PAUSED = "PAUSED",
  FAILED = "FAILED",
  COMPLETED = "COMPLETED",
  QUEUED = "QUEUED",
  CANCELLING = "CANCELLING",
}

enum TransferDirection {
  UPLOAD = "UPLOAD",
  DOWNLOAD = "DOWNLOAD",
}