Update a pool

Request

Update a pool with the specified name and concurrency limit. You cannot update the default pool. The default pool’s concurrency limit is adjusted to accommodate the new concurrency limit. A pool’s concurrency limit cannot be reduced if it has more running attempts than its new reduced concurrency limit.

Security

ApiKeyAuth

Path

poolIdinteger, (int32)required

ID of the pool.

Bodyapplication/jsonrequired

concurrencyLimitinteger, (int32), >= 1

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 ] characters

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

Example:"activation"

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

Responses

Pool updated

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