Starting a Cluster
Function
This API is used to start a cluster.
URI
POST /v1.1/{project_id}/clusters/{cluster_id}/action
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
project_id |
Yes |
String |
Project ID |
|
cluster_id |
Yes |
String |
Cluster ID |
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
X-Auth-Token |
Yes |
String |
User token. It can be obtained by calling the IAM API (value of X-Subject-Token in the response header). |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
start |
Yes |
Object |
Starting a cluster. This parameter is an empty object. |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
jobId |
Array of strings |
Job ID |
Example Requests
Starting a Cluster
POST /v1.1/1551c7f6c808414d8e9f3c514a170f2e/clusters/bae65496-643e-47ca-84af-948672de7eeb/action
{
"start" : { }
}
Example Responses
Status code: 200
ok
{
"jobId" : [ "ff8080815e59d92d015e5b27ccb0004d" ]
}
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
ok |
|
400 |
Request error. |
|
401 |
Authentication failed. |
|
403 |
You do not have required permissions to perform this operation. |
|
404 |
The requested resource was not found. |
|
500 |
An internal service error occurred. For details, see error codes. |
|
503 |
Service unavailable. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.