Managed Service for MySQL API, REST: Cluster.addHosts
Adds new hosts in a cluster.
HTTP request
POST https://mdb.api.cloud.yandex.net/managed-mysql/v1/clusters/{clusterId}/hosts:batchCreate
Path parameters
Parameter | Description |
---|---|
clusterId | Required. ID of the cluster to add hosts to. To get this ID, make a list request. The maximum string length in characters is 50. |
Body parameters
{
"hostSpecs": [
{
"zoneId": "string",
"subnetId": "string",
"assignPublicIp": true,
"replicationSource": "string",
"backupPriority": "string",
"priority": "string"
}
]
}
Field | Description |
---|---|
hostSpecs[] | object Required. Configuration of the newly added hosts. 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, make the list request. The maximum string length in characters is 50. |
hostSpecs[]. subnetId |
string ID of the subnet to assign to the host. This subnet should be a part of the cluster network (the network ID is specified in the [ClusterService.CreateClusterRequest.network_id]). The maximum string length in characters is 50. |
hostSpecs[]. assignPublicIp |
boolean (boolean) Option that enables public IP address for the host so that the host can be accessed from the internet. After a host has been created, this setting cannot be changed. To remove an assigned public IP address, or to assign a public IP address to a host without one, recreate the host with the appropriate Possible values:
|
hostSpecs[]. replicationSource |
string
|
hostSpecs[]. backupPriority |
string (int64) Host backup priority Acceptable values are 0 to 100, inclusive. |
hostSpecs[]. priority |
string (int64) Host master promotion priority Acceptable values are 0 to 100, inclusive. |
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. The range of possible values is from To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). |
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. The range of possible values is from To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). |
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 , response |
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 , response 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. |