Method: regionInstanceGroupManagers.listPerInstanceConfigs

Lists all of the per-instance configs defined for the managed instance group. The orderBy query parameter is not supported.

HTTP request


The URL uses gRPC Transcoding syntax.

Path parameters



Project ID for this request.



Name of the region scoping this request, should conform to RFC1035.



The name of the managed instance group. It should conform to RFC1035.

Authorization requires the following IAM permission on the specified resource instanceGroupManager:

  • compute.instanceGroupManagers.get

Query parameters


integer (uint32 format)

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)



Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.



A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example:

(scheduling.automaticRestart = true)
(cpuPlatform = "Intel Skylake")

By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example:

(cpuPlatform = "Intel Skylake") OR
(cpuPlatform = "Intel Broadwell") AND
(scheduling.automaticRestart = true)


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 orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.



Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.

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,
      "status": enum,
      "fingerprint": string
  "nextPageToken": string,
  "warning": {
    "code": enum,
    "message": string,
    "data": [
        "key": string,
        "value": string


[Output Only] The list of PerInstanceConfig.



The name of a per-instance config and its corresponding instance. Serves as a merge key during instanceGroupManagers.updatePerInstanceConfigs operations, that is, if a per-instance config with the same name exists then it will be updated, otherwise a new one will be created for the VM instance with the same name. An attempt to create a per-instance config for a VM instance that either doesn't exist or is not part of the group will result in an error.



The intended preserved state for the given instance. Does not contain preserved state generated from a stateful policy.


map (key: string, value: object)

Preserved disks defined for this instance. This map is keyed with the device names of the disks.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.



The URL of the disk resource that is stateful and should be attached to the VM instance.



The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.



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 READ_ONLY mode cannot be auto-deleted.


map (key: string, value: string)

Preserved metadata defined for this instance.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.



The status of applying this per-instance config on the corresponding managed instance.


string (bytes format)

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 config or the field needs to be unset.

A base64-encoded string.



[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.



[Output Only] Informational warning message.



[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.



[Output Only] A human-readable description of the warning code.[]


[Output Only] Metadata about this warning in key: value format. For example:

"data": [  {  "key": "scope",  "value": "zones/us-east1-d"  }[].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 scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).[].value


[Output Only] A warning data value corresponding to the key.

Authorization Scopes

Requires one of the following OAuth scopes:


For more information, see the Authentication Overview.