Sign in
RolloutService

Cancel a rollout

Cancels a running, pausing, paused, system-paused, or stabilizing rollout by freezing the current traffic split into standing weights. Revert is removed and rejected; after canceling, start another canary rollout in either direction or rebalance the traffic split. The response is the accepted rollout snapshot; poll GetRollout until it reaches CANCELED.

post/projects/{projectId}/endpoints/{endpointId}/rollouts/{id}/cancel

Path parameters

projectIdstring required

Project identifier.

endpointIdstring required

Endpoint identifier.

idstring required

Rollout identifier.

Request body

reasonstring required

Required human-readable reason recorded in the rollout audit trail.

etagstring

Optional etag for optimistic concurrency.

disposition'CANCEL_DISPOSITION_FREEZE' | 'CANCEL_DISPOSITION_REVERT'

Optional cancel behavior. Absent defaults to freeze, which preserves the current traffic split. Revert is removed and rejected with FAILED_PRECONDITION; cancel with freeze, then run a reverse rollout back to the source.

Response

OK

idstring required

Output only. Unique rollout identifier.

endpointIdstring required

Output only. Endpoint this rollout belongs to.

sourceDeploymentIdstring required

Output only. Deployment that traffic is shifting away from.

targetDeploymentIdstring required

Output only. Deployment that traffic is shifting toward.

strategy'ROLLOUT_STRATEGY_TYPE_ROLLING' | 'ROLLOUT_STRATEGY_TYPE_CANARY' | 'ROLLOUT_STRATEGY_TYPE_BLUE_GREEN' required

Output only. Rollout strategy selected at creation.

state'ROLLOUT_STATE_RUNNING' | 'ROLLOUT_STATE_PAUSED' | 'ROLLOUT_STATE_STABILIZING' | 'ROLLOUT_STATE_ABORTING' | 'ROLLOUT_STATE_COMPLETED' | 'ROLLOUT_STATE_ABORTED' | 'ROLLOUT_STATE_PENDING' | 'ROLLOUT_STATE_SYSTEM_PAUSED' | 'ROLLOUT_STATE_CANCELLING' | 'ROLLOUT_STATE_CANCELED' | 'ROLLOUT_STATE_PAUSING' required

Output only. High-level rollout lifecycle state.

currentStepinteger

Output only. Zero-based index of the current step. Unset while PENDING; step 0 is reported explicitly after start.

currentTrafficPercentinteger

Output only. Applied percentage of traffic on the target deployment.

createdAtstring date-time required

Output only. Timestamp when the rollout was created.

startedAtstring date-time

Output only. Timestamp when the rollout started running.

completedAtstring date-time

Output only. Timestamp when the rollout reached a terminal state.

etagstring

Output only. Opaque version tag for optimistic concurrency control.

Changes

Changed in 3 of the 15 revisions of this API.13

  • 468edbdc879c2See the full diff
    • ○

      added the optional property ////////// to the response with the status

      response-optional-property-added

    • ○

      added the optional property ///// to the response with the status

      response-optional-property-added

  • ebd4756a41e41See the full diff
    • ●

      added the new ROLLOUT_STATE_PAUSING enum value to the response property for the response status

      response-property-enum-value-added

  • 0c4fdad774351See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog