SOsodafoundation
Volume

List all volumes.

Changed on
get/v1/{tenantId}/volumes

Request

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

Query parameters

backendIdstring
Example:5eea1a317d038300012f5bfc

Filter the volumes by backend.

offsetinteger

The number of items to skip before starting to collect the result set

limitinteger

The numbers of items to return

sortstring

The sort key and direction of items to return, string must like:"id:asc,name:desc"

Response

successful operation.

nextinteger

Example response

{
  "volumes": [
    {
      "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