- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- Try it!
Lists all of the per-instance configurations defined for the managed instance group. The orderBy
query parameter is not supported.
HTTP request
POST https://compute.googleapis.com/compute/v1/projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/listPerInstanceConfigs
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
project |
Project ID for this request. |
zone |
The name of the zone where the managed instance group is located. It should conform to RFC1035. |
instanceGroupManager |
The name of the managed instance group. It should conform to RFC1035. Authorization requires the following IAM permission on the specified resource
|
Query parameters
Parameters | |
---|---|
maxResults |
The maximum number of results per page that should be returned. If the number of available results is larger than |
pageToken |
Specifies a page token to use. Set |
filter |
A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either For example, if you are filtering Compute Engine instances, you can exclude instances named The
You can also filter nested fields. For example, you could specify To filter on multiple expressions, provide each separate expression within parentheses. For example:
By default, each expression is an
If you want to use a regular expression, use the
The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use You cannot combine constraints on multiple fields using regular expressions. |
orderBy |
Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using Currently, only sorting by |
returnPartialSuccess |
Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. |
Request body
The request body must be empty.
Response body
If successful, the response body contains data with the following structure:
JSON representation |
---|
{ "items": [ { "name": string, "preservedState": { "disks": { string: { "source": string, "mode": enum, "autoDelete": enum }, ... }, "metadata": { string: string, ... }, "internalIPs": { string: { "autoDelete": enum, "ipAddress": { "literal": string, "address": string } }, ... }, "externalIPs": { string: { "autoDelete": enum, "ipAddress": { "literal": string, "address": string } }, ... } }, "status": enum, "fingerprint": string } ], "nextPageToken": string, "warning": { "code": enum, "message": string, "data": [ { "key": string, "value": string } ] } } |
Fields | |
---|---|
items[] |
[Output Only] The list of PerInstanceConfig. |
items[].name |
The name of a per-instance configuration and its corresponding instance. Serves as a merge key during |
items[].preservedState |
The intended preserved state for the given instance. Does not contain preserved state generated from a stateful policy. |
items[].preservedState.disks[] |
Preserved disks defined for this instance. This map is keyed with the device names of the disks. |
items[].preservedState.disks[].source |
The URL of the disk resource that is stateful and should be attached to the VM instance. |
items[].preservedState.disks[].mode |
The mode in which to attach this disk, either |
items[].preservedState.disks[].autoDelete |
These stateful disks will never be deleted during autohealing, update, instance recreate operations. This flag is used to configure if the disk should be deleted after it is no longer used by the group, e.g. when the given instance or the whole MIG is deleted. Note: disks attached in |
items[].preservedState.metadata |
Preserved metadata defined for this instance. |
items[].preservedState.internalIPs[] |
Preserved internal IPs defined for this instance. This map is keyed with the name of the network interface. |
items[].preservedState.internalIPs[].autoDelete |
These stateful IPs will never be released during autohealing, update or VM instance recreate operations. This flag is used to configure if the IP reservation should be deleted after it is no longer used by the group, e.g. when the given instance or the whole group is deleted. |
items[].preservedState.internalIPs[].ipAddress |
Ip address representation |
items[].preservedState.internalIPs[].ipAddress.literal |
An IPv4 internal network address to assign to the instance for this network interface. |
items[].preservedState.internalIPs[].ipAddress.address |
The URL of the reservation for this IP address. |
items[].preservedState.externalIPs[] |
Preserved external IPs defined for this instance. This map is keyed with the name of the network interface. |
items[].preservedState.externalIPs[].autoDelete |
These stateful IPs will never be released during autohealing, update or VM instance recreate operations. This flag is used to configure if the IP reservation should be deleted after it is no longer used by the group, e.g. when the given instance or the whole group is deleted. |
items[].preservedState.externalIPs[].ipAddress |
Ip address representation |
items[].preservedState.externalIPs[].ipAddress.literal |
An IPv4 internal network address to assign to the instance for this network interface. |
items[].preservedState.externalIPs[].ipAddress.address |
The URL of the reservation for this IP address. |
items[].status |
The status of applying this per-instance configuration on the corresponding managed instance. |
items[].fingerprint |
Fingerprint of this per-instance config. This field can be used in optimistic locking. It is ignored when inserting a per-instance config. An up-to-date fingerprint must be provided in order to update an existing per-instance configuration or the field needs to be unset. A base64-encoded string. |
nextPageToken |
[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than |
warning |
[Output Only] Informational warning message. |
warning.code |
[Output Only] A warning code, if applicable. For example, Compute Engine returns |
warning.message |
[Output Only] A human-readable description of the warning code. |
warning.data[] |
[Output Only] Metadata about this warning in "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
warning.data[].key |
[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be |
warning.data[].value |
[Output Only] A warning data value corresponding to the key. |
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/compute.readonly
https://www.googleapis.com/auth/compute
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.