SOsodafoundation
Volume

Create a volume.

Changed on
post/v1/{tenantId}/volumes

Request

  • Base URL
    https://virtserver.swaggerhub.com/open83/multi-cloud/1.0.0
  • Auth
    none declared

Request body

Idstring

The volume ID, - Optional

UserIdstring

The user UUID in a multi-tenancy environment, - Optional

BackendIdstring required

The backend ID, - Required

Backendstring

The backend Name, - Optional

Namestring required

The volume name specified by user, - Required

Descriptionstring

The volume name specified by user, - Optional

Typestring required

The volume type, - Optional

iopsinteger

The IOPS the required for the volume as per the cloud provider

Sizeinteger

The volume size, - Optional

Regionstring

The region for the volume, - Optional

AvailabilityZonestring

The availability zone for the volume, - Optional

SnapshotIdstring

The volume snapshot id, - Optional

Encryptedboolean

Flag for encrypted volume, - Optional

EncryptedSettingsobject

Encrypted volume Keys, - Optional

Metadataobject

Metadata for cloud backend specific data, - Optional

Example request

{
  "Id": "5ef1db51202b510001c3804c",
  "UserId": "558057c4256545bd8a307c37464003c9",
  "BackendId": "5ea809d2553b0f000116be32",
  "Backend": "backend001",
  "Name": "volume001",
  "Description": "AWS Volume",
  "Type": "gp2",
  "iops": 100,
  "Size": 1073741824,
  "Region": "ap-south-1",
  "AvailabilityZone": "ap-south-1a",
  "Tags": [
    {
      "key": "Name",
      "Value": "soda"
    }
  ],
  "SnapshotId": "5eea749a926e5300011a69d6",
  "Encrypted": true,
  "EncryptedSettings": {
    "KmsKeyId": "arn:aws:kms:ap-south-1:676589967111:key/a6e1716e-0e90-407b-b494-b8ef8de91fc"
  },
  "Metadata": {
    "VolumeId": "vol-03deedaee2de0060f"
  }
}

Response

successful operation

Idstring

The volume ID, generated by server

CreatedAtstring

The time of creation of the volume.

UpdatedAtstring

The time at which the volume was updated.

TenantIdstring

The tenant UUID in a multi-tenancy environment.

UserIdstring

The user UUID in a multi-tenancy environment.

BackendIdstring

The backend ID

Backendstring

The backend Name.

Namestring

The volume name specified by user.

Descriptionstring

The volume description specified by user.

Typestring

The volume type.

Sizeinteger

The volume size.

Regionstring

The region for the volume.

AvailabilityZonestring

The availability zone for the volume.

Status'available' | 'creating' | 'inUse' | 'error' | 'updating' | 'deleting' | 'errorDeleting' | 'deleted'

The volume status.

SnapshotIdstring

The volume snapshot id.

Encryptedboolean

Flag for encryted volume.

EncryptedSettingsobject

Encryted volume Keys.

Example response

{
  "Id": "5ef1db51202b510001c3804c",
  "CreatedAt": "2020-06-23T16:07:05",
  "UpdatedAt": "2020-06-23T16:07:05",
  "TenantId": "94b280022d0c4401bcf3b0ea85870519",
  "UserId": "5ea809d2553b0f000116be32",
  "BackendId": "5ea809d2553b0f000116be32",
  "Backend": "backend001",
  "Name": "volume001",
  "Description": "AWS Volume",
  "Type": "gp2",
  "Size": 1073741824,
  "Region": "ap-south-1",
  "AvailabilityZone": "ap-south-1a",
  "Status": "available",
  "Tags": [
    {
      "key": "Name",
      "Value": "soda"
    }
  ],
  "SnapshotId": "5eea749a926e5300011a69d6",
  "Encrypted": true,
  "EncryptedSettings": {
    "KmsKeyId": "arn:aws:kms:ap-south-1:676589967111:key/a6e1716e-0e90-407b-b494-b8ef8de91fc"
  },
  "Metadata": {
    "fields": {
      "CreationTimeAtBackend": {
        "kind": {
          "StringValue": "2020-06-17T19:44:06Z"
        }
      },
      "StartTimeAtBackend": {
        "kind": {
          "StringValue": "2020-06-17T19:44:06Z"
        }
      },
      "VolumeId": {
        "kind": {
          "StringValue": "vol-03deedaee2de0060f"
        }
      }
    }
  }
}

Changes

  • a06e1dd6b63dRevision changes
    • breaking

      the request property became required

    • breaking

      the request property became required

    • breaking

      the request property became required

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 7299be026d62Revision changes
    • info

      endpoint added