Managed Service for Greenplum® API, REST: Cluster.restore
Creates a new Greenplum® cluster using the specified backup.
HTTP request
POST https://mdb.api.cloud.yandex.net/managed-greenplum/v1/clusters:restore
Body parameters
{
"backupId": "string",
"time": "string",
"folderId": "string",
"name": "string",
"description": "string",
"labels": "object",
"environment": "string",
"config": {
"backupWindowStart": {
"hours": "integer",
"minutes": "integer",
"seconds": "integer",
"nanos": "integer"
},
"access": {
"dataLens": true,
"webSql": true,
"dataTransfer": true
},
"zoneId": "string",
"subnetId": "string",
"assignPublicIp": true
},
"masterResources": {
"resourcePresetId": "string",
"diskSize": "string",
"diskTypeId": "string"
},
"segmentResources": {
"resourcePresetId": "string",
"diskSize": "string",
"diskTypeId": "string"
},
"networkId": "string",
"securityGroupIds": [
"string"
],
"deletionProtection": true,
"hostGroupIds": [
"string"
],
"placementGroupId": "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`
},
"segmentHostCount": "string",
"segmentInHost": "string",
"restoreOnly": [
"string"
]
}
Field | Description |
---|---|
backupId | string Required. ID of the backup to create a cluster from. To get the backup ID, use a listBackups request. |
time | string (date-time) Timestamp of the moment to which the Greenplum cluster should be restored. 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). |
folderId | string Required. ID of the folder to create the Greenplum® cluster in. The maximum string length in characters is 50. |
name | string Required. Name of the Greenplum® cluster. 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 Greenplum® cluster. The maximum string length in characters is 256. |
labels | object Custom labels for the Greenplum® cluster as No more than 64 per resource. The maximum string length in characters for each key is 63. Each key must match the regular expression |
environment | string Required. Deployment environment of the Greenplum® cluster.
|
config | object Greenplum® cluster config. |
config. backupWindowStart |
object Time to start the daily backup, in the UTC timezone. Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and google.protobuf.Timestamp. |
config. backupWindowStart. hours |
integer (int32) Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. |
config. backupWindowStart. minutes |
integer (int32) Minutes of hour of day. Must be from 0 to 59. |
config. backupWindowStart. seconds |
integer (int32) Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. |
config. backupWindowStart. nanos |
integer (int32) Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. |
config. access |
object Access policy for external services. |
config. access. dataLens |
boolean (boolean) Allows data export from the cluster to DataLens. |
config. access. webSql |
boolean (boolean) Allows SQL queries to the cluster databases from the management console. |
config. access. dataTransfer |
boolean (boolean) Allows access for DataTransfer. |
config. 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. |
config. 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 field Cluster.networkId. The maximum string length in characters is 50. |
config. assignPublicIp |
boolean (boolean) Determines 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:
|
masterResources | object Resources of the Greenplum® master subcluster. |
masterResources. resourcePresetId |
string ID of the preset for computational resources allocated to a host. Available presets are listed in the documentation. |
masterResources. diskSize |
string (int64) Volume of the storage used by the host, in bytes. |
masterResources. diskTypeId |
string Type of the storage used by the host: |
segmentResources | object Resources of the Greenplum® segment subcluster. |
segmentResources. resourcePresetId |
string ID of the preset for computational resources allocated to a host. Available presets are listed in the documentation. |
segmentResources. diskSize |
string (int64) Volume of the storage used by the host, in bytes. |
segmentResources. diskTypeId |
string Type of the storage used by the host: |
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. |
deletionProtection | boolean (boolean) Determines whether the cluster is protected from being deleted. |
hostGroupIds[] | string Host groups to place VMs of cluster on. |
placementGroupId | string ID of the placement group. |
maintenanceWindow | object A Greenplum® 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. |
segmentHostCount | string (int64) Number of segment hosts |
segmentInHost | string (int64) Number of segments on each host |
restoreOnly[] | string List of databases and tables to restore The maximum number of elements is 50. The maximum string length in characters for each value is 256. Each value must match the regular expression |
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. |