- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- IAM Permissions
- Try it!
List inventory data for all VM instances in the specified zone.
HTTP request
GET https://osconfig.googleapis.com/v1/{parent=projects/*/locations/*/instances/*}/inventories
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
parent |
Required. The parent resource name. Format: For |
Query parameters
Parameters | |
---|---|
view |
Inventory view indicating what information should be included in the inventory resource. If unspecified, the default view is BASIC. |
pageSize |
The maximum number of results to return. |
pageToken |
A pagination token returned from a previous call to |
filter |
If provided, this field specifies the criteria that must be met by a |
Request body
The request body must be empty.
Response body
A response message for listing inventory data for all VMs in a specified location.
If successful, the response body contains data with the following structure:
JSON representation |
---|
{
"inventories": [
{
object ( |
Fields | |
---|---|
inventories[] |
List of inventory objects. |
nextPageToken |
The pagination token to retrieve the next page of inventory objects. |
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.inventories.list
For more information, see the IAM documentation.