Contact UsGet started
© 2024 Iron Hive LLC Belgrade

Managed Service for MongoDB API, gRPC: ClusterService.UpdateHosts

Written by
Updated at October 17, 2024

Updates the specified parameters for the host.

gRPC request

rpc UpdateHosts (UpdateClusterHostsRequest) returns (operation.Operation)

UpdateClusterHostsRequest

{
  "clusterId": "string",
  "updateHostSpecs": [
    {
      "hostName": "string",
      "hidden": "google.protobuf.BoolValue",
      "secondaryDelaySecs": "google.protobuf.Int64Value",
      "priority": "google.protobuf.DoubleValue",
      "assignPublicIp": "bool",
      "updateMask": "google.protobuf.FieldMask",
      "tags": "string"
    }
  ]
}

Field

Description

clusterId

string

Required field. ID of the MongoDB cluster to update hosts from.
To get the MongoDB cluster ID, use a ClusterService.List request.

updateHostSpecs[]

UpdateHostSpec

New configurations to apply to hosts of a Managed Service for MongoDB cluster.

UpdateHostSpec

Field

Description

hostName

string

Required field. Host to be updated. Specify the host FQDN.

hidden

google.protobuf.BoolValue

Determines if the host is a hidden replica set member.

Such members cannot become primary in a replica set, and they are invisible to client applications. However, hidden members can participate in elections of the primary host. For more information, see the MongoDB documentation.

secondaryDelaySecs

google.protobuf.Int64Value

The time, in seconds, by which the given replica set member lags behind the primary host.

priority

google.protobuf.DoubleValue

Priority of the host to be elected as the primary in the replica set.

The minimum value is 0 if the Managed Service for MongoDB cluster contains three or more secondary hosts. Otherwise, the minimum value is 1.

assignPublicIp

bool

Determines whether the host should get a public IP address after the update.

updateMask

google.protobuf.FieldMask

Field mask that specifies which fields of the MongoDB host should be updated.

tags

string

Host tag list that contains key-value pairs for the given replica set member. For more information about how to specify the tags and what values to choose, see the MongoDB documentation.

operation.Operation

{
  "id": "string",
  "description": "string",
  "createdAt": "google.protobuf.Timestamp",
  "createdBy": "string",
  "modifiedAt": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": {
    "clusterId": "string",
    "hostNames": [
      "string"
    ]
  },
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": "google.protobuf.Empty"
  // end of the list of possible fields
}

An Operation resource. For more information, see Operation.

Field

Description

id

string

ID of the operation.

description

string

Description of the operation. 0-256 characters long.

createdAt

google.protobuf.Timestamp

Creation timestamp.

createdBy

string

ID of the user or service account who initiated the operation.

modifiedAt

google.protobuf.Timestamp

The time when the Operation resource was last modified.

done

bool

If the value is false, it means the operation is still in progress.
If true, the operation is completed, and either error or response is available.

metadata

UpdateClusterHostsMetadata

Service-specific metadata associated with the operation.
It typically contains the ID of the target resource that the operation is performed on.
Any method that returns a long-running operation should document the metadata type, if any.

error

google.rpc.Status

The error result of the operation in case of failure or cancellation.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

response

google.protobuf.Empty

The normal response of the operation in case of success.
If the original method returns no data on success, such as Delete,
the response is google.protobuf.Empty.
If the original method is the standard Create/Update,
the response should be the target resource of the operation.
Any method that returns a long-running operation should document the response type, if any.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

UpdateClusterHostsMetadata

Field

Description

clusterId

string

ID of the MongoDB cluster to update host from.

hostNames[]

string

Name of host that are being updated.
Previous
DeleteHosts
Next
EnableSharding