/scalemgmt/v3/nodeclasses: POST

Creates user-defined node classes.

Availability

Available on all IBM Storage Scale editions.

Description

The POST nodeclasses request creates user-defined node classes. After a node class is created, it can be specified as a parameter on request that accept target_nodes.

Request URL

https://<IP address or host name of API server>:<port>/scalemgmt/v3/nodeclasses

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
nodeclass	The body of the request that contains the parameters that are sent to IBM Storage Scale to perform the requested operation. `{ "members": [ "string" ], "name": "string", "subclasses": [] }`	Required.
X-StorageScaleDomain	The domain to be authorized against for the request. The default value is `StorageScaleDomain`.	Optional.

Request data

No request data.

Response data

201: The Node Class has been successfully created.

{
  "members": [
    "string"
  ],
  "name": "string",
  "subclasses": [
    "string"
  ]
}

default: An unexpected error response.

{
  "code": 0,
  "details": [
    {
      "@type": "string",
      "additionalProp1": "string",
      "additionalProp2": "string",
      "additionalProp3": "string"
    }
  ],
  "message": "string"
}

Examples

The following example creates the CLASS2 node class:

Request data:

curl -X 'POST' 'https://localhost:46443/scalemgmt/v3/nodeclasses' \
  -H 'accept: application/json' -n -k \
  -H 'Content-Type: application/json' \
  -d '{
  "members": [
    "scale-22"
  ],
  "name": "CLASS2",
  "subclasses": []
}'

Response data:

{
        "name": "CLASS2",
        "members": [
                "scale-22"
        ]
}