Info: GET

Gets information about IBM Spectrum Scale™ management API version and supported commands.

Availability

Available on all IBM Spectrum Scale editions.

Description

The GET info request gets information about IBM Spectrum Scale management API. The information includes the version number, the resources that are supported, and the HTTP methods that are supported for each resource.

Request URL

https://<IP address or host name of API server>:<port>/scalemgmt/v2/info

where

info: Is the information resource.

Request headers

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

Request data

No request data.

Response data

{
     "status": {
        "message":"ReturnMessage",
        "code":"ReturnCode"
      }
    "info": 
         {
        "restAPIVersion":"Version",
        "name": "API name",
        "path": "Resource path"
         }   
}

"status":

Return status.

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

"info":

Information about the REST API server.

"restAPIVersion":"Version": The IBM Spectrum Scale management API version.
"name":"APIName": The name of the API, such as "Spectrum Scale REST Management".
"path": "Resource path: Supported resources and elements.

Examples

The following example gets information about the REST API server.

Request URL:

curl -k -u admin:admin001 -X GET --header 'accept:application/json' 
'https://198.51.100.1:443/scalemgmt/v2/info'

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.

{
"info" : {
"name" : "Spectrum Scale REST Management",
"restApiVersion" : "2.1.0",
"serverVersion" : "5.0.0-0_170818.165000",
"paths" : {
"/access" : [ "GET", "POST" ],
"/access/status" : [ "GET" ],
"/ces/addresses" : [ "GET" ],
"/ces/addresses/{cesAddress}" : [ "GET" ],
"/ces/services" : [ "GET" ],
"/ces/services/{service}" : [ "GET" ],
"/cluster" : [ "GET" ],
"/config" : [ "GET" ],
"/filesystems" : [ "GET" ],
"/filesystems/{filesystemName}" : [ "GET" ],
"/filesystems/{filesystemName}/acl/{path}" : [ "GET", "PUT" ],
"/filesystems/{filesystemName}/afm/state" : [ "GET" ],
"/filesystems/{filesystemName}/disks" : [ "GET" ],
"/filesystems/{filesystemName}/disks/{diskName}" : [ "GET" ],
"/filesystems/{filesystemName}/filesets" : [ "GET", "POST" ],
"/filesystems/{filesystemName}/filesets/{filesetName}" : [ "GET", "PUT", "DELETE" ],
"/filesystems/{filesystemName}/filesets/{filesetName}/link" : [ "POST", "DELETE" ],
"/filesystems/{filesystemName}/filesets/{filesetName}/psnaps" : [ "POST" ],
"/filesystems/{filesystemName}/filesets/{filesetName}/psnaps/{snapshotName}" : [ "DELETE" ],
"/filesystems/{filesystemName}/filesets/{filesetName}/quotas" : [ "GET", "POST" ],
"/filesystems/{filesystemName}/filesets/{filesetName}/snapshots" : [ "GET", "POST" ],
"/filesystems/{filesystemName}/filesets/{filesetName}/snapshots/{snapshotName}" : [ "GET", "DELETE" ],
"/filesystems/{filesystemName}/owner/{path}" : [ "GET", "PUT" ],
"/filesystems/{filesystemName}/quotas" : [ "GET", "POST" ],
"/filesystems/{filesystemName}/snapshots" : [ "GET", "POST" ],
"/filesystems/{filesystemName}/snapshots/{snapshotName}" : [ "GET", "DELETE" ],
"/info" : [ "GET" ],
"/jobs" : [ "GET" ],
"/jobs/{jobId}" : [ "GET", "DELETE" ],
"/nfs/exports" : [ "GET", "POST" ],
"/nfs/exports/{exportPath}" : [ "GET", "DELETE", "PUT" ],
"/nodeclasses" : [ "GET", "POST" ],
"/nodeclasses/{nodeclassName}" : [ "GET", "DELETE", "PUT" ],
"/nodes" : [ "GET", "POST" ],
"/nodes/{name}" : [ "GET", "DELETE" ],
"/nodes/{name}/health/events" : [ "GET" ],
"/nodes/{name}/health/states" : [ "GET" ],
"/nsds" : [ "GET" ],
"/nsds/{nsdName}" : [ "GET" ],
"/perfmon/data" : [ "GET" ],
"/smb/shares" : [ "GET", "POST" ],
"/smb/shares/{shareName}" : [ "GET", "DELETE", "PUT" ],
"/thresholds" : [ "GET", "POST" ],
"/thresholds/{name}" : [ "GET", "DELETE" ]
}
},
"status" : {
"code" : 200,
"message" : "The request finished successfully"
}
}