Managed Service for MongoDB API, REST: Cluster.updateHosts
Updates the specified parameters for the host.
HTTP request
POST https://mdb.api.cloud.yandex.net/managed-mongodb/v1/clusters/{clusterId}/hosts:batchUpdate
Path parameters
Parameter | Description |
---|---|
clusterId | Required. ID of the MongoDB cluster to update hosts from. To get the MongoDB cluster ID, use a list request. The maximum string length in characters is 50. |
Body parameters
{
"updateHostSpecs": [
{
"hostName": "string",
"hidden": true,
"secondaryDelaySecs": "integer",
"priority": "number",
"assignPublicIp": true,
"updateMask": "string",
"tags": "object"
}
]
}
Field | Description |
---|---|
updateHostSpecs[] | object Required. New configurations to apply to hosts of a Managed Service for MongoDB cluster. Must contain at least one element. |
updateHostSpecs[]. hostName |
string Required. Host to be updated. Specify the host FQDN. The maximum string length in characters is 253. |
updateHostSpecs[]. hidden |
boolean (boolean) 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. |
updateHostSpecs[]. secondaryDelaySecs |
integer (int64) The time, in seconds, by which the given replica set member lags behind the primary host. |
updateHostSpecs[]. priority |
number (double) Priority of the host to be elected as the primary in the replica set. The minimum value is |
updateHostSpecs[]. assignPublicIp |
boolean (boolean) Determines whether the host should get a public IP address after the update. |
updateHostSpecs[]. updateMask |
string Field mask that specifies which fields of the MongoDB host should be updated. A comma-separated names off ALL fields to be updated. Only the specified fields will be changed. The others will be left untouched. If the field is specified in If |
updateHostSpecs[]. tags |
object 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. |
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. |