Managed Service for ClickHouse API, REST: Cluster.AddHosts
Creates new hosts for a cluster.
HTTP request
POST https://mdb.api.cloud.yandex.net/managed-clickhouse/v1/clusters/{clusterId}/hosts:batchCreate
Path parameters
Field |
Description |
clusterId |
string Required field. ID of the ClickHouse cluster to add hosts to. |
Body parameters
{
"hostSpecs": [
{
"zoneId": "string",
"type": "string",
"subnetId": "string",
"assignPublicIp": "boolean",
"shardName": "string"
}
],
"copySchema": "boolean"
}
Field |
Description |
hostSpecs[] |
Configurations for ClickHouse hosts that should be added to the cluster. |
copySchema |
boolean Whether to copy schema to new ClickHouse hosts from replicas. |
HostSpec
Field |
Description |
zoneId |
string ID of the availability zone where the host resides. |
type |
enum (Type) Required field. Type of the host to be deployed.
|
subnetId |
string ID of the subnet that the host should belong to. This subnet should be a part |
assignPublicIp |
boolean Whether the host should get a public IP address on creation. After a host has been created, this setting cannot be changed. To remove an assigned public IP, or to assign Possible values:
|
shardName |
string Name of the shard that the host is assigned to. |
Response
HTTP Code: 200 - OK
{
"id": "string",
"description": "string",
"createdAt": "string",
"createdBy": "string",
"modifiedAt": "string",
"done": "boolean",
"metadata": {
"clusterId": "string",
"hostNames": [
"string"
]
},
// Includes only one of the fields `error`
"error": {
"code": "integer",
"message": "string",
"details": [
"object"
]
}
// 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 |
string (date-time) Creation timestamp. String in RFC3339 To work with values in this field, use the APIs described in the |
createdBy |
string ID of the user or service account who initiated the operation. |
modifiedAt |
string (date-time) The time when the Operation resource was last modified. String in RFC3339 To work with values in this field, use the APIs described in the |
done |
boolean If the value is |
metadata |
Service-specific metadata associated with the operation. |
error |
The error result of the operation in case of failure or cancellation. Includes only one of the fields The operation result. |
AddClusterHostsMetadata
Field |
Description |
clusterId |
string ID of the ClickHouse cluster to which the hosts are being added. |
hostNames[] |
string Names of hosts that are being added to the cluster. |
Status
The error result of the operation in case of failure or cancellation.
Field |
Description |
code |
integer (int32) Error code. An enum value of google.rpc.Code |
message |
string An error message. |
details[] |
object A list of messages that carry the error details. |