HPC Infra Cluster Management API (0.1.0)

Download OpenAPI specification:Download

API for managing clusters across cloud providers with tool and service installation

Requests - List all

Get all requests with status. Limited based on role of requesting user

Authorizations:

(AccessKeyAuthSecretKeyAuth)

query Parameters

status	string Enum: "pending" "approved" "rejected"
requestedBy	string <uuid>

Responses

Response samples

200

Content type

application/json

[{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"cloudProviderId": "1a2278cb-eaa1-4ddc-b267-06e7b99f872d",
"size": {"numberOfNodes": 1,
"nodeType": "string"
},
"tools": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "iverilog",
"version": "string"
}
],
"services": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "postgresql",
"version": "string",
"config": { },
"status": "pending",
"credentials": { }
}
],
"status": "pending",
"requestedBy": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"email": "string",
"role": "it_manager"
},
"approvedBy": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"email": "string",
"role": "it_manager"
},
"requestedAt": "2019-08-24T14:15:22Z",
"approvedAt": "2019-08-24T14:15:22Z",
"notes": [{"time": "2019-08-24T14:15:22Z",
"by": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"email": "string",
"role": "it_manager"
},
"note": "string"
}
]
}
]

Requests - Create new

CAD managers can request new clusters

Authorizations:

(AccessKeyAuthSecretKeyAuth)

Request Body schema: application/json

id	string <uuid>
name required	string
cloudProviderId required	string <uuid>
required	object
	Array of objects (Tool)
	Array of objects (Service)
status	string Default: "pending" Enum: "pending" "approved" "rejected"
required	object (User)
	object (User)
requestedAt	string <date-time>
approvedAt	string <date-time>
	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"cloudProviderId": "1a2278cb-eaa1-4ddc-b267-06e7b99f872d",
"size": {"numberOfNodes": 1,
"nodeType": "string"
},
"tools": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "iverilog",
"version": "string"
}
],
"services": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "postgresql",
"version": "string",
"config": { },
"status": "pending",
"credentials": { }
}
],
"status": "pending",
"requestedBy": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"email": "string",
"role": "it_manager"
},
"approvedBy": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"email": "string",
"role": "it_manager"
},
"requestedAt": "2019-08-24T14:15:22Z",
"approvedAt": "2019-08-24T14:15:22Z",
"notes": [{"time": "2019-08-24T14:15:22Z",
"by": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"email": "string",
"role": "it_manager"
},
"note": "string"
}
]
}

Response samples

201

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"cloudProviderId": "1a2278cb-eaa1-4ddc-b267-06e7b99f872d",
"size": {"numberOfNodes": 1,
"nodeType": "string"
},
"tools": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "iverilog",
"version": "string"
}
],
"services": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "postgresql",
"version": "string",
"config": { },
"status": "pending",
"credentials": { }
}
],
"status": "pending",
"requestedBy": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"email": "string",
"role": "it_manager"
},
"approvedBy": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"email": "string",
"role": "it_manager"
},
"requestedAt": "2019-08-24T14:15:22Z",
"approvedAt": "2019-08-24T14:15:22Z",
"notes": [{"time": "2019-08-24T14:15:22Z",
"by": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"email": "string",
"role": "it_manager"
},
"note": "string"
}
]
}

Requests - Get details of individual request

Authorizations:

(AccessKeyAuthSecretKeyAuth)

path Parameters

requestId

required

string <uuid>

Responses

Response samples

200

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"cloudProviderId": "1a2278cb-eaa1-4ddc-b267-06e7b99f872d",
"size": {"numberOfNodes": 1,
"nodeType": "string"
},
"tools": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "iverilog",
"version": "string"
}
],
"services": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "postgresql",
"version": "string",
"config": { },
"status": "pending",
"credentials": { }
}
],
"status": "pending",
"requestedBy": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"email": "string",
"role": "it_manager"
},
"approvedBy": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"email": "string",
"role": "it_manager"
},
"requestedAt": "2019-08-24T14:15:22Z",
"approvedAt": "2019-08-24T14:15:22Z",
"notes": [{"time": "2019-08-24T14:15:22Z",
"by": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"email": "string",
"role": "it_manager"
},
"note": "string"
}
]
}

Requests - Approve or reject

IT managers can approve or reject requests

Authorizations:

