Pool

Delete a pool

Delete a pool. You cannot delete a pool if there are any attempts running or queued in the pool, if a pool rule references it, or if it is the default pool. The deleted pool’s concurrency limit is added to the default pool’s concurrency limit.

delete/api/pools/{poolId}

Request

Base URL
https://api-workflow.treasuredata.com
Auth
HTTP td1
TypeScript
https://skmtc.dev/treasure/apis/treasure-workflow/docs/api/pools/:poolId/delete.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

poolIdinteger required

ID of the pool.

Response

Pool deleted

concurrencyLimitinteger required

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

defaultboolean required

Whether the pool is the default pool.

idstring required

ID of the pool.

namestring required

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

Example response

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

Changes

No recorded changes to this operation across all 1 revision of this API.