Chapter 11. Clusters Service
11.1. Clusters Service
11.1.1. DeleteCluster
DELETE /v1/clusters/{id}
11.1.1.1. Description
11.1.1.2. Parameters
11.1.1.2.1. Path Parameters
Name | Description | Required | Default | Pattern |
---|---|---|---|---|
id | X | null |
11.1.1.3. Return Type
Object
11.1.1.4. Content Type
- application/json
11.1.1.5. Responses
Code | Message | Datatype |
---|---|---|
200 | A successful response. |
|
0 | An unexpected error response. |
11.1.1.6. Samples
11.1.2. GetCluster
GET /v1/clusters/{id}
11.1.2.1. Description
11.1.2.2. Parameters
11.1.2.2.1. Path Parameters
Name | Description | Required | Default | Pattern |
---|---|---|---|---|
id | X | null |
11.1.2.3. Return Type
11.1.2.4. Content Type
- application/json
11.1.2.5. Responses
Code | Message | Datatype |
---|---|---|
200 | A successful response. | |
0 | An unexpected error response. |
11.1.2.6. Samples
11.1.3. GetClusterDefaultValues
GET /v1/cluster-defaults
11.1.3.1. Description
11.1.3.2. Parameters
11.1.3.3. Return Type
11.1.3.4. Content Type
- application/json
11.1.3.5. Responses
Code | Message | Datatype |
---|---|---|
200 | A successful response. | |
0 | An unexpected error response. |
11.1.3.6. Samples
11.1.4. GetClusters
GET /v1/clusters
11.1.4.1. Description
11.1.4.2. Parameters
11.1.4.2.1. Query Parameters
Name | Description | Required | Default | Pattern |
---|---|---|---|---|
query | - | null |
11.1.4.3. Return Type
11.1.4.4. Content Type
- application/json
11.1.4.5. Responses
Code | Message | Datatype |
---|---|---|
200 | A successful response. | |
0 | An unexpected error response. |
11.1.4.6. Samples
11.1.5. GetKernelSupportAvailable
GET /v1/clusters-env/kernel-support-available
GetKernelSupportAvailable is deprecated in favor of GetClusterDefaultValues.
11.1.5.1. Description
11.1.5.2. Parameters
11.1.5.3. Return Type
11.1.5.4. Content Type
- application/json
11.1.5.5. Responses
Code | Message | Datatype |
---|---|---|
200 | A successful response. | |
0 | An unexpected error response. |
11.1.5.6. Samples
11.1.6. PostCluster
POST /v1/clusters
11.1.6.1. Description
11.1.6.2. Parameters
11.1.6.2.1. Body Parameter
Name | Description | Required | Default | Pattern |
---|---|---|---|---|
body | X |
11.1.6.3. Return Type
11.1.6.4. Content Type
- application/json
11.1.6.5. Responses
Code | Message | Datatype |
---|---|---|
200 | A successful response. | |
0 | An unexpected error response. |
11.1.6.6. Samples
11.1.7. PutCluster
PUT /v1/clusters/{id}
11.1.7.1. Description
11.1.7.2. Parameters
11.1.7.2.1. Path Parameters
Name | Description | Required | Default | Pattern |
---|---|---|---|---|
id | X | null |
11.1.7.2.2. Body Parameter
Name | Description | Required | Default | Pattern |
---|---|---|---|---|
body | X |
11.1.7.3. Return Type
11.1.7.4. Content Type
- application/json
11.1.7.5. Responses
Code | Message | Datatype |
---|---|---|
200 | A successful response. | |
0 | An unexpected error response. |