BareMetal API, gRPC: StorageService.BatchGetDefault
Returns the default storages for the specified configurations.
gRPC request
rpc BatchGetDefault (BatchGetDefaultStoragesRequest) returns (BatchGetDefaultStoragesResponse)
BatchGetDefaultStoragesRequest
{
"configuration_ids": [
"string"
]
}
|
Field |
Description |
|
configuration_ids[] |
string List of configuration IDs. |
BatchGetDefaultStoragesResponse
{
"default_storages": [
{
"configuration_id": "string",
"storages": [
{
"partitions": [
{
"type": "StoragePartitionType",
"size_gib": "int64",
"mount_point": "string"
}
],
// Includes only one of the fields `disk`, `raid`
"disk": {
"id": "string",
"type": "DiskDriveType",
"size_gib": "int64"
},
"raid": {
"type": "RaidType",
"disks": [
{
"id": "string",
"type": "DiskDriveType",
"size_gib": "int64"
}
]
}
// end of the list of possible fields
}
]
}
]
}
|
Field |
Description |
|
default_storages[] |
List of default storages. |
DefaultStorage
|
Field |
Description |
|
configuration_id |
string ID of the configuration. To get the configuration ID, use a ConfigurationService.List request. |
|
storages[] |
List of default storages. |
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.
|
|
size_gib |
int64 Size of the storage partition in gibibytes (2^30 bytes). |
|
mount_point |
string Storage mount point. |
Disk
Disk.
|
Field |
Description |
|
id |
string ID of the disk. |
|
type |
enum DiskDriveType Type of the disk drive.
|
|
size_gib |
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. |