Filesystems/{filesystemPath}/loopbackDevice/{fileName}/nodes/name}: GET

Gets the list of loopback files that are associated with the specified node.

Availability

Available on all IBM Storage Scale editions.

Description

The GET /scalemgmt/v2/filesystems/{filesystemPath}/loopbackDevice/{fileName}/nodes/{name} request gets the list of loopback files that are associated with the specified node.

Request URL

https://<IP address or host name of API server>:<port>/scalemgmt/v2/filesystems/{fileSystemPath}/loopbackDevice/{fileName}/nodes/{name}

where

loopbackDevice: Specifies the resource for GET call. Required.

Request parameters

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

Table 1. List of request parameters
Parameter name	Description and applicable keywords	Required/optional
filesystemPath	The location of the file system.	Required.
fileName	The name of the loopback file that is detached to the node.	Required.
name	The name of the node from which the loopback file is detached.	Required.

Note: Path traversal is restricted in the parameters. Invalid values for fileName, nodeName, or filesystemPath results in errors.

Request headers

Accept: application/json

Request data

No request data.

Response data

{
 "jobs" : [ {
    "jobId" : Job ID,
    "status" : Job status,
    "submitted" : Date and time,
    "completed" : Date and time,
    "runtime" : Time,
    "request" : {
      "type" : Request type,
      "url" : Request URL
    },
    "result" : {
      "progress" : [ ],
      "commands" : [ ],
      "stdout" : Request data,
      "stderr" : [ ],
      "exitCode" : 0
    },
    "pids" : [ ]
  } ],
  "status" : {
    "code" : Status code,
    "message" : Request message 
}
}

"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 and nonzero denotes failure.
"stderr":"Error": CLI messages from stderr.
"stdout":"String": CLI messages from stdout.

"request"

"type":"{GET | PUT | PUT | DELETE}": HTTP request type.
"url":"URL": The URL through which the job is submitted.

"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.
"runtime":Time": The duration for which the job ran.
"status":"RUNNING | COMPLETED | FAILED": Status of the job.

Examples

The following example gets information about the loopback file.

Request data:

curl -k -u admin:admin001 -X GET --header 'accept:application/json'
'https://198.51.100.1:443/filesystems/gpfs/fs1/loopbackDevice/t1/nodes/scale-41.openstacklocal’'

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" : "COMPLETED",
    "submitted" : "2021-10-26 05:54:30,226",
    "completed" : "2021-10-26 05:54:31,398",
    "runtime" : 1172,
    "request" : {
      "type" : "GET",
      "url" : "/scalemgmt/v2/filesystems/%2Fgpfs%2Ffs1/loopbackDevice/t1/nodes/scale-41.openstacklocal"
    },
    "result" : {
      "progress" : [ ],
      "commands" : [ ],
      "stdout" : [ "info: /dev/loop0: [0050]:66048 (/gpfs/fs1/t1)\n" ],
      "stderr" : [ ],
      "exitCode" : 0
    },
    "pids" : [ ]
  } ],
  "status" : {
    "code" : 200,
    "message" : "The request finished successfully."
  }
}