Introduction

The HPC Cluster is an IBM Cloud service that allows a user to manage and deploy their Operating System in a secure High Performance Compute(HPC) cluster environment.

Error handling

This API operations uses standard HTTP response codes to indicate whether a method completed successfully. A 200 response indicates success. A 400 type response indicates a failure, and a 500 type response indicates an internal system error.

HTTP Error Code Description Recovery
200 Success The request was successful.
400 Bad Request The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request.
401 Unauthorized Unauthorized to make this request. Contact the account owner to check your permissions.
500 Internal Server Error Your request could not be processed. Wait a few minutes and try again. If the error persists please contact IBM Cloud support.
503 Service Unavailable Your request may have been rejected due to reaching our defined rate limit of 5 requests/second per IP address. Please adjust how you are calling the APIs to stay within the rate limit and try again.

In case the API operation fails,the response format is represented in JSON as follows:

{
  "error": {
    "message": "Error Message",
    "transaction_id": "655604d3-4d34-41c7-aab9-af52083276e5"
  },
  "success": false
}

The transaction_id is an unique identifier for an API operation. When contacting IBM support on API operation failures, the user may provide the transaction_id for better debugging.

Authentication

To work with the API, the user should add IBM Cloud IAM access token in the API request authentication header:

-H 'Authorization: Bearer <IAM_TOKEN>'

The user can retrieve an access token by using IBM Cloud CLI or by creating an API key, and then exchanging the API key for a IBM Cloud IAM token. For more information, see Getting an IAM token.

Methods

Register an owner for the HPC Cluster

POST /owner/create
Request

Cluster owner details

Response

Register owner operation response

Status Code

  • Accepted

  • Bad Request

  • Access Denied

  • Internal Server Error

Example responses

Remove an owner for the HPC Cluster

POST /owner/delete
Request

Query Parameters

  • Unique cluster identifier

Response

Status Code

  • Deleted

  • No Previous Owner

  • Bad Request

  • Access Denied

  • Internal Server Error

Example responses

Create the solution stack

POST /solution_stack/create
Request

Solution stack order details

Response

Status Code

  • Accepted

  • Bad Request

  • Access Denied

  • Internal Server Error

Example responses

Get the solution stack

Get the solution stack (HSM, HPCD, COS) details

GET /solution_stack
Request

Query Parameters

  • unique cluster identifier

Response

Status of the Solution Stack

Status Code

  • Status of the solution stack

  • Bad Request

  • Access Denied

  • Internal Server Error

Example responses

Get the solution stack price estimate details

GET /solution_stack/price_estimate
Request

Query Parameters

  • Unique cluster identifier

    Constraints: length ≥ 1

  • Data center short name

    Constraints: length ≥ 1

Response

Solution stack price estimate details

Status Code

  • Solution stack price estimate

  • Bad Request

  • Access Denied

  • Internal Server Error

Example responses

Get customer KEKs and OS information

GET /solution_stack/os_and_keys
Request

Query Parameters

  • Unique cluster identifier

Response

Operating System and Key Encryption Key details

Status Code

  • Returns customer OS and HSM KEK labels

  • Bad Request

  • Access Denied

  • Internal Server Error

Example responses

Upgrade HPC Driver to the latest version

PUT /solution_stack/hpcd_upgrade
Request

Cluster input

Response

Status Code

  • Accepted

  • Bad Request

  • Access Denied

  • Internal Server Error

Example responses

Order and configure cluster compute nodes

POST /compute/create
Request

Cluster Compute Node Specs

Response

Status Code

  • Accepted

  • Bad Request

  • Access Denied

  • Internal Server Error

Example responses

Get cluster compute node details

GET /compute
Request

Query Parameters

  • Unique cluster identifier

  • IBM Cloud Infrastructure component ID

  • Compute node Data center short name

  • Compute node host name

  • Compute node domain name

  • Compute node IP

  • Compute node configuration name

  • Compute node configuration

  • Key Encrytion Key label from HSM

  • Compute node operating system

  • Compute node status

Response

Compute node list

Status Code

  • Cluster compute node details

  • Bad Request

  • Access Denied

  • Internal Server Error

Example responses

Delete cluster compute nodes

POST /compute/delete
Request

Delete a list of selected cluster compute nodes

Response

Status Code

  • Accepted

  • Bad Request

  • Access Denied

  • Internal Server Error

Example responses

Get cluster compute node price estimate details

GET /compute/price_estimate
Request

Query Parameters

  • Unique cluster identifier

    Constraints: length ≥ 1

  • Compute node configuration spec

    Allowable values: [4X8X25_VSI,4110V1_BM,6140V1_BM,DEDICATED_56X242X1700_VSI,8X32X25_VSI,16X128X100_VSI,30X240X100_VSI]

  • Data center short name

    Constraints: length ≥ 1

Response

Compute Node price estimate details

Status Code

  • Cluster compute node price estimate

  • Bad Request

  • Access Denied

  • Internal Server Error

Example responses

Get datacenters

GET /datacenters
Request

Query Parameters

  • plan id (results will be filtered accordingly)

    Constraints: length ≥ 1

Response

Compute Node Data center inventory details

Status Code

  • Returns a list of presets and datacenters with inventory status grouped by region

  • Bad Request

  • Access Denied

  • Internal Server Error

Example responses