GOgoogle
rollouts

GET /projects/{project}/global/rollouts/{rollout}

Changed on

Gets details of a single project-scoped Rollout.

Request

  • Base URL
    https://compute.googleapis.com/compute/v1
  • URL
    https://compute.googleapis.com/compute/v1/projects/{project}/global/rollouts/{rollout}
  • Auth
    • OAuth 2 and OAuth 2
      Implicit: https://accounts.google.com/o/oauth2/auth
      Scopes: https://www.googleapis.com/auth/cloud-platform
      Authorization code: https://accounts.google.com/o/oauth2/auth
      Token URL: https://accounts.google.com/o/oauth2/token scopes: https://www.googleapis.com/auth/cloud-platform
    • or OAuth 2 and OAuth 2
      Implicit: https://accounts.google.com/o/oauth2/auth
      Scopes: https://www.googleapis.com/auth/compute
      Authorization code: https://accounts.google.com/o/oauth2/auth
      Token URL: https://accounts.google.com/o/oauth2/token scopes: https://www.googleapis.com/auth/compute
    • or OAuth 2 and OAuth 2
      Implicit: https://accounts.google.com/o/oauth2/auth
      Scopes: https://www.googleapis.com/auth/compute.readonly
      Authorization code: https://accounts.google.com/o/oauth2/auth
      Token URL: https://accounts.google.com/o/oauth2/token scopes: https://www.googleapis.com/auth/compute.readonly

Path parameters

projectstring required

Project ID for this request.

rolloutstring required

Name of the persistent rollout to return.

Response

Successful response

cancellationTimestring

Output only. The timestamp at which the Rollout was cancelled.

completionTimestring

Output only. The timestamp at which the Rollout was completed.

creationTimestampstring

Output only. [Output Only] Creation timestamp inRFC3339 text format.

currentWaveNumberstring int64

Output only. The number of the currently running wave. Ex. 1

descriptionstring

An optional description of this resource. Provide this property when you create the resource.

etagstring

Output only. etag of the Rollout Ex. abc1234

idstring uint64

Output only. [Output Only] The unique identifier for the resource. This identifier is defined by the server.

kindstring

Output only. [Output Only] Type of the resource. Always compute#rollout for rollouts.

namestring

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

pauseTimestring

Output only. The timestamp at which the Rollout was paused.

resumeTimestring

Output only. The timestamp at which the Rollout was resumed.

rolloutPlanstring

Required. Rollout Plan used to model the Rollout. Ex. compute.googleapis.com/v1/projects/1234/rolloutPlans/rp1

selfLinkstring

Output only. [Output Only] Server-defined fully-qualified URL for this resource.

selfLinkWithIdstring

Output only. [Output Only] Server-defined URL for this resource's resource id.

state'CANCELLED' | 'CANCELLING' | 'CANCEL_FAILED' | 'COMPLETED' | 'COMPLETE_FAILED' | 'COMPLETING' | 'FAILED' | 'PAUSED' | 'PAUSE_FAILED' | 'PAUSING' | 'PROCESSING' | 'READY' | 'RESUMING' | 'ROLLBACK_WAVE_FAILED' | 'ROLLING_BACK' | 'STATE_UNSPECIFIED' | 'UNINITIALIZED' | 'WAVE_FAILED'

Output only. The current state of the Rollout.

Changes

  • 8b85e897d3dcRevision changes
    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was added to the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was added to the endpoint's security scheme Oauth2c

    • info

      the security scope https://www.googleapis.com/auth/compute.readonly was removed from the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/compute.readonly was removed from the endpoint's security scheme Oauth2c

  • 48929bf89eebRevision changes
    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was added to the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was added to the endpoint's security scheme Oauth2c

    • info

      the security scope https://www.googleapis.com/auth/compute.readonly was removed from the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/compute.readonly was removed from the endpoint's security scheme Oauth2c