platform.v1.StorageService
- Request:
CreateVolumeRequest
- Response:
Operation
- REST mapping:
POST /v1/volumes
- Request:
GetVolumeRequest
- Response:
Volume
- REST mapping:
GET /v1/volumes/{id}
- Request:
ListVolumesRequest
- Response:
ListVolumesResponse
- REST mapping:
GET /v1/volumes
- Request:
AttachVolumeRequest
- Response:
Operation
- REST mapping:
POST /v1/volumes/{id}:attach
- Request:
DetachVolumeRequest
- Response:
Operation
- REST mapping:
POST /v1/volumes/{id}:detach
- Request:
ModifyVolumeRequest
- Response:
Operation
- REST mapping:
POST /v1/volumes/{id}:modify
- Request:
DeleteVolumeRequest
- Response:
Operation
- REST mapping:
DELETE /v1/volumes/{id}
- Request:
CreateSnapshotRequest
- Response:
Operation
- REST mapping:
POST /v1/snapshots
- Request:
ListSnapshotsRequest
- Response:
ListSnapshotsResponse
- REST mapping:
GET /v1/snapshots
- Request:
GetSnapshotRequest
- Response:
Snapshot
- REST mapping:
GET /v1/snapshots/{id}
- Request:
DeleteSnapshotRequest
- Response:
Operation
- REST mapping:
DELETE /v1/snapshots/{id}
- Request:
RestoreVolumeFromSnapshotRequest
- Response:
Operation
- REST mapping:
POST /v1/snapshots/{id}:restore
- Request:
CreateVolumeFromSnapshotRequest
- Response:
Operation
- REST mapping:
POST /v1/snapshots/{id}:createVolume
---- Phase 6: volume backup policies (schedule + retention) ----
- Request:
CreateBackupPolicyRequest
- Response:
BackupPolicy
- REST mapping:
POST /v1/backup-policies
- Request:
ListBackupPoliciesRequest
- Response:
ListBackupPoliciesResponse
- REST mapping:
GET /v1/backup-policies
- Request:
GetBackupPolicyRequest
- Response:
BackupPolicy
- REST mapping:
GET /v1/backup-policies/{id}
- Request:
UpdateBackupPolicyRequest
- Response:
BackupPolicy
- REST mapping:
PATCH /v1/backup-policies/{id}
- Request:
DeleteBackupPolicyRequest
- Response:
BackupPolicy
- REST mapping:
DELETE /v1/backup-policies/{id}
- Request:
RunBackupPolicyRequest
- Response:
Operation
- REST mapping:
POST /v1/backup-policies/{id}:run
AttachVolumeRequest performs the “Switch Volume” operation.
| Field | Type | # | Notes |
|---|
id | string | 1 | |
instance_id | string | 2 | |
BackupPolicy schedules retained snapshots of a volume (Phase 6). A backup is just a snapshot with origin=backup; the policy owns cadence + retention.
| Field | Type | # | Notes |
|---|
id | string | 1 | bpol_… |
name | string | 2 | |
app | string | 3 | |
org | string | 4 | |
source_volume | string | 5 | volume id to back up |
provider | string | 6 | |
schedule | string | 7 | hourly | daily | weekly | “@every <dur>” |
retention_keep | int32 | 8 | keep N most recent backups (0 = unlimited) |
retention_days | int32 | 9 | expire backups older than N days (0 = no expiry) |
enabled | bool | 10 | |
| Field | Type | # | Notes |
|---|
name | string | 1 | |
source_volume_id | string | 2 | |
schedule | string | 3 | |
retention_keep | int32 | 4 | |
retention_days | int32 | 5 | |
enabled | bool | 6 | |
| Field | Type | # | Notes |
|---|
source_volume_id | string | 1 | |
source_instance_id | string | 2 | |
description | string | 3 | |
name | string | 4 | |
| Field | Type | # | Notes |
|---|
id | string | 1 | snapshot id |
name | string | 2 | new volume name |
| Field | Type | # | Notes |
|---|
volume | Volume | 1 | |
| Field | Type | # | Notes |
|---|
id | string | 1 | |
force | bool | 2 | |
| Field | Type | # | Notes |
|---|
page | PageRequest | 1 | |
| Field | Type | # | Notes |
|---|
policies | BackupPolicy | 1 | |
meta | ListMeta | 2 | |
| Field | Type | # | Notes |
|---|
page | PageRequest | 1 | |
| Field | Type | # | Notes |
|---|
snapshots | Snapshot | 1 | |
meta | ListMeta | 2 | |
| Field | Type | # | Notes |
|---|
page | PageRequest | 1 | |
| Field | Type | # | Notes |
|---|
volumes | Volume | 1 | |
meta | ListMeta | 2 | |
| Field | Type | # | Notes |
|---|
id | string | 1 | |
size_gb | int64 | 2 | |
type | string | 3 | |
iops | int32 | 4 | |
throughput | int32 | 5 | |
Operation is returned by every mutating RPC. Clients poll GetOperation or subscribe to the SSE stream to observe progress.
| Field | Type | # | Notes |
|---|
id | string | 1 | opaque, type-prefixed: op_… |
action | string | 2 | permission string, e.g. compute.instance.create |
resource_id | string | 3 | |
resource_type | string | 4 | e.g. compute.instance |
state | OperationState | 5 | |
message | string | 6 | |
progress | int32 | 7 | 0..100 |
app | string | 8 | |
Snapshot is a disk backup of a volume or instance disk.
| Field | Type | # | Notes |
|---|
id | string | 1 | snap_… |
name | string | 2 | |
description | string | 3 | |
app | string | 4 | |
org | string | 5 | |
region | string | 6 | |
source_volume | string | 7 | |
source_instance | string | 8 | |
size_gb | int64 | 9 | |
status | string | 10 | pending | available | failed |
progress | int32 | 11 | |
encrypted | bool | 12 | |
origin | string | 13 | manual | backup |
| Field | Type | # | Notes |
|---|
id | string | 1 | |
name | string | 2 | |
schedule | string | 3 | |
retention_keep | int32 | 4 | |
retention_days | int32 | 5 | |
enabled | bool | 6 | |
| Field | Type | # | Notes |
|---|
id | string | 1 | vol_… |
name | string | 2 | |
app | string | 3 | |
org | string | 4 | |
region | string | 5 | |
size_gb | int64 | 6 | |
state | ResourceState | 7 | |
attached_to | string | 8 | instance id, empty if detached |
type | string | 12 | Phase 3 EBS-style attributes. |
iops | int32 | 13 | |
throughput | int32 | 14 | |
source_snapshot | string | 15 | |
encrypted | bool | 16 | |
availability_zone | string | 17 | |