Contact UsGet started
© 2024 Iron Hive LLC Belgrade

Managed Service for ClickHouse API, gRPC: ClusterService.UpdateHosts

Written by
Updated at October 17, 2024

Updates the specified hosts.

gRPC request

rpc UpdateHosts (UpdateClusterHostsRequest) returns (operation.Operation)

UpdateClusterHostsRequest

{
  "clusterId": "string",
  "updateHostSpecs": [
    {
      "hostName": "string",
      "updateMask": "google.protobuf.FieldMask",
      "assignPublicIp": "google.protobuf.BoolValue"
    }
  ]
}

Field

Description

clusterId

string

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

updateHostSpecs[]

UpdateHostSpec

New configurations to apply to hosts.

UpdateHostSpec

Field

Description

hostName

string

Required field. Name of the host to update.
To get the ClickHouse host name, use a ClusterService.ListHosts request.

updateMask

google.protobuf.FieldMask

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

assignPublicIp

google.protobuf.BoolValue

Whether the host should get a public IP address on creation.

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 ClickHouse cluster to modify hosts in.

hostNames[]

string

Names of hosts that are being modified.
Previous
AddHosts
Next
DeleteHosts