file tierjobstatus

Checks the status of a previous offload or recall operation.

Permissions Required

The user running the command must have (mode bit or Access Control Expression (ACE)) permissions to write to the file.

Syntax

CLI
/opt/mapr/bin/maprcli file tierjobstatus 
            -name <file_name>
            [ -job <jobID> ]
REST
Request Type GET
Request URL 
http[s]://<host:port>/rest/file/tierjobstatus?<parameters>

Parameters

Parameter Description
name The name (including the path) of the file.
job The ID of the job specified with the offload or recall command.

Output

The command returns one of the following messages:
FTOS_SUCCESS
Indicates that the file tiering operation was successful. For example:
/opt/mapr/bin/maprcli file tierjobstatus  -name /v5/nfile2 -json
   {
    "timestamp":1533555093521,
    "timeofday":"2018-08-06 04:31:33.521 GMT-0700 AM",
    "status":"OK",
    "total":1,
    "data":[
            {
               "status":0,
               "message":"File offload completed.",
               "gateway":"10.10.104.21:8660",
               "op":"Offload",
               "completedFids":2,
               "failedFids":0,
               "totalFids":2
             }
            ]
    }
curl -X GET 'https://abc.sj.us/rest/file/tierjobstatus?name=/v5/nfile2' -- user <username>:<password>
 {"timestamp":1533555093521,"timeofday":"2018-08-06 04:31:33.521 GMT-0700 AM","status":"OK","total":1,
 "data":[{"status":0,"message":"File offload completed.","gateway":"10.10.104.21:8660","op":"Offload",
 "completedFids":2,"failedFids":0,"totalFids":2}]}
OP_FAIL
Indicates that the operation failed. For example:
/opt/mapr/bin/maprcli file tierjobstatus -name /volume_cold_aws/sampleFile2 -json
 {
   "timestamp":1533937284242,
   "timeofday":"2018-08-10 02:41:24.242 GMT-0700 PM",
   "status":"ERROR",
   "errors":[
             {
               "id":2,
               "desc":"File offload failed."
             }
            ]
 }
curl -X GET 'https://abc.sj.us:8443/rest/file/tierjobstatus?name=/volume_cold_aws/sampleFile2' --user <username>:<password>
 {"timestamp":1533937284242,"timeofday":"2018-08-10 02:41:24.242 GMT-0700 PM","status":"ERROR",
 "errors":[{"id":2,"desc":"File offload failed."}]}
INVALID_FILE
Indicates that the specified file does not exist. For example:
/opt/mapr/bin/maprcli file tierjobstatus -name /ecvol1/file3_24 -json
  {
    "timestamp":1534188250720,
    "timeofday":"2018-08-13 12:24:10.720 GMT-0700 PM",
    "status":"ERROR",
    "errors":[
              {
               "id":3,
               "desc":"Tierfile transfer failed, Could not open file /ecvol1/file3_24"
              }
             ]
  }
curl -X GET 'https://abc.sj.us:8443/rest/file/tierjobstatus?name=/ecvol1/file3_24' --user <username>:<password>
  {"timestamp":1534188250720,"timeofday":"2018-08-13 12:24:10.720 GMT-0700 PM","status":"ERROR",
  "errors":[{"id":3,"desc":"Tierfile transfer failed, Could not open file /ecvol1/file3_24"}]}
FILE_EMPTY
Indicates that the file contains no data and is empty. For example:
/opt/mapr/bin/maprcli file tierjobstatus -name /vol1/test1 -json
 {
  "timestamp":1534141220360,
  "timeofday":"2018-08-12 11:20:20.360 GMT-0700 PM",
  "status":"ERROR",
  "errors":[
            {
             "id":5,
             "desc":"File empty."
            }
           ]
 }
curl -X GET 'https://server.sj.us:8443/rest/file/tierjobstatus?name=/vol1/test1' --user <username>:<password>
 {"timestamp":1534142083085,"timeofday":"2018-08-12 11:34:43.085 GMT-0700 PM","status":"ERROR",
 "errors":[{"id":5,"desc":"File empty."}]}
