Method: regionMultiMigs.list

Retrieves a list of multi-MIGs in a project and region.

HTTP request

GET https://compute.googleapis.com/compute/beta/projects/{project}/regions/{region}/multiMigs

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
project

string

Project ID for this request.
region

string

Name of the region for this request.

Query parameters

Parameters
maxResults

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)
pageToken

string

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

string

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 =, !=, >, <, <=, >= or :.

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

The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use:

labels.owner:*

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)

If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples:

fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal")

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 name ne .*instance.

You cannot combine constraints on multiple fields using regular expressions.
orderBy

string

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.
returnPartialSuccess

boolean

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 
{
  "kind": string,
  "id": string,
  "items": [
    {
      "kind": string,
      "id": string,
      "creationTimestamp": string,
      "name": string,
      "description": string,
      "selfLink": string,
      "region": string,
      "resourcePolicies": {
        "workloadPolicy": string
      },
      "status": {
        "appliedAcceleratorTopologies": [
          {
            "acceleratorTopology": string,
            "acceleratorTopologyState": enum,
            "acceleratorTopologyStateLastCheck": {
              "timestamp": string,
              "error": {
                "errors": [
                  {
                    "code": string,
                    "location": string,
                    "message": string,
                    "errorDetails": [
                      {
                        "errorInfo": {
                          "reason": string,
                          "domain": string,
                          "metadatas": {
                            string: string,
                            ...
                          }
                        },
                        "quotaInfo": {
                          "metricName": string,
                          "limitName": string,
                          "dimensions": {
                            string: string,
                            ...
                          },
                          "limit": number,
                          "futureLimit": number,
                          "rolloutStatus": enum
                        },
                        "help": {
                          "links": [
                            {
                              "description": string,
                              "url": string
                            }
                          ]
                        },
                        "localizedMessage": {
                          "locale": string,
                          "message": string
                        }
                      }
                    ]
                  }
                ]
              }
            }
          }
        ]
      }
    }
  ],
  "nextPageToken": string,
  "selfLink": string,
  "warning": {
    "code": enum,
    "message": string,
    "data": [
      {
        "key": string,
        "value": string
      }
    ]
  }
}
Fields
kind

string

Type of resource.
id

string

Unique identifier for the resource; defined by the server.
items[]

object

A list of multi-MIGs in the specified project and region.
items[].kind

string

[Output only] Type of the resource. Always compute#multiMig for multi-MIGs.
items[].id

string (uint64 format)

[Output only] The unique identifier for this resource type. The server generates this identifier.
items[].creationTimestamp

string

[Output only] The creation timestamp of this multi-MIG in RFC3339 text format.
items[].name

string

The name of the multi-MIG. The name must be 1-63 characters long, and comply with RFC1035. 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.
items[].description

string

An optional description of this resource.
items[].selfLink

string

[Output only] Server-defined URL for the resource.
items[].region

string

[Output only] The URL of the region where the resource resides. You must specify this field as part of the HTTP request URL. You cannot set the region as a field in the request body.
items[].resourcePolicies

object

Resource policies for this multi-MIG.
items[].resourcePolicies.workloadPolicy

string

The URL of the workload policy for this multi-MIG. It can be a full or partial URL. For example, the following are all valid URLs to a workload policy:

items[].status

object
items[].status.appliedAcceleratorTopologies[]

object

[Output Only] The accelerator topology applied to this multi-MIG. Currently only one accelerator topology is supported.
items[].status.appliedAcceleratorTopologies[].acceleratorTopology

string

[Output Only] Topology in the format of: "16x16", "4x4x4", etc. The value is the same as configured in the WorkloadPolicy.
items[].status.appliedAcceleratorTopologies[].acceleratorTopologyState

enum

[Output Only] The state of the accelerator topology.
items[].status.appliedAcceleratorTopologies[].acceleratorTopologyStateLastCheck

object

[Output Only] The result of the latest accelerator topology state check.
items[].status.appliedAcceleratorTopologies[].acceleratorTopologyStateLastCheck.timestamp

string (Timestamp format)

[Output Only] Timestamp is shown only if there is an error. The field has // RFC3339 // text format.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
items[].status.appliedAcceleratorTopologies[].acceleratorTopologyStateLastCheck.error

object

[Output Only] Encountered errors on the last state check.
items[].status.appliedAcceleratorTopologies[].acceleratorTopologyStateLastCheck.error.errors[]

object

[Output Only] The array of errors encountered while processing this operation.
items[].status.appliedAcceleratorTopologies[].acceleratorTopologyStateLastCheck.error.errors[].code

string

