Sign in

v1

latestOpenAPI 3.0.0Apache 2.02026-07-17504188.8 KB
FileShare

Create a fileshare.

post/v1/{tenantId}/file/shares

Request body

Idstring

The fileshare 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 fileshare name specified by user, - Required

Descriptionstring

The fileshare name specified by user, - Optional

Typestring

The fileshare type, - Optional

Sizeinteger

The fileshare size, - Optional

Regionstring

The region for the fileshare, - Optional

AvailabilityZonestring

The availability zone for the fileshare, - Optional

Protocols'NFS' | 'SMB'

The fileshare supported protocols, - Optional

SnapshotIdstring

The fileshare snapshot id, - Optional

Encryptedboolean

Flag for encryted fileshare, - Optional

EncryptedSettingsobject

Encryted fileshare Keys, - Optional

Metadataobject required

Metadata for cloud backend specific data, - Required

Example request

{
  "Id": "5ef1db51202b510001c3804c",
  "UserId": "558057c4256545bd8a307c37464003c9",
  "BackendId": "5ea809d2553b0f000116be32",
  "Backend": "backend001",
  "Name": "fileshare001",
  "Description": "AWS FileShare",
  "Type": "generalPurpose",
  "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": {
    "PerformanceMode": "maxIO",
    "ThroughputMode": "provisioned",
    "ProvisionedThroughputInMibps": 1
  }
}

Response

successful operation

Idstring

The fileshare ID, generated by server

CreatedAtstring

The time of creation of the fileshare.

UpdatedAtstring

The time at which the fileshare 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 fileshare name specified by user.

Descriptionstring

The fileshare description specified by user.

Typestring

The fileshare type.

Sizeinteger

The fileshare size.

Regionstring

The region for the fileshare.

AvailabilityZonestring

The availability zone for the fileshare.

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

The fileshare status.

Protocols'NFS' | 'SMB'

The fileshare supported protocols.

SnapshotIdstring

The fileshare snapshot id.

Encryptedboolean

Flag for encryted fileshare.

EncryptedSettingsobject

Encryted fileshare 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": "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"
        }
      }
    }
  }
}