---
title: "Get a fileshare information."
method: GET
path: "/v1/{tenantId}/file/share/{id}"
tags: ["FileShare"]
---

# Get a fileshare information.

`GET /v1/{tenantId}/file/share/{id}`

## Response `200`

successful operation

- FileShareResult — FileShare Response
  - `Id` string — The fileshare ID, generated by server
  - `CreatedAt` string — The time of creation of the fileshare.
  - `UpdatedAt` string — The time at which the fileshare was updated.
  - `TenantId` string — The tenant UUID in a multi-tenancy environment.
  - `UserId` string — The user UUID in a multi-tenancy environment.
  - `BackendId` string — The backend ID
  - `Backend` string — The backend Name.
  - `Name` string — The fileshare name specified by user.
  - `Description` string — The fileshare description specified by user.
  - `Type` string — The fileshare type.
  - `Size` integer — The fileshare size.
  - `Region` string — The region for the fileshare.
  - `AvailabilityZone` string — 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.
  - `Tags` Tag[]
    - `key` string — Key of the Tag object.
    - `Value` string — Value of the Tag object.
  - `SnapshotId` string — The fileshare snapshot id.
  - `Encrypted` boolean — Flag for encryted fileshare.
  - `EncryptedSettings` object — Encryted fileshare Keys.
  - `Metadata` object
    - `fields` Fields
      - `CreationTimeAtBackend` object
        - `kind` object
          - `StringValue` string
      - `CreationToken` object
        - `kind` object
          - `StringValue` string
      - `FileSystemId` object
        - `kind` object
          - `StringValue` string
      - `FileSystemSize` object
        - `kind` object
          - `StructValue` object
            - `fields` object
              - …
      - `LifeCycleState` object
        - `kind` object
          - `StringValue` 'creating' | 'available' | 'updating' | 'deleting' | 'deleted'
      - `Name` object
        - `kind` object
          - `StringValue` string
      - `NumberOfMountTargets` object
        - `kind` object
          - `NumberValue` integer
      - `OwnerId` object
        - `kind` object
          - `StringValue` string
      - `PerformanceMode` object
        - `kind` object
          - `StringValue` 'generalPurpose' | 'maxIO'
      - `ProvisionedThroughputInMibps` object
        - `kind` object
          - `NumberValue` integer
      - `ThroughputMode` object
        - `kind` object
          - `StringValue` 'bursting' | 'provisioned'

## Other responses

- `401` — Unauthorized. Token not found in header
- `404` — The resource does not exist.

---

[API](https://skmtc.net/sodafoundation/apis/soda-multi-cloud-api.md) · [All operations](https://skmtc.net/sodafoundation/apis/soda-multi-cloud-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/sodafoundation/soda-multi-cloud-api/versions/df048c8349b6/schema)