GoogleApi.Compute.V1.Api.InstanceGroupManagers.compute_instance_group_managers_list_managed_instances

You're seeing just the function compute_instance_group_managers_list_managed_instances, go back to GoogleApi.Compute.V1.Api.InstanceGroupManagers module for more information.
Link to this function

compute_instance_group_managers_list_managed_instances(connection, project, zone, instance_group_manager, optional_params \\ [], opts \\ [])

View Source

Specs

compute_instance_group_managers_list_managed_instances(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.Compute.V1.Model.InstanceGroupManagersListManagedInstancesResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists all of the instances in the managed instance group. Each instance in the list has a currentAction, which indicates the action that the managed instance group is performing on the instance. For example, if the group is still creating an instance, the currentAction is CREATING. If a previous action failed, the list displays the errors for that failed action. The orderBy query parameter is not supported.

Parameters

  • connection (type: GoogleApi.Compute.V1.Connection.t) - Connection to server

  • project (type: String.t) - Project ID for this request.

  • zone (type: String.t) - The name of the zone where the managed instance group is located.

  • instance_group_manager (type: String.t) - The name of the managed instance group.

  • optional_params (type: keyword()) - Optional parameters

    • :alt (type: String.t) - Data format for the response.

    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.

    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.

    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.

    • :quotaUser (type: String.t) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.

    • :filter (type: String.t) - 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)

    • :maxResults (type: integer()) - 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)

    • :orderBy (type: String.t) - 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.

    • :pageToken (type: String.t) - Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

    • :returnPartialSuccess (type: boolean()) - Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.

  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Compute.V1.Model.InstanceGroupManagersListManagedInstancesResponse{}} on success
  • {:error, info} on failure