(AccessKeyAuthSecretKeyAuth)

path Parameters

requestId

required

string <uuid>

Request Body schema: application/json

status required	string Enum: "approved" "rejected"
rejectionReason	string

Responses

Request samples

Payload

Content type

application/json

{"status": "approved",
"rejectionReason": "string"
}

Response samples

200

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"cloudProviderId": "1a2278cb-eaa1-4ddc-b267-06e7b99f872d",
"size": {"numberOfNodes": 1,
"nodeType": "string"
},
"tools": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "iverilog",
"version": "string"
}
],
"services": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "postgresql",
"version": "string",
"config": { },
"status": "pending",
"credentials": { }
}
],
"status": "pending",
"requestedBy": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"email": "string",
"role": "it_manager"
},
"approvedBy": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"email": "string",
"role": "it_manager"
},
"requestedAt": "2019-08-24T14:15:22Z",
"approvedAt": "2019-08-24T14:15:22Z",
"notes": [{"time": "2019-08-24T14:15:22Z",
"by": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"email": "string",
"role": "it_manager"
},
"note": "string"
}
]
}

Requests - Get all notes

Authorizations:

(AccessKeyAuthSecretKeyAuth)

path Parameters

requestId

required

string <uuid>

Responses

Response samples

200

Content type

application/json

[{"time": "2019-08-24T14:15:22Z",
"by": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"email": "string",
"role": "it_manager"
},
"note": "string"
}
]

Requests - Add a note

Authorizations:

(AccessKeyAuthSecretKeyAuth)

path Parameters

requestId

required

string <uuid>

Request Body schema: application/json

note

required

string

Responses

Request samples

Payload

Content type

application/json

{"note": "string"
}

Response samples

201

Content type

application/json

{"time": "2019-08-24T14:15:22Z",
"by": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"email": "string",
"role": "it_manager"
},
"note": "string"
}

Cluster - List all clusters

List all clusters created by the current user

Authorizations:

(AccessKeyAuthSecretKeyAuth)

query Parameters

status	string
cloudProviderId	string

Responses

Response samples

200

Content type

application/json

[{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"cloudProviderId": "1a2278cb-eaa1-4ddc-b267-06e7b99f872d",
"type": "slurm",
"size": {"numberOfNodes": 1,
"nodeType": "small",
"storage": 10
},
"status": "pending",
"tools": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "iverilog",
"version": "string"
}
],
"services": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "postgresql",
"version": "string",
"config": { },
"status": "pending",
"credentials": { }
}
],
"createdAt": "2019-08-24T14:15:22Z"
}
]

Cluster - Create a new cluster

CAD managers can create new clusters

Authorizations:

(AccessKeyAuthSecretKeyAuth)

Request Body schema: application/json

id	string <uuid>
name required	string
cloudProviderId required	string <uuid>
type	string Value: "slurm"
required	object
status	string Enum: "pending" "provisioning" "available" "error"
	Array of objects (Tool)
	Array of objects (Service)
createdAt	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"cloudProviderId": "1a2278cb-eaa1-4ddc-b267-06e7b99f872d",
"type": "slurm",
"size": {"numberOfNodes": 1,
"nodeType": "small",
"storage": 10
},
"status": "pending",
"tools": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "iverilog",
"version": "string"
}
],
"services": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "postgresql",
"version": "string",
"config": { },
"status": "pending",
"credentials": { }
}
],
"createdAt": "2019-08-24T14:15:22Z"
}

Response samples

201

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"cloudProviderId": "1a2278cb-eaa1-4ddc-b267-06e7b99f872d",
"type": "slurm",
"size": {"numberOfNodes": 1,
"nodeType": "small",
"storage": 10
},
"status": "pending",
"tools": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "iverilog",
"version": "string"
}
],
"services": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "postgresql",
"version": "string",
"config": { },
"status": "pending",
"credentials": { }
}
],
"createdAt": "2019-08-24T14:15:22Z"
}

Cluster - Get cluster details

Authorizations:

(AccessKeyAuthSecretKeyAuth)

path Parameters

clusterId

required

string <uuid>

Responses

Response samples