NO_GATEWAY
Indicates that there is no MAST Gateway available. For example:
/opt/mapr/bin/maprcli file tierjobstatus -name /ecvol1/file2 -json
 {
  "timestamp":1534185984585,
  "timeofday":"2018-08-13 11:46:24.585 GMT-0700 AM",
  "status":"ERROR",
  "errors":[
             {
               "id":6,
               "desc":"Lost connection to gateway."
             }
           ]
 }
curl -k -X GET 'https://abc.sj.us:8443/rest/file/tierjobstatus?name=/ecvol1/file2' --user mapr:mapr
 {"timestamp":1534185984585,"timeofday":"2018-08-13 11:46:24.585 GMT-0700 AM","status":"ERROR",
  "errors":[{"id":6,"desc":"Lost connection to gateway."}]}
HAS_LOCAL_DATA
Indicates that the data is still on the cluster. For example:
/opt/mapr/bin/maprcli file tierjobstatus -name /vol1/mfs1 -json
  File has local data.
  {
    "timestamp":1534141820011,
    "timeofday":"2018-08-12 11:30:20.011 GMT-0700 PM",
    "status":"OK",
    "total":1,
    "data":[
               {
                 "status":8,
                 "message":"File has local data."
                }
            ]
  }
curl -k -X GET 'https://abc.sj.us:8443/rest/file/tierjobstatus?name=/vol1/mfs1' --user mapr:mapr
 {"timestamp":1534141975490,"timeofday":"2018-08-12 11:32:55.490 GMT-0700 PM","status":"OK",
  "total":1,"data":[{"status":8,"message":"File has local data."}]}
FTOS_ABORTED
Indicates that the file tiering operation was aborted. For example:
/opt/mapr/bin/maprcli file tierjobstatus -name /v3/dataVol/file5 -json
 {
   "timestamp":1533845080525,
   "timeofday":"2018-08-09 01:04:40.525 GMT-0700 PM",
   "status":"OK",
   "total":1,
   "data":[
           {
            "status":9,
            "message":"Transfer aborted.",
            "gateway":"10.10.25.22:8660",
            "op":"Offload",
            "completedFids":9,
            "failedFids":0,
            "totalFids":9
          }
        ]
 }
curl -k -X GET 'https://abc.sj.us:8443/rest/file/tierjobstatus?name=/v3/dataVol/file5' --user mapr:mapr
 {"timestamp":1533845080525,"timeofday":"2018-08-09 01:04:40.525 GMT-0700 PM","status":"OK",
  "total":1,"data":[{"status":9,"message":"Transfer aborted.","gateway":"10.10.25.22:8660",
  "op":"Offload","completedFids":9,"failedFids":0,"totalFids":9}]}
FTOS_ABORT_IN_PROGRESS
Indicates that the file tiering operation is being aborted. For example:
/opt/mapr/bin/maprcli file tierjobstatus -name /v3/dataVol/file5 -json
 {
   "timestamp":1533845004549,
   "timeofday":"2018-08-09 01:03:24.549 GMT-0700 PM",
   "status":"OK",
   "total":1,
   "data":[
            {
              "status":10,
              "message":"File transfer being aborted.",
              "gateway":"10.10.25.22:8660",
              "op":"Offload",
              "completedFids":5,
              "failedFids":0,
              "totalFids":9
           }
         ]
 }
curl -k -X GET 'https://abc.sj.us:8443/rest/file/tierjobstatus?name=/v3/dataVol/file5' --user mapr:mapr
 {"timestamp":1533845004549,"timeofday":"2018-08-09 01:03:24.549 GMT-0700 PM","status":"OK",
  "total":1,"data":[{"status":10,"message":"File transfer being aborted.","gateway":"10.10.25.22:8660",
  "op":"Offload","completedFids":5,"failedFids":0,"totalFids":9}]}
