SOsodafoundation
FileShare

List all file shares.

Changed on
get/v1/{tenantId}/file/shares

Request

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

Query parameters

backendIdstring
Example:5eea1a317d038300012f5bfc

Filter the fileshares 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

{
  "fileshares": [
    {
      "Id": "5ef1db51202b510001c3804c",
      "CreatedAt": "2020-06-23T16:07:05",
      "UpdatedAt": "2020-06-23T16:07:05",
      "TenantId": "94b280022d0c4401bcf3b0ea85870519",
      "UserId": "5ea809d2553b0f000116be32",
      "BackendId": "5ea809d2553b0f000116be32",
      "Backend": "backend001",
      "Name": "fileshare001",
      "Description": "AWS FileShare",
      "Type": "generalPurpose",
      "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"
            }
          },
          "CreationToken": {
            "kind": {
              "StringValue": "J7UWp#KX7BPi#zC5]{0j2/I54ukWP?j~[d3H"
            }
          },
          "FileSystemId": {
            "kind": {
              "StringValue": "fs-68e26cb9"
            }
          },
          "FileSystemSize": {
            "kind": {
              "StructValue": {
                "fields": {
                  "Value": {
                    "kind": {
                      "NumberValue": 6144
                    }
                  },
                  "ValueInStandard": {
                    "kind": {
                      "NumberValue": 6144
                    }
                  }
                }
              }
            }
          },
          "LifeCycleState": {
            "kind": {
              "StringValue": "available"
            }
          },
          "Name": {
            "kind": {
              "StringValue": "sodafs"
            }
          },
          "OwnerId": {
            "kind": {
              "StringValue": "676599967111"
            }
          },
          "PerformanceMode": {
            "kind": {
              "StringValue": "maxIO"
            }
          },
          "ProvisionedThroughputInMibps": {
            "kind": {
              "NumberValue": 1
            }
          },
          "ThroughputMode": {
            "kind": {
              "StringValue": "provisioned"
            }
          }
        }
      }
    }
  ],
  "next": 1
}

Changes

  • 7299be026d62Revision changes
    • warning

      removed the optional property from the response with the status

    • info

      added the optional property to the response with the status

  • 443f565555aeRevision changes
    • warning

      removed the optional property from the response with the status

    • info

      added the optional property to the response with the status