200

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"cloudProviderId": "1a2278cb-eaa1-4ddc-b267-06e7b99f872d",
"type": "slurm",
"size": {"numberOfNodes": 1,
"nodeType": "small",
"storage": 10
},
"status": "pending",
"tools": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "iverilog",
"version": "string"
}
],
"services": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "postgresql",
"version": "string",
"config": { },
"status": "pending",
"credentials": { }
}
],
"createdAt": "2019-08-24T14:15:22Z"
}

Cluster - Terminate cluster

Authorizations:

(AccessKeyAuthSecretKeyAuth)

path Parameters

clusterId

required

string <uuid>

Responses

Cluster - Install a tool on the cluster

Authorizations:

(AccessKeyAuthSecretKeyAuth)

path Parameters

clusterId

required

string <uuid>

Request Body schema: application/json

id	string <uuid>
name required	string
version required	string

Responses

Request samples

Payload

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "iverilog",
"version": "string"
}

Response samples

201

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "iverilog",
"version": "string"
}

Cluster - Deploy a service on the cluster

Authorizations:

(AccessKeyAuthSecretKeyAuth)

path Parameters

clusterId

required

string <uuid>

Request Body schema: application/json

id	string <uuid>
name required	string
version required	string
	object
status	string Enum: "pending" "provisioning" "running" "failed" "stopped"
	object

Responses

Request samples

Payload

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "postgresql",
"version": "string",
"config": { },
"status": "pending",
"credentials": { }
}

Response samples

201

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "postgresql",
"version": "string",
"config": { },
"status": "pending",
"credentials": { }
}

Analytics - Get cluster metrics over time

Retrieve metrics like CPU, memory, storage utilization and credit consumption

Authorizations:

(AccessKeyAuthSecretKeyAuth)

path Parameters

clusterId

required

string <uuid>

query Parameters

start	string <date-time>
end	string <date-time>
interval	string Default: "hour" Enum: "minute" "hour" "day"

Responses

Response samples

200

Content type

application/json

{"timeRange": {"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z",
"interval": "string"
},
"metrics": [{"timestamp": "2019-08-24T14:15:22Z",
"cpu": {"utilizationPercent": 0,
"allocatedCores": 0
},
"memory": {"utilizationPercent": 0,
"allocatedGB": 0
},
"storage": {"utilizationPercent": 0,
"allocatedGB": 0
},
"credits": {"consumed": 0,
"rate": 0
}
}
]
}

Analytics - Get current cluster analytics summary

Get real-time summary of cluster utilization and costs

Authorizations:

(AccessKeyAuthSecretKeyAuth)

path Parameters

clusterId

required

string <uuid>

Responses

Response samples

200

Content type

application/json

{"current": {"cpu": {"utilizationPercent": 0,
"allocatedCores": 0
},
"memory": {"utilizationPercent": 0,
"allocatedGB": 0
},
"storage": {"utilizationPercent": 0,
"allocatedGB": 0
}
},
"credits": {"totalConsumed": 0,
"currentRate": 0,
"estimatedDaily": 0,
"estimatedMonthly": 0
}
}

Providers - List available cloud providers

Authorizations:

(AccessKeyAuthSecretKeyAuth)

Responses

Response samples

200

Content type

application/json

[{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "AWS",
"region": "string",
"status": "active"
}
]

Analytics - Get tenant-wide analytics

Get aggregated analytics across all tenant resources including clusters, costs and utilization

Authorizations:

(AccessKeyAuthSecretKeyAuth)

path Parameters

tenantId

required

string <uuid>

query Parameters

start	string <date-time>
end	string <date-time>

Responses

Response samples

200

Content type

application/json

{"overview": {"totalClusters": 0,
"activeClusters": 0,
"totalUsers": 0,
"activeUsers": 0
},
"resources": {"totalCores": 0,
"totalMemoryGB": 0,
"totalStorageGB": 0,
"averageUtilization": {"cpu": 0,
"memory": 0,
"storage": 0
}
},
"credits": {"balance": 0,
"consumed": {"daily": 0,
"weekly": 0,
"monthly": 0
},
"forecast": {"nextWeek": 0,
"nextMonth": 0
}
},
"breakdown": {"byCluster": [{"clusterId": "a3d24843-7014-4490-bdd3-b7cb39b400c8",
"name": "string",
"creditsConsumed": 0,
"utilizationPercent": 0
}
],
"byUser": [{"userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
"name": "string",
"creditsConsumed": 0
}
]
}
}