FTOS_TRANSFER_IN_PROGRESS
Indicates that offload or recall of file data is currently in progress. For example:
/opt/mapr/bin/maprcli file tierjobstatus -name /v3/dataVol/file5 -json
 {
   "timestamp":1533844965363,
   "timeofday":"2018-08-09 01:02:45.363 GMT-0700 PM",
   "status":"OK",
   "total":1,
   "data":[
            {
              "status":11,
              "message":"File transfer in progress.",
              "gateway":"10.10.25.22:8660",
              "op":"Offload",
              "completedFids":2,
              "failedFids":0,
              "totalFids":9
            }
          ]
 }
curl -k -X GET 'https://abc.sj.us:8443/rest/file/tierjobstatus?name=/v3/dataVol/file5' --user mapr:mapr
 {"timestamp":1533844965363,"timeofday":"2018-08-09 01:02:45.363 GMT-0700 PM","status":"OK",
  "total":1,"data":[{"status":11,"message":"File transfer in progress.","gateway":"10.10.25.22:8660",
  "op":"Offload","completedFids":2,"failedFids":0,"totalFids":9}]}
FTOS_REQ_QUEUED
Indicates that the file is queued for offload. For example:
/opt/mapr/bin/maprcli file tierjobstatus -name /v5/egFile2 -json
  {
    "timestamp":1534187988469,
    "timeofday":"2018-08-13 12:19:48.469 GMT-0700 PM",
    "status":"OK",
    "total":1,
    "data":[
            {
               "status":12,
               "message":"File transfer request queued.",
               "gateway":"10.10.25.29:8660",
               "op":"Offload",
               "completedFids":0,
               "failedFids":0,
               "totalFids":0
             }
            ]
  }
curl -k -X GET 'https://abc.sj.us:8443/rest/file/tierjobstatus?name=/v5/egFile2' --uesr mapr:mapr
 {"timestamp":1534187988469,"timeofday":"2018-08-13 12:19:48.469 GMT-0700 PM","status":"OK",
  "total":1,"data":[{"status":12,"message":"File transfer request queued.","gateway":"10.10.25.29:8660",
  "op":"Offload","completedFids":0,"failedFids":0,"totalFids":0}]}
FTOS_JOB_NOT_AVAILABLE
Indicates that the job ID associated with the specified file tiering operation is not available or is invalid. For example:
/opt/mapr/bin/maprcli file tierjobstatus -name /v5/nfile2 -json
 {
   "timestamp":1533841993320,
   "timeofday":"2018-08-09 12:13:13.320 GMT-0700 PM",
   "status":"ERROR",
   "errors":[
              {
                "id":13,
                "desc":"File has no active transfer in progress."
              }
            ]
 }
curl -k -X GET 'https://abc.sj.us:8443/rest/file/tierjobstatus?name=/v5/nfile2' --user mapr:mapr
 {"timestamp":1533841993320,"timeofday":"2018-08-09 12:13:13.320 GMT-0700 PM","status":"ERROR",
  "errors":[{"id":13,"desc":"File has no active transfer in progress."}]}
FTOS_EPERM
Indicates that the user cannot perform the tiering operation. For example:
/opt/mapr/bin/maprcli file tierjobstatus -name /ecvol1/file3_1 -json
  {
    "timestamp":1534188598543,
    "timeofday":"2018-08-13 12:29:58.543 GMT-0700 PM",
    "status":"ERROR",
    "errors":[
               {
                 "id":14,
                 "desc":"File transfer request permission denied."
               }
             ]
  }
curl -k -X GET 'https://abc.sj.us:8443/rest/file/tierjobstatus?name=/ecvol1/file3_1' --user mapr:mapr
  {"timestamp":1534188598543,"timeofday":"2018-08-13 12:29:58.543 GMT-0700 PM","status":"ERROR",
   "errors":[{"id":14,"desc":"File transfer request permission denied."}]}