Managed Service for OpenSearch API, REST: Cluster.restore
Creates a new OpenSearch cluster using the specified backup.
HTTP request
POST https://mdb.api.cloud.yandex.net/managed-opensearch/v1/clusters:restore
Body parameters
{
"backupId": "string",
"name": "string",
"description": "string",
"labels": "object",
"environment": "string",
"configSpec": {
"version": "string",
"adminPassword": "string",
"opensearchSpec": {
"plugins": [
"string"
],
"nodeGroups": [
{
"name": "string",
"resources": {
"resourcePresetId": "string",
"diskSize": "string",
"diskTypeId": "string"
},
"hostsCount": "string",
"zoneIds": [
"string"
],
"subnetIds": [
"string"
],
"assignPublicIp": true,
"roles": [
"string"
],
"diskSizeAutoscaling": {
"plannedUsageThreshold": "string",
"emergencyUsageThreshold": "string",
"diskSizeLimit": "string"
}
}
],
"keystoreSettings": [
{
"name": "string",
"value": "string"
}
],
"opensearchConfig_2": {
"maxClauseCount": "integer",
"fielddataCacheSize": "string",
"reindexRemoteWhitelist": "string"
}
},
"dashboardsSpec": {
"nodeGroups": [
{
"name": "string",
"resources": {
"resourcePresetId": "string",
"diskSize": "string",
"diskTypeId": "string"
},
"hostsCount": "string",
"zoneIds": [
"string"
],
"subnetIds": [
"string"
],
"assignPublicIp": true,
"diskSizeAutoscaling": {
"plannedUsageThreshold": "string",
"emergencyUsageThreshold": "string",
"diskSizeLimit": "string"
}
}
]
},
"access": {
"dataTransfer": true,
"serverless": true
}
},
"networkId": "string",
"securityGroupIds": [
"string"
],
"serviceAccountId": "string",
"deletionProtection": true,
"folderId": "string",
"maintenanceWindow": {
// `maintenanceWindow` includes only one of the fields `anytime`, `weeklyMaintenanceWindow`
"anytime": {},
"weeklyMaintenanceWindow": {
"day": "string",
"hour": "string"
},
// end of the list of possible fields`maintenanceWindow`
}
}
Field | Description |
---|---|
backupId | string Required. ID of the backup to create a new cluster from. To get the backup ID, use a listBackups request. |
name | string Required. Name of the new OpenSearch cluster to be created from the backup. The name must be unique within the folder. The maximum string length in characters is 63. Value must match the regular expression |
description | string Description of the new OpenSearch cluster to be created from the backup. The maximum string length in characters is 256. |
labels | object Custom labels for the new OpenSearch cluster to be created from the backup as No more than 64 per resource. The string length in characters for each key must be 1-63. Each key must match the regular expression |
environment | string Deployment environment of the new OpenSearch cluster to be created from the backup.
|
configSpec | object Required. Configuration for the new OpenSearch cluster to be created from the backup. |
configSpec. version |
string OpenSearch version. |
configSpec. adminPassword |
string Required. OpenSearch admin password. |
configSpec. opensearchSpec |
object OpenSearch configuration. OpenSearch create-time configuration. |
configSpec. opensearchSpec. plugins[] |
string Names of the cluster plugins. |
configSpec. opensearchSpec. nodeGroups[] |
object OpenSearch type host groups of the cluster. |
configSpec. opensearchSpec. nodeGroups[]. name |
string Required. Name of the group. The maximum string length in characters is 63. Value must match the regular expression |
configSpec. opensearchSpec. nodeGroups[]. resources |
object Resources allocated to the hosts. A list of computational resources allocated to a host. |
configSpec. opensearchSpec. nodeGroups[]. resources. resourcePresetId |
string ID of the preset for computational resources allocated to a host. |
configSpec. opensearchSpec. nodeGroups[]. resources. diskSize |
string (int64) Volume of the storage used by the host, in bytes. |
configSpec. opensearchSpec. nodeGroups[]. resources. diskTypeId |
string Type of the storage used by the host: |
configSpec. opensearchSpec. nodeGroups[]. hostsCount |
string (int64) Number of hosts in the group. The minimum value is 1. |
configSpec. opensearchSpec. nodeGroups[]. zoneIds[] |
string IDs of the availability zones the hosts belong to. The maximum number of elements is 10. The maximum string length in characters for each value is 50. |
configSpec. opensearchSpec. nodeGroups[]. subnetIds[] |
string IDs of the subnets that the hosts belong to. The maximum number of elements is 10. The maximum string length in characters for each value is 50. |
configSpec. opensearchSpec. nodeGroups[]. assignPublicIp |
boolean (boolean) Determines whether a public IP is assigned to the hosts in the group. |
configSpec. opensearchSpec. nodeGroups[]. roles[] |
string Roles of the hosts in the group. |
configSpec. opensearchSpec. nodeGroups[]. diskSizeAutoscaling |
object Disk size autoscaling settings |
configSpec. opensearchSpec. nodeGroups[]. diskSizeAutoscaling. plannedUsageThreshold |
string (int64) Amount of used storage for automatic disk scaling in the maintenance window, 0 means disabled, in percent. Acceptable values are 0 to 100, inclusive. |
configSpec. opensearchSpec. nodeGroups[]. diskSizeAutoscaling. emergencyUsageThreshold |
string (int64) Amount of used storage for immediately automatic disk scaling, 0 means disabled, in percent. Acceptable values are 0 to 100, inclusive. |
configSpec. opensearchSpec. nodeGroups[]. diskSizeAutoscaling. diskSizeLimit |
string (int64) Limit on how large the storage for database instances can automatically grow, in bytes. |
configSpec. opensearchSpec. keystoreSettings[] |
object Initial cluster keystore settings. |
configSpec. opensearchSpec. keystoreSettings[]. name |
string Keystore entry name. |
configSpec. opensearchSpec. keystoreSettings[]. value |
string Keystore entry value. |
configSpec. opensearchSpec. opensearchConfig_2 |
object |
configSpec. opensearchSpec. opensearchConfig_2. maxClauseCount |
integer (int64) the maximum number of allowed boolean clauses in a query |
configSpec. opensearchSpec. opensearchConfig_2. fielddataCacheSize |
string the percentage or absolute value (10%, 512mb) of heap space that is allocated to fielddata |
configSpec. opensearchSpec. opensearchConfig_2. reindexRemoteWhitelist |
string |
configSpec. dashboardsSpec |
object Dashboards configuration. Dashboards create-time configuration. |
configSpec. dashboardsSpec. nodeGroups[] |
object Dashboards type host groups of the cluster. |
configSpec. dashboardsSpec. nodeGroups[]. name |
string Required. Name of the group. The maximum string length in characters is 63. Value must match the regular expression |
configSpec. dashboardsSpec. nodeGroups[]. resources |
object Resources allocated to the hosts. A list of computational resources allocated to a host. |
configSpec. dashboardsSpec. nodeGroups[]. resources. resourcePresetId |
string ID of the preset for computational resources allocated to a host. |
configSpec. dashboardsSpec. nodeGroups[]. resources. diskSize |
string (int64) Volume of the storage used by the host, in bytes. |
configSpec. dashboardsSpec. nodeGroups[]. resources. diskTypeId |
string Type of the storage used by the host: |
configSpec. dashboardsSpec. nodeGroups[]. hostsCount |
string (int64) Number of hosts in the group. The minimum value is 1. |
configSpec. dashboardsSpec. nodeGroups[]. zoneIds[] |
string IDs of the availability zones the hosts belong to. |
configSpec. dashboardsSpec. nodeGroups[]. subnetIds[] |
string IDs of the subnets that the hosts belong to. The maximum number of elements is 10. The maximum string length in characters for each value is 50. |
configSpec. dashboardsSpec. nodeGroups[]. assignPublicIp |
boolean (boolean) Determines whether a public IP is assigned to the hosts in the group. |
configSpec. dashboardsSpec. nodeGroups[]. diskSizeAutoscaling |
object Disk size autoscaling settings |
configSpec. dashboardsSpec. nodeGroups[]. diskSizeAutoscaling. plannedUsageThreshold |
string (int64) Amount of used storage for automatic disk scaling in the maintenance window, 0 means disabled, in percent. Acceptable values are 0 to 100, inclusive. |
configSpec. dashboardsSpec. nodeGroups[]. diskSizeAutoscaling. emergencyUsageThreshold |
string (int64) Amount of used storage for immediately automatic disk scaling, 0 means disabled, in percent. Acceptable values are 0 to 100, inclusive. |
configSpec. dashboardsSpec. nodeGroups[]. diskSizeAutoscaling. diskSizeLimit |
string (int64) Limit on how large the storage for database instances can automatically grow, in bytes. |
configSpec. access |
object Access policy for external services. Access policy for external services. |
configSpec. access. dataTransfer |
boolean (boolean) Determines whether the access to Data Transfer is allowed. |
configSpec. access. serverless |
boolean (boolean) Determines whether the access to Serverless is allowed. |
networkId | string Required. ID of the network to create the cluster in. The maximum string length in characters is 50. |
securityGroupIds[] | string User security groups. |
serviceAccountId | string ID of the service account used to access Object Storage. |
deletionProtection | boolean (boolean) Determines whether the cluster is protected from being deleted. |
folderId | string Required. ID of the folder to create the OpenSearch cluster in. To get the folder ID, use a list request. The maximum string length in characters is 50. |
maintenanceWindow | object Cluster maintenance window. Should be defined by either one of the two options. An OpenSearch cluster maintenance window. Should be defined by either one of the two options. |
maintenanceWindow. anytime |
object An any-time maintenance window. maintenanceWindow includes only one of the fields anytime , weeklyMaintenanceWindow |
maintenanceWindow. weeklyMaintenanceWindow |
object A weekly maintenance window. maintenanceWindow includes only one of the fields anytime , weeklyMaintenanceWindow |
maintenanceWindow. weeklyMaintenanceWindow. day |
string Day of the week.
|
maintenanceWindow. weeklyMaintenanceWindow. hour |
string (int64) Hour of the day in the UTC timezone. Acceptable values are 1 to 24, 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. |