Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-13144376.2 KB
projects

Creates a new rollout for a backend.

post/v1/{+parent}/rollouts

Path parameters

parentstring required

Required. The parent backend in the format: projects/{project}/locations/{locationId}/backends/{backendId}.

Query parameters

requestIdstring

Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

rolloutIdstring

Optional. Desired ID of the rollout being created.

validateOnlyboolean

Optional. Indicates that the request should be validated and default values populated, without persisting the request or creating any resources.

Request body

reconcilingboolean

Output only. A field that, if true, indicates that the Rollout currently has an LRO.

labelsobject

Optional. Unstructured key value map that can be used to organize and categorize objects.

namestring

Identifier. The resource name of the rollout. Format: projects/{project}/locations/{locationId}/backends/{backendId}/rollouts/{rolloutId}.

uidstring

Output only. System-assigned, unique identifier.

createTimestring google-datetime

Output only. Time at which the rollout was created.

updateTimestring google-datetime

Output only. Time at which the rollout was last updated.

annotationsobject

Optional. Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects.

displayNamestring

Optional. Human-readable name. 63 character limit.

deleteTimestring google-datetime

Output only. Time at which the rollout was deleted.

buildstring

Required. Immutable. The name of a build that already exists. It doesn't have to be built; a rollout will wait for a build to be ready before updating traffic.

etagstring

Output only. Server-computed checksum based on other values; may be sent on update or delete to ensure operation is done on expected resource.

state'STATE_UNSPECIFIED' | 'QUEUED' | 'PENDING_BUILD' | 'PROGRESSING' | 'PAUSED' | 'SUCCEEDED' | 'FAILED' | 'CANCELLED' | 'SKIPPED'

Output only. The state of the rollout.

Response

Successful response