Simulations

Start a rolling ECS Fargate deployment

Starts a rolling replacement of all running tasks in an ecsFargate resource. Tasks are replaced in batches of maxSurge: each new batch warms through taskStartupSeconds (the resource's configured startup delay) before the corresponding old tasks begin draining through taskScaleDownSeconds. During the drain window the ready new tasks serve new connections while the old tasks finish existing ones, so effective serving capacity is preserved throughout the deploy.

Progress is visible in subsequent GET /simulations/{simulationId} responses under each resource's metadata.fargateDeployReplacingCount and in normalizedConfig.requestServing[].rollingDeploy (present only while a deploy is in flight). A "success" event is emitted when the final batch completes.

Only ecsFargate resources support this action. Provide resourceId or resourceName to target a specific resource; omit both to auto-detect the first ecsFargate resource in the simulation.

Requires write scope and ownership.

post/simulations/{simulationId}/deploy

Request

  • Base URL: https://www.cloudworldmodel.ai/api
  • URL: https://www.cloudworldmodel.ai/api/simulations/{simulationId}/deploy
  • Auth: one of:
    • HTTP bearer
    • API key in header X-PAYMENT
    • API key in header PAYMENT-SIGNATURE

Path parameters

simulationIdstring required

Simulation UUID

Request body

resourceIdstring

ID of the ecsFargate resource to deploy. Takes precedence over resourceName.

resourceNamestring

Human-readable name of the ecsFargate resource to deploy.

maxSurgeinteger

Number of new tasks to launch per batch before the corresponding old tasks drain (default 1). Larger values speed up the deploy at the cost of temporarily running more tasks.

Response

Rolling deployment initiated

simulationobject

Updated simulation state (resources with deploy metadata set)

eventobject

Deployment-started event emitted to the simulation event log

deployedResourceIdstring

ID of the ecsFargate resource being deployed

deployedResourceNamestring

Name of the ecsFargate resource being deployed

Changes

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