Cluster Manager API

Download the Cluster Manager API in OpenAPI YAML format

GET /v2/projects/{projectName}/clusters

Gets all clusters’ information.

Parameters:

• projectName (string) – unique projectName for the resource

Query Parameters:

• pageSize (integer) – The maximum number of items to return.

• offset (integer) – Index of the first item to return. It is almost always used in conjunction with the ‘pageSize’ query.

• orderBy (string) – The ordering of the entries. “asc” and “desc” are valid values. If none is specified, “asc” is used.

• filter (string) – Filters the entries based on the filter provided.

Status Codes:

• 200 OK – OK

• 400 Bad Request – Object in payload is not properly formulated or not related to the method.

• 500 Internal Server Error – The provider is currently unable to handle the request due to an internal error

POST /v2/projects/{projectName}/clusters

Creates a cluster.

Parameters:

• projectName (string) – unique projectName for the resource

Status Codes:

• 201 Created – OK

• 400 Bad Request – Object in payload is not properly formulated or not related to the method.

• 500 Internal Server Error – The provider is currently unable to handle the request due to an internal error

DELETE /v2/projects/{projectName}/clusters/{name}

Deletes the cluster {name}.

Parameters:

• name (string)

• projectName (string) – unique projectName for the resource

Status Codes:

• 204 No Content – OK

• 400 Bad Request – Object in payload is not properly formulated or not related to the method.

• 404 Not Found – No resource is found at the URI.

• 500 Internal Server Error – The provider is currently unable to handle the request due to an internal error

GET /v2/projects/{projectName}/clusters/{name}

Gets the cluster {name} information.

Parameters:

• name (string)

• projectName (string) – unique projectName for the resource

Status Codes:

• 200 OK – OK

• 400 Bad Request – Object in payload is not properly formulated or not related to the method.

• 404 Not Found – No resource is found at the URI.

• 500 Internal Server Error – The provider is currently unable to handle the request due to an internal error

GET /v2/projects/{projectName}/clusters/{name}/kubeconfigs

Gets the cluster’s kubeconfig file by its name {name}.

Parameters:

• name (string)

• projectName (string) – unique projectName for the resource

Status Codes:

• 200 OK – OK

• 400 Bad Request – Object in payload is not properly formulated or not related to the method.

• 401 Unauthorized – Authentication information is missing or invalid.

• 404 Not Found – No resource is found at the URI.

• 500 Internal Server Error – The provider is currently unable to handle the request due to an internal error

PUT /v2/projects/{projectName}/clusters/{name}/labels

Updates cluster {name} labels.

Parameters:

• name (string)

• projectName (string) – unique projectName for the resource

Status Codes:

• 200 OK – The cluster labels are updated successfully.

• 400 Bad Request – Object in payload is not properly formulated or not related to the method.

• 404 Not Found – No resource is found at the URI.

• 500 Internal Server Error – The provider is currently unable to handle the request due to an internal error

PUT /v2/projects/{projectName}/clusters/{name}/nodes

Updates cluster {name} nodes.

Parameters:

• name (string)

• projectName (string) – unique projectName for the resource

Status Codes:

• 200 OK – The cluster nodes are updated successfully.

• 400 Bad Request – Object in payload is not properly formulated or not related to the method.

• 404 Not Found – No resource is found at the URI.

• 500 Internal Server Error – The provider is currently unable to handle the request due to an internal error

DELETE /v2/projects/{projectName}/clusters/{name}/nodes/{nodeId}

Deletes the cluster {name} node {nodeId}.

Parameters:

• name (string)

• nodeId (string)

• projectName (string) – unique projectName for the resource

Query Parameters:

• force (boolean) – When set to true, force deletes the edge node.

Status Codes:

• 200 OK – The cluster node is operated successfully.

• 400 Bad Request – Object in payload is not properly formulated or not related to the method.

• 404 Not Found – No resource is found at the URI.

• 500 Internal Server Error – The provider is currently unable to handle the request due to an internal error

PUT /v2/projects/{projectName}/clusters/{name}/template

Updates the cluster {name} template.

Parameters:

• name (string)

• projectName (string) – unique projectName for the resource

