Transfers

Web Services - Standard thin clients

Obtaining CURL

Environment

Input/output

Transfers

In order to list all your ECtrans Transfers in the ECtrans Spool:

> curl -k -X GET -H "Token: ahs4w294" $ECACCESS_URL/transfers

returns

{
  "transfers" : [ ],
  "success" : "yes"
}

To get the details for a specific ECtrans Transfer (e.g. 32595048) just add the Transfer Identifier in the URL:

> curl -k -X GET -H "Token: ahs4w294" $ECACCESS_URL/transfers/32595048

returns

{
  "transfer" : {
    "hostName" : "ecaccess.ecmwf.int",
    "comment" : "",
    "sourceFileName" : "/home/group/uid/ecmwf.properties",
    "status" : "STOP",
    "keepInSpool" : true,
    "fileSize" : 5205,
    "tryCount" : 145,
    "tryDone" : 1,
    "scheduledDate" : "Sep 30 14:26",
    "targetFileName" : "ecmwf.properties",
    "ownerUserId" : "test",
    "lastErrorMessage" : "user not granted by uid for test",
    "transferId" : "32595048"
  },
  "success" : "yes"
}

In order to request a new ECtrans transfer:

> curl -k -X POST -H "Token: ahs4w294" -H "Content-Type: application/json" \
 -d '{ \ 
   "remoteLocation":"test", \
   "sourceFileName":"ecmwf.properties", \
   "gatewayName":"ecaccess.ecmwf.int", \
   "keepInSpool":true}' \ 
$ECACCESS_URL/transfers

returns

{
  "transferId" : "32595048",
  "success" : "yes"
}

All parameters for the ECtrans Request are listed in table 15.

Table 15: Parameters for the ECtrans Request. For additional information please see the ecaccess-ectrans-request manpage.

Type	Name	Comment
String	gatewayName	default current Gateway
String	remoteLocation	in the format association-name[@protocol]
String	sourceFileName
String	targetFileName
Integer	retryCount
Integer	retryFrequency	frequency of retries in seconds (default: 600 seconds)
String	maximumDuration	e.g. 10m or 1h, <0 to deactivate (default 12h)
String	minimumDuration	e.g. 30s or 10m, <0 to deactivate (default 10m)
Long	minimumRate	bytes/s (default 10240)
Integer	priority
String	lifeTime	in [w]eeks, [d]ays, [h]ours, [m]inutes or [s]econds (e.g. 1w or 2d)
Boolean	deleteSource	default FALSE
Boolean	keepInSpool	default FALSE
String	userMailAddress
Boolean	sendMailOnSuccess
Boolean	sendMailOnFailure
Boolean	sendMailOnRetry
String	ifTargetFileExists	'reject', 'append', 'resume' or 'overwrite'

To restart an ECtrans Transfer:

> curl -k -X PUT -H "Token: ahs4w294" -H "Content-Type: application/json" \
 -d '{ \ 
   "remoteLocation":"test2", \
   "sourceFileName":"ecmwf.properties", \
   "gatewayName":"ecaccess.ecmwf.int", \
   "keepInSpool":true}' \
 $ECACCESS_URL/transfers/32595048

returns

{
  "success" : "yes"
}

For a list of parameters for the restart of an ECtrans Request see table 15.

To delete an ECtrans Transfer:

> curl -k -X DELETE -H "Token: ahs4w294" $ECACCESS_URL/transfers/32595048

returns

{
  "success" : "yes"
}

28-02-2012

advisory@ecmwf.int