BareMetal API, REST: Server.Reinstall
Reinstalls the specified server.
HTTP request
POST https://baremetal.api.yandexcloud.kz/baremetal/v1alpha/servers/{serverId}:reinstall
Path parameters
|
Field |
Description |
|
serverId |
string Required field. ID of the server to reinstall. To get the server ID, use a ServerService.List request. |
Body parameters
{
"osSettingsSpec": {
"imageId": "string",
"storages": [
{
"partitions": [
{
"type": "string",
"sizeGib": "string",
"mountPoint": "string"
}
],
// Includes only one of the fields `disk`, `raid`
"disk": {
"id": "string",
"type": "string",
"sizeGib": "string"
},
"raid": {
"type": "string",
"disks": [
{
"id": "string",
"type": "string",
"sizeGib": "string"
}
]
}
// end of the list of possible fields
}
],
// Includes only one of the fields `sshPublicKey`, `userSshId`
"sshPublicKey": "string",
"userSshId": "string",
// end of the list of possible fields
// Includes only one of the fields `passwordPlainText`, `passwordLockboxSecret`
"passwordPlainText": "string",
"passwordLockboxSecret": {
"secretId": "string",
"versionId": "string",
"key": "string"
}
// end of the list of possible fields
}
}
|
Field |
Description |
|
osSettingsSpec |
Operating system specific settings for provisioning the server. |
OsSettingsSpec
|
Field |
Description |
|
imageId |
string ID of the image that the server was created from. |
|
storages[] |
List of storages to be created on the server. If not specified, the default value based on the |
|
sshPublicKey |
string Public SSH key for the server. Includes only one of the fields Root user SSH key. |
|
userSshId |
string ID of the user SSH key to use for the server. To get the user SSH key ID, use a yandex.cloud.organizationmanager.v1.UserSshKeyService.List request. Includes only one of the fields Root user SSH key. |
|
passwordPlainText |
string Raw password. Includes only one of the fields Password for the server. |
|
passwordLockboxSecret |
Reference to the Lockbox secret used to obtain the password. Includes only one of the fields Password for the server. |
Storage
Storage, a OS-level storage entity used for creating partitions. For example, this could
represent a plain disk or a software RAID of disks.
|
Field |
Description |
|
partitions[] |
Array of partitions created on the storage. |
|
disk |
Disk storage. Includes only one of the fields Storage type. |
|
raid |
RAID storage. Includes only one of the fields Storage type. |
StoragePartition
|
Field |
Description |
|
type |
enum (StoragePartitionType) Partition type.
|
|
sizeGib |
string (int64) Size of the storage partition in gibibytes (2^30 bytes). |
|
mountPoint |
string Storage mount point. |
Disk
Disk.
|
Field |
Description |
|
id |
string ID of the disk. |
|
type |
enum (DiskDriveType) Type of the disk drive.
|
|
sizeGib |
string (int64) Size of the disk in gibibytes (2^30 bytes). |
Raid
RAID storage.
|
Field |
Description |
|
type |
enum (RaidType) RAID type.
|
|
disks[] |
Array of disks in the RAID configuration. |
LockboxSecret
|
Field |
Description |
|
secretId |
string Required field. The unique identifier for the lockbox secret that contains the user password. |
|
versionId |
string The unique identifier for the lockbox version. |
|
key |
string Required field. The key used to access a specific secret entry. |
Response
HTTP Code: 200 - OK
{
"id": "string",
"description": "string",
"createdAt": "string",
"createdBy": "string",
"modifiedAt": "string",
"done": "boolean",
"metadata": {
"serverId": "string"
},
// Includes only one of the fields `error`
"error": {
"code": "integer",
"message": "string",
"details": [
"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 |
|
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 |
|
done |
boolean If the value is |
|
metadata |
Service-specific metadata associated with the operation. |
|
error |
The error result of the operation in case of failure or cancellation. Includes only one of the fields The operation result. |
ReinstallServerMetadata
|
Field |
Description |
|
serverId |
string ID of the Server resource that is being reinstalled. |
Status
The error result of the operation in case of failure or cancellation.
|
Field |
Description |
|
code |
integer (int32) Error code. An enum value of google.rpc.Code. |
|
message |
string An error message. |
|
details[] |
object A list of messages that carry the error details. |