Method 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
| Parameter | Description |
|---|---|
| clusterId | Required. ID of the ClickHouse cluster to add hosts to. To get the ClickHouse cluster ID, use a list request. The maximum string length in characters is 50. |
Body parameters
{
"hostSpecs": [
{
"zoneId": "string",
"type": "string",
"subnetId": "string",
"assignPublicIp": true,
"shardName": "string"
}
],
"copySchema": true
}
| Field | Description |
|---|---|
| hostSpecs[] | object Required. Configurations for ClickHouse hosts that should be added to the cluster. Must contain at least one element. |
| hostSpecs[]. zoneId |
string ID of the availability zone where the host resides. To get a list of available zones, use the list request. The maximum string length in characters is 50. |
| hostSpecs[]. type |
string Required. Type of the host to be deployed.
|
| hostSpecs[]. subnetId |
string ID of the subnet that the host should belong to. This subnet should be a part of the network that the cluster belongs to. The ID of the network is set in the Cluster.networkId field. The maximum string length in characters is 50. |
| hostSpecs[]. assignPublicIp |
boolean (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 a public IP to a host without one, recreate the host with Possible values:
|
| hostSpecs[]. shardName |
string Name of the shard that the host is assigned to. The maximum string length in characters is 63. Value must match the regular expression |
| copySchema | boolean (boolean) Whether to copy schema to new ClickHouse hosts from replicas. |
Response
HTTP Code: 200 - OK
{
"id": "string",
"description": "string",
"createdAt": "string",
"createdBy": "string",
"modifiedAt": "string",
"done": true,
"metadata": "object",
// includes only one of the fields `error`, `response`
"error": {
"code": "integer",
"message": "string",
"details": [
"object"
]
},
"response": "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 text format. |
| 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 text format. |
| done | boolean (boolean) If the value is |
| metadata | object 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 | object The error result of the operation in case of failure or cancellation. includes only one of the fields error, responseThe error result of the operation in case of failure or cancellation. |
| error. code |
integer (int32) Error code. An enum value of google.rpc.Code. |
| error. message |
string An error message. |
| error. details[] |
object A list of messages that carry the error details. |
| response | object includes only one of the fields error, responseThe 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. |