Gpfs/trace/list: GET

Gets the list of GPFS trace snap files that are available in the default trace snap directory.

Availability

Available on all IBM Storage Scale editions.

Description

The GET scalemgmt/v2/gpfs/trace/list request gets the list of GPFS trace snap files that are available in the default trace snap directory. For more information about the fields in the data structures that are returned, see the topic mmtracectl command.

Request URL

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

Request headers

Accept: application/json

Request data

No request data.

Response data

{
    "snaps": [
        {
            "name": "Snap file name",
            "size": size,
            "timestamp": {
                "date": Date and time            }
        }
    ],
    "status": {
        "code": Request code,
        "message": "Request message."
    }
}
For more information about the fields in the following data structures, see the links at the end of the topic.
"status":
Return status.
"message": "ReturnMessage",
The return message.
"code": "ReturnCode"
The return code.
Snap
"name":"File name"
The snap file name.
"size": "File size"
The snap file size.
"Timestamp": "Date and time"
"date": "Date"
The date when the snap files were collected.

Examples

The following example lists the GPFS trace snap files.

Request data: 
curl -k -u admin:admin001 -X GET --header 'accept:application/json'
'https://198.51.100.1:443/scalemgmt/v2/gpfs/trace/list'
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. 
{
    "snaps": [
        {
            "name": "/tmp/mmfs/trcrpt.2021-10-23_15.28.29.11388.gpfsgui-21.gz",
            "size": 190549,
            "timestamp": {
                "date": 1635017311590
            }
        }
    ],
    "status": {
        "code": 200,
        "message": "The request finished successfully."
    }
}