Status Codes:

• 202 Accepted – The cluster template update request is accepted.

• 400 Bad Request – Object in payload is not properly formulated or not related to the method.

• 404 Not Found – No resource is found at the URI.

• 500 Internal Server Error – The provider is currently unable to handle the request due to an internal error

• 501 Not Implemented – The requested operation is not implemented.

GET /v2/projects/{projectName}/clusters/{nodeId}/clusterdetail

Gets cluster detailed information by {nodeId}.

Parameters:

• nodeId (string)

• projectName (string) – unique projectName for the resource

Status Codes:

• 200 OK – OK

• 400 Bad Request – Object in payload is not properly formulated or not related to the method.

• 404 Not Found – No resource is found at the URI.

GET /v2/projects/{projectName}/clusters/summary

Gets all clusters’ summarized by their state.

Parameters:

• projectName (string) – unique projectName for the resource

Status Codes:

• 200 OK – OK

• 400 Bad Request – Object in payload is not properly formulated or not related to the method.

• 500 Internal Server Error – The provider is currently unable to handle the request due to an internal error

GET /v2/projects/{projectName}/templates

Gets all templates’ information

Parameters:

• projectName (string) – unique projectName for the resource

Query Parameters:

• default (boolean) – When set to true, gets only the default template information

• pageSize (integer) – The maximum number of items to return.

• offset (integer) – Index of the first item to return. It is almost always used in conjunction with the ‘pageSize’ query.

• orderBy (string) – The ordering of the entries. “asc” and “desc” are valid values. If none is specified, “asc” is used.

• filter (string) – Filters the entries based on the filter provided.

Status Codes:

• 200 OK – OK

• 400 Bad Request – Object in payload is not properly formulated or not related to the method.

• 404 Not Found – No resource is found at the URI.

• 500 Internal Server Error – The provider is currently unable to handle the request due to an internal error

POST /v2/projects/{projectName}/templates

Import templates

Parameters:

• projectName (string) – unique projectName for the resource

Status Codes:

• 201 Created – OK

• 400 Bad Request – Object in payload is not properly formulated or not related to the method.

• 409 Conflict – Request could not be processed in the current state of the resource.

• 500 Internal Server Error – The provider is currently unable to handle the request due to an internal error

PUT /v2/projects/{projectName}/templates/{name}/default

Updates this template as the default template

Parameters:

• name (string) – Name of the template

• projectName (string) – unique projectName for the resource

Status Codes:

• 200 OK – OK

• 400 Bad Request – Object in payload is not properly formulated or not related to the method.

• 404 Not Found – No resource is found at the URI.

• 500 Internal Server Error – The provider is currently unable to handle the request due to an internal error

GET /v2/projects/{projectName}/templates/{name}/versions

Gets all versions of templates matching a particular template name

Parameters:

• name (string) – Name of the template

• projectName (string) – unique projectName for the resource

Status Codes:

• 200 OK – OK

• 400 Bad Request – Object in payload is not properly formulated or not related to the method.

• 404 Not Found – No resource is found at the URI.

• 500 Internal Server Error – The provider is currently unable to handle the request due to an internal error

DELETE /v2/projects/{projectName}/templates/{name}/versions/{version}

Deletes a specific template

Parameters:

• name (string) – Name of the template

• version (string) – Version of the template in the format of ‘vX.Y.Z’

• projectName (string) – unique projectName for the resource

Status Codes:

• 204 No Content – OK

• 400 Bad Request – Object in payload is not properly formulated or not related to the method.

• 404 Not Found – No resource is found at the URI.

• 500 Internal Server Error – The provider is currently unable to handle the request due to an internal error

GET /v2/projects/{projectName}/templates/{name}/versions/{version}

Gets a specific template information

Parameters:

• name (string) – Name of the template

• version (string) – Version of the template in the format of ‘vX.Y.Z’

• projectName (string) – unique projectName for the resource

Status Codes:

• 200 OK – OK

• 400 Bad Request – Object in payload is not properly formulated or not related to the method.

• 404 Not Found – No resource is found at the URI.

• 500 Internal Server Error – The provider is currently unable to handle the request due to an internal error