Gpfs/trace/stop: PUT

Stops the GPFS tracing.

Availability

Available on all IBM Storage Scale editions.

Description

The PUT scalemgmt/v2/gpfs/trace/stop request stops the GPFS tracing. For more information about the fields in the data structures that are returned, see mmtracectl command.

Request URL

https://<IP address or host name of API server>:<port>/scalemgmt/v2/gpfs/trace/stop
where
trace/stop
Specifies the resource for the PUT call.

Request headers

Content-Type: application/json
Accept: application/json

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",
         "status":"Job status",
         }
   ],
  }
For more information about the fields in the following data structures, see the links at the end of the topic.
"jobs":
An array of elements that describe jobs. Each element describes one job.
"status":
Return status.
"message": "ReturnMessage",
The return message.
"code": ReturnCode
The return code.
"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 and 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 example how to stop GPFS tracing. 

curl -k -u admin:admin001 -X PUT --header 'content-type:application/json' --header 'accept:application/json' 
'https://198.51.100.1:443/scalemgmt/v2/gpfs/trace/stop'
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. 

    "jobs": [
        {
            "jobId": 1000000000001,
            "status": "RUNNING",
            "submitted": "2021-10-27 06:30:42,763",
            "completed": "N/A",           
            "runtime": 18,
],
    "status": {
        "code": 202,
        "message": "The request was accepted for processing."
    }
}