afm/upload/{filename}: DELETE

Deletes an uploaded AFM file.

Availability

Available on all IBM Storage Scale editions.

Description

The afm/upload/{filename}: DELETE request deletes an uploaded AFM file.

Request URL

https://<IP address or host name of API server>:<port>/scalemgmt/v2/afm/upload/{filename}
where
afm/upload/{filename}
Specifies an uploaded AFM file to be deleted. Required.

Request headers

Accept: application/json

Request parameters

Table 1. List of request parameters
Parameter name Description and applicable keywords Required/optional
{filename} An uploaded AFM file to be deleted. Required.
body Body of the request that contains the required parameters to be passed on to the IBM Storage Scale system to perform the requested operation. Required.

Request data

No request data.

Response data

{
    "status": {
      "code":ReturnCode",
      "message":"ReturnMessage"
   },
   jobs: [
      {
         "result":"", 
           { 
             "commands":"String",
             "progress":"String,
             "exitCode":"Exit code",
             "stderr":"Error",
             "stdout":"String",
           },
         "request":" ",
           {
             "type":"{GET | POST | PUT | DELETE}",
             "url":"URL",
             "data":""",
           },
         "jobId":"ID",
         "submitted":"Time",
         "completed":Time",
         "runtime":Time",
         "status":"Job status",
         "pids":"IDs"
        }   
        ]
   }
For more information about the fields in the following data structures, see the links at the end of this topic.
"status":
Return status.
"message": "ReturnMessage",
The return message.
"code": ReturnCode
The return code.
"jobs":
An array of elements that describe jobs. Each element describes one job.
"result"
"commands":"String'
Array of commands that are run in this job.
"progress":"String'
Progress information for the request.
"exitCode":"Exit code"
Exit code of command. Zero is success, nonzero denotes failure.
"stderr":"Error"
CLI messages from stderr.
"stdout":"String"
CLI messages from stdout.
"request"
"type":"{GET | POST | PUT | DELETE}"
HTTP request type.
"url":"URL"
The URL through which the job is submitted.
"data":" "
Optional.
"jobId":"ID",
The unique ID of the job.
"submitted":"Time"
The time at which the job was submitted.
"completed":Time"
The time at which the job was completed.
"status":"RUNNING | COMPLETED | FAILED"
Status of the job.

Examples

The following API command deletes an uploaded AFM file:

Request URL: 
curl -k -u admin:admin001 -X DELETE --header 'accept:application/json' 
'https://198.51.100.1:443/scalemgmt/v2/afm/upload/{filename}'
The request URL with no field or filter parameter returns only the details that uniquely identify the object.
Response data:
Note: In the JSON data that is returned, the return code indicates whether the command is successful. The response code 200 indicates that the command successfully retrieved the information. Error code 400 represents an invalid request and 500 represents internal server error. 
{
  "status": {
    "code": 200,
    "message": "..."
  },
  "jobs": [
    {
      "result": {
        "commands": "[''mmcrfileset gpfs0 restfs1001'', ...]",
        "progress": "[''(2/3) Linking fileset'']",
        "exitCode": 0,
        "stderr": "[''EFSSG0740C There are not enough resources available to create a new independent file set.'',  ...]",
        "stdout": "[''EFSSG4172I The file set {0} must be independent.'', ...]"
      },
      "request": {
        "type": "POST",
        "url": "/scalemgmt/v2/filesystems/gpfs0/filesets",
        "data": "{\"config\":{\"filesetName\":\"restfs1001\",\"owner\":\"root\",\"path\":\"/mnt/gpfs0/rest1001\",\"permissions\":\"555\"}"
      },
      "jobId": 12345,
      "submitted": "2016-11-14 10.35.56",
      "completed": "2016-11-14 10.35.56",
      "runtime": 0,
      "status": "COMPLETED",
      "pids": "20161"
    }
  ]
}