Skip to content

Search is only available in production builds. Try building and previewing the site to test it out locally.

StorageService

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.

FieldType#Notes
idstring1
instance_idstring2

BackupPolicy schedules retained snapshots of a volume (Phase 6). A backup is just a snapshot with origin=backup; the policy owns cadence + retention.

FieldType#Notes
idstring1bpol_…
namestring2
appstring3
orgstring4
source_volumestring5volume id to back up
providerstring6
schedulestring7hourly | daily | weekly | “@every <dur>”
retention_keepint328keep N most recent backups (0 = unlimited)
retention_daysint329expire backups older than N days (0 = no expiry)
enabledbool10
FieldType#Notes
namestring1
source_volume_idstring2
schedulestring3
retention_keepint324
retention_daysint325
enabledbool6
FieldType#Notes
source_volume_idstring1
source_instance_idstring2
descriptionstring3
namestring4
FieldType#Notes
idstring1snapshot id
namestring2new volume name
FieldType#Notes
volumeVolume1
FieldType#Notes
idstring1
FieldType#Notes
idstring1
FieldType#Notes
idstring1
FieldType#Notes
idstring1
forcebool2
FieldType#Notes
idstring1
FieldType#Notes
idstring1
FieldType#Notes
idstring1
FieldType#Notes
pagePageRequest1
FieldType#Notes
policiesBackupPolicy1
metaListMeta2
FieldType#Notes
pagePageRequest1
FieldType#Notes
snapshotsSnapshot1
metaListMeta2
FieldType#Notes
pagePageRequest1
FieldType#Notes
volumesVolume1
metaListMeta2
FieldType#Notes
idstring1
size_gbint642
typestring3
iopsint324
throughputint325

Operation is returned by every mutating RPC. Clients poll GetOperation or subscribe to the SSE stream to observe progress.

FieldType#Notes
idstring1opaque, type-prefixed: op_…
actionstring2permission string, e.g. compute.instance.create
resource_idstring3
resource_typestring4e.g. compute.instance
stateOperationState5
messagestring6
progressint3270..100
appstring8
FieldType#Notes
idstring1
FieldType#Notes
idstring1

Snapshot is a disk backup of a volume or instance disk.

FieldType#Notes
idstring1snap_…
namestring2
descriptionstring3
appstring4
orgstring5
regionstring6
source_volumestring7
source_instancestring8
size_gbint649
statusstring10pending | available | failed
progressint3211
encryptedbool12
originstring13manual | backup
FieldType#Notes
idstring1
namestring2
schedulestring3
retention_keepint324
retention_daysint325
enabledbool6
FieldType#Notes
idstring1vol_…
namestring2
appstring3
orgstring4
regionstring5
size_gbint646
stateResourceState7
attached_tostring8instance id, empty if detached
typestring12Phase 3 EBS-style attributes.
iopsint3213
throughputint3214
source_snapshotstring15
encryptedbool16
availability_zonestring17