Compute Pool

List compute pools

GET/api/v2/compute-pools
Lists the compute pools under the account.

Query Parameters

ParameterDescription
like string
Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters.
startsWith string
Query parameter to filter the command output based on the string of characters that appear at the beginning of the object name. Uses case-sensitive pattern matching.
showLimit integer
Query parameter to limit the maximum number of rows returned by a command.

Response

CodeDescription
200
Successful request.
202
Successfully accepted the request, but it is not completed yet.

Create a compute pool

POST/api/v2/compute-pools
Creates a compute pool, with standard create modifiers as query parameters. See the Compute Pool component definition for what is required to be provided in the request body.

Query Parameters

ParameterDescription
createMode string
Query parameter allowing support for different modes of resource creation. Possible values include:
  • errorIfExists: Throws an error if you try to create a resource that already exists.
  • orReplace: Automatically replaces the existing resource with the current one.
  • ifNotExists: Creates a new resource when an alter is requested for a non-existent resource.
initiallySuspended boolean
Specifies whether the compute pool is created initially in the suspended state.

Response

CodeDescription
200
Successful request.
202

Fetch a compute pool

GET/api/v2/compute-pools/{name}
Fetches a named compute pool. You can get the name of the compute pool from the `/api/v2/compute-pools` GET request.

Path Parameters

ParameterDescription
name 
Identifier (i.e. name) for the resource.

Response

CodeDescription
200
Successful request.
202

Create a (or alter an existing) compute pool

PUT/api/v2/compute-pools/{name}
Create a (or alter an existing) compute pool. Even if the operation is just an alter, the full property set must be provided.

Response

CodeDescription
200
202

Delete a compute pool

DELETE/api/v2/compute-pools/{name}
Deletes a compute pool with the given name. If you enable the `ifExists` parameter, the operation succeeds even if the object does not exist. Otherwise, a 404 failure is returned if the object does not exist.

Query Parameters

ParameterDescription
ifExists boolean
Query parameter that specifies how to handle the request for a resource that does not exist:
  • true: The endpoint does not throw an error if the resource does not exist. It returns a 200 success response, but does not take any action on the resource.
  • false: The endpoint throws an error if the resource doesn't exist.

Response

CodeDescription
200
202

Resume a suspended compute pool

POST/api/v2/compute-pools/{name}:resume
Resume a compute pool, if suspended. If the specified compute pool is already running, no action is taken.

Response

CodeDescription
200
202

Suspend an active compute pool

POST/api/v2/compute-pools/{name}:suspend
Suspend a compute pool, if active. If the specified compute pool is already suspended, no action is taken.

Response

CodeDescription
200
202

Stop all services on the compute pool (Deprecated)

POST/api/v2/compute-pools/{name}:stopallservices
Stops all services in the compute pool. Deprecated
  • use :stop-all-services instead.

Response

CodeDescription
200
202

Stop all services on the compute pool

POST/api/v2/compute-pools/{name}:stop-all-services
Stops all services in the compute pool.

Response

CodeDescription
200
202
Language: English