Skip to content

Create a pool

Request

Create a pool with the specified name and concurrency limit. A default pool is created with the account's concurrency limit if it does not exist. The default pool’s concurrency limit is reduced by the new pool’s concurrency limit. You cannot create a pool if the default pool has more running attempts than its new reduced concurrency limit.

Security
ApiKeyAuth
Bodyapplication/jsonrequired
concurrencyLimitinteger, (int32), >= 1required

Maximum number of concurrent attempts that can run in this pool. Total concurrency limit of all pools cannot exceed the account's concurrency limit.

Example:10
namestring, [ 1 .. 256 ] charactersrequired

Name of the pool. This name must be unique within the account.

Example:"activation"
curl -i -X POST \
  https://api-workflow.treasuredata.com/api/pools \
  -H 'Authorization: TD1 <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "concurrencyLimit": 10,
    "name": "activation"
  }'

Responses

Pool created

Bodyapplication/json
concurrencyLimitinteger, (int32), >= 1required

Maximum number of concurrent attempts that can run in this pool. Total concurrency limit of all pools cannot exceed the account's concurrency limit.

Example:10
defaultbooleanrequired

Whether the pool is the default pool.

Example:true
idstring, >= 1required

ID of the pool.

Example:"42"
namestring, [ 1 .. 256 ] charactersrequired

Name of the pool. This name must be unique within the account.

Example:"activation"
Response
{ "concurrencyLimit": 10, "default": true, "id": "42", "name": "activation" }