Gpfs/trace/{snapPath}: DELETE

Deletes the GPFS trace snap file at the specified location.

Availability

Available on all IBM Storage Scale editions.

Description

The DELETE scalemgmt/v2/gpfs/trace/{snapPath} request deletes the specified snap file. 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/{snapPath}

where

trace/{snapPath}: Specifies the snap file to be deleted. Required.

Request headers

Accept: application/json

Parameters

The following parameters can be used in the request URL to customize the request:

Table 1. List of parameters
Parameter name	Description and applicable keywords	Required/optional
snapPath	The snap file path that is provided as an encoded URL.	Required.

Request data

No request data.

Response data

{
   "status" : {
    "code" : The Return Code,
    "message" : "The ReturnMessage."
  }
}

For more information about the fields in the following data structures, see the links at the end of the topic.

"status":

Return status.

"code": "ReturnCode": The return code.
"message": "ReturnMessage",: The return message.

Examples

The following example shows how to delete a snap file.

Request data:

curl -k -u 'username:password' -X DELETE --header 'Accept: application/json' --header 
'Authorization: Basic YWRtaW46YWRtaW4wMDE=' 'https://198.51.100.1:443/scalemgmt/v2/gpfs/trace/%2Ftmp%2Fmmfs%2Ftrcrpt.2021-10-23_15.28.29.11388.gpfsgui-21.gz'

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" : "The request finished successfully."
  }
}