[Output Only] The error type identifier for this error.
items[].status.appliedAcceleratorTopologies[].acceleratorTopologyStateLastCheck.error.errors[].location

string

[Output Only] Indicates the field in the request that caused the error. This property is optional.
items[].status.appliedAcceleratorTopologies[].acceleratorTopologyStateLastCheck.error.errors[].message

string

[Output Only] An optional, human-readable error message.
items[].status.appliedAcceleratorTopologies[].acceleratorTopologyStateLastCheck.error.errors[].errorDetails[]

object

[Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.
items[].status.appliedAcceleratorTopologies[].acceleratorTopologyStateLastCheck.error.errors[].errorDetails[].errorInfo

object
items[].status.appliedAcceleratorTopologies[].acceleratorTopologyStateLastCheck.error.errors[].errorDetails[].errorInfo.reason

string

The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of [A-Z][A-Z0-9_]+[A-Z0-9], which represents UPPER_SNAKE_CASE.
items[].status.appliedAcceleratorTopologies[].acceleratorTopologyStateLastCheck.error.errors[].errorDetails[].errorInfo.domain

string

The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".
items[].status.appliedAcceleratorTopologies[].acceleratorTopologyStateLastCheck.error.errors[].errorDetails[].errorInfo.metadatas

map (key: string, value: string)

Additional structured details about this error.

Keys must match a regular expression of [a-z][a-zA-Z0-9-_]+ but should ideally be lowerCamelCase. Also, they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than {"instanceLimit": "100/request"}, should be returned as, {"instanceLimitPerRequest": "100"}, if the client exceeds the number of instances that can be created in a single (batch) request.
items[].status.appliedAcceleratorTopologies[].acceleratorTopologyStateLastCheck.error.errors[].errorDetails[].quotaInfo

object
items[].status.appliedAcceleratorTopologies[].acceleratorTopologyStateLastCheck.error.errors[].errorDetails[].quotaInfo.metricName

string

The Compute Engine quota metric name.
items[].status.appliedAcceleratorTopologies[].acceleratorTopologyStateLastCheck.error.errors[].errorDetails[].quotaInfo.limitName

string

The name of the quota limit.
items[].status.appliedAcceleratorTopologies[].acceleratorTopologyStateLastCheck.error.errors[].errorDetails[].quotaInfo.dimensions

map (key: string, value: string)

The map holding related quota dimensions.
items[].status.appliedAcceleratorTopologies[].acceleratorTopologyStateLastCheck.error.errors[].errorDetails[].quotaInfo.limit

number

Current effective quota limit. The limit's unit depends on the quota type or metric.
items[].status.appliedAcceleratorTopologies[].acceleratorTopologyStateLastCheck.error.errors[].errorDetails[].quotaInfo.futureLimit

number

Future quota limit being rolled out. The limit's unit depends on the quota type or metric.
items[].status.appliedAcceleratorTopologies[].acceleratorTopologyStateLastCheck.error.errors[].errorDetails[].quotaInfo.rolloutStatus

enum

Rollout status of the future quota limit.
items[].status.appliedAcceleratorTopologies[].acceleratorTopologyStateLastCheck.error.errors[].errorDetails[].help

object
items[].status.appliedAcceleratorTopologies[].acceleratorTopologyStateLastCheck.error.errors[].errorDetails[].help.links[]

object

URL(s) pointing to additional information on handling the current error.
items[].status.appliedAcceleratorTopologies[].acceleratorTopologyStateLastCheck.error.errors[].errorDetails[].help.links[].description

string

Describes what the link offers.
items[].status.appliedAcceleratorTopologies[].acceleratorTopologyStateLastCheck.error.errors[].errorDetails[].help.links[].url

string

The URL of the link.
items[].status.appliedAcceleratorTopologies[].acceleratorTopologyStateLastCheck.error.errors[].errorDetails[].localizedMessage

object
items[].status.appliedAcceleratorTopologies[].acceleratorTopologyStateLastCheck.error.errors[].errorDetails[].localizedMessage.locale

string

The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX"
items[].status.appliedAcceleratorTopologies[].acceleratorTopologyStateLastCheck.error.errors[].errorDetails[].localizedMessage.message

string

The localized error message in the above locale.
nextPageToken

string

This token allows you to get the next page of results for 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.
warning

object

Informational warning message.
warning.code

enum

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

string

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

object

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

"data": [  {  "key": "scope",  "value": "zones/us-east1-d"  }
warning.data[].key

string

[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).
warning.data[].value

string

[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.

IAM Permissions

In addition to any permissions specified on the fields above, authorization requires one or more of the following IAM permissions:

  • compute.multiMig.list

To find predefined roles that contain those permissions, see Compute Engine IAM Roles.