FileShare

Update a fileshare.

put/v1/{tenantId}/file/share/{id}

Request body

Descriptionstring

The fileshare name specified by user, - Optional

Sizeinteger

The fileshare size, - Optional

Encryptedboolean

Flag for encryted fileshare, - Optional

EncryptedSettingsobject

Encryted fileshare Keys, - Optional

Metadataobject

Metadata for cloud backend specific data, - Required

Example request

{
  "Description": "AWS FileShare",
  "Size": 1073741824,
  "Tags": [
    {
      "key": "Name",
      "Value": "soda"
    }
  ],
  "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.

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"
        }
      }
    }
  }
}

Changes

Changed in 3 of the 33 revisions of this API.61211

Jun 27, 20207bc48776926e51210See the full diff
- ▲
  request body became required
  request-body-became-required
- ▲
  the response's property type changed from string to object for status
  response-property-type-changed
- ▲
  the response's property type changed from string to object for status
  response-property-type-changed
- ▲
  the response's property type changed from array to string for status
  response-property-type-changed
- ▲
  the response's property type changed from string to integer for status
  response-property-type-changed
- ●
  removed the request property
  request-property-removed
- ●
  removed the request property
  request-property-removed
- ●
  added the new NFS enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new SMB enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new available enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new creating enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new deleted enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new deleting enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new error enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new errorDeleting enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new inUse enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new updating enum value to the response property for the response status
  response-property-enum-value-added
- ○
  added the new optional request property
  new-optional-request-property
- ○
  added the new optional request property
  new-optional-request-property
- ○
  added the new optional request property
  new-optional-request-property
- ○
  added the new optional request property
  new-optional-request-property
- ○
  added the new optional request property
  new-optional-request-property
- ○
  added the new optional request property
  new-optional-request-property
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
Jun 26, 2020443f565555ae1See the full diff
- ○
  endpoint added
  endpoint-added
Oct 29, 201850fa096a39061See the full diff
- ▲
  api path removed without deprecation
  api-path-removed-without-deprecation
This revision also has 46 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Of the 33 revisions, 3 have no diff computed.

Full history