Method: projects.patchJobs.instanceDetails.list

Get a list of instance details for a given patch job.

HTTP request

GET https://osconfig.googleapis.com/v1beta/{parent=projects/*/patchJobs/*}/instanceDetails

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The parent for the instances are in the form of projects/*/patchJobs/* .

Query parameters

Parameters
pageSize

integer

The maximum number of instance details records to return. Default is 100.

pageToken

string

A pagination token returned from a previous call that indicates where this listing should continue from.

filter

string

A filter expression that filters results listed in the response. This field supports filtering results by instance zone, name, state, or failureReason .

Request body

The request body must be empty.

Response body

A response message for listing the instances details for a patch job.

If successful, the response body contains data with the following structure:

JSON representation
 { 
 "patchJobInstanceDetails" 
 : 
 [ 
 { 
 object (  PatchJobInstanceDetails 
 
) 
 } 
 ] 
 , 
 "nextPageToken" 
 : 
 string 
 } 
Fields
patchJobInstanceDetails[]

object ( PatchJobInstanceDetails )

A list of instance status.

nextPageToken

string

A pagination token that can be used to get the next page of results.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview .

IAM Permissions

Requires the following IAM permission on the parent resource:

  • osconfig.patchJobs.get

For more information, see the IAM documentation .

Create a Mobile Website
View Site in Mobile | Classic
Share by: