Experimental
The UnixCluster API is implemented via the Unix Cluster Plugin. REST APIs provided by plugins are currently considered Experimental, and as such this interface may change without notice between minor releases.
Implementation Notes
- Only JSON format is supported. XML format is not supported.
- The URLs for this API use plugin syntax. (There is an extra component to the path.)
Add
To add a new Unix Cluster, use the Cluster API.
Delete
Remove a Unix Cluster.
Request Format
Method |
|
|---|---|
URL |
|
Request Body |
Response Format
HTTP Status | Response Body | Description |
|---|---|---|
| Unix Cluster deleted | |
|
| |
| Authentication required | |
|
| |
| Unknown error |
Edit
Edit an existing Unix Cluster.
Request Format
Method |
|
|---|---|
URL |
|
Request Body |
Response Format
HTTP Status | Response Body | Description |
|---|---|---|
| Unix Cluster updated | |
| Unix Cluster Request not provided in POST body | |
| ErrorResponse with details in | An error in one or more provided fields |
| Authentication required | |
|
| |
| Unknown error |
View (all)
Retrieve all existing UnixClusters.
Request Format
Method |
|
|---|---|
URL |
|
Request Body |
Response Format
HTTP Status | Response Body | Description |
|---|---|---|
| Unix Cluster returned | |
| Authentication required | |
| Unknown error |
View (per Cluster)
Retrieve Unix Clusters attached to a Cluster.
Request Format
Method |
|
|---|---|
URL |
|
Request Body |
Response Format
| Unix Clusters returned | |
| Authentication required | |
|
| |
| Unknown error |
View (one)
Retrieve an existing Unix Cluster.
Request Format
Method |
|
|---|---|
URL |
|
Request Body |
Response Format
HTTP Status | Response Body | Description |
|---|---|---|
| Unix Cluster returned | |
| Authentication required | |
|
| |
| Unknown error |
Notes
- Response format requested is ignored where response is only via HTTP status, but must still be provided.
See Also
- Unix Cluster Account API
- Unix Cluster Group API
- cm_unix_clusters data model definition