Nodeclasses/{nodeclassName}: GET
Gets details about a specific node class in the IBM Spectrum Scale™ cluster.
Availability
Available on all IBM Spectrum Scale editions.
Description
The GET nodeclasses/{nodeclasseName} request gets information about a specific and the nodes that are part of that node class. For more information about the fields in the data structures that are returned, see the topics mmcrnodeclass command, mmdelnodeclass command, mmchnodeclass command, and mmlsnodeclass command.
Request URL
https://<IP address or host name of API server>:<port>/scalemgmt/v2/nodeclasses/nodeclassName
where- nodeclasses/nodeclassName
- Specifies a particular nodes class as the resource of this GET call. Required.
Request headers
Content-Type: application/json
Accept: application/json
Request data
No request data.
Request parameters
The following parameters can be used in the request URL to customize the
request:
Parameter name | Description and applicable keywords | Required/optional |
---|---|---|
fields | Comma separated list of fields to be included in response. ':all:' selects all available fields. | Optional. |
filter | Filter objects by expression. For example, 'status=HEALTHY,entityType=FILESET' | Optional. |
nodeclassName | The name of the node class. | Required. |
Response data
{
"status": {
"code":ReturnCode",
"message":"ReturnMessage"
},
"paging":
{
"next": "URL"
},
nodeClasses: [
{
"nodeclassName": "Name",
"members": "[node1Name, node2Name, node3Name]",
"type": "SYSTEM | USER"
}
]
}
For
more information about the fields in the following data structures, see the links at the end of this
topic.- "status":
- Return status.
- "message": "ReturnMessage",
- The return message.
- "code": ReturnCode
- The return code.
- "paging"
- The URL to retrieve the next page. Paging is enabled when more than 1000 objects are returned by the query.
- "nodeClasses":
- "nodeclassName":"Name"
- The name of the node class.
- "members":"List of nodes"
- The list of nodes that are part of the node class.
- "type": "Type
- Indicates whether the node class is system-defined or user-defined.
Examples
The following example gets information about the node class cesNodes.
Request URL:
curl -k -u admin:admin001 -X GET --header 'accept:application/json'
'https://198.51.100.1:443/scalemgmt/v2/nodeclasses/cesNodes'
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.
{
"status": {
"code": "200",
"message": "..."
},
"nodeClasses": [
{
"nodeclassName": "cesNodes",
"members": "[mari-12.localnet.com,mari-13.localnet.com]",
"type": "SYSTEM"
}
]
}