Skip to main content
GET
/
cloud
/
v1
/
file_shares
/
{project_id}
/
{region_id}
/
{file_share_id}
Python
import os
from gcore import Gcore

client = Gcore(
    api_key=os.environ.get("GCORE_API_KEY"),  # This is the default and can be omitted
)
file_share = client.cloud.file_shares.get(
    file_share_id="bd8c47ee-e565-4e26-8840-b537e6827b08",
    project_id=1,
    region_id=1,
)
print(file_share.id)
{
  "connection_point": "10.254.0.43:/shares/share-7c14ca01-ea5e-4d85-a6e2-c104fe6b561a",
  "created_at": "<string>",
  "creator_task_id": "<string>",
  "id": "<string>",
  "name": "<string>",
  "network_id": "<string>",
  "network_name": "<string>",
  "project_id": 123,
  "protocol": "<string>",
  "region": "<string>",
  "region_id": 123,
  "share_network_name": "File_share_test-sfs_network",
  "share_settings": {
    "type_name": "<string>"
  },
  "size": 2,
  "status": "available",
  "subnet_id": "<string>",
  "subnet_name": "<string>",
  "tags": [
    {
      "key": "<string>",
      "read_only": true,
      "value": "<string>"
    }
  ],
  "task_id": "22b1eau7-8641-4ae9-9n20-9e0b5fcd2gca",
  "type_name": "standard",
  "volume_type": "default_share_type"
}

Authorizations

Authorization
string
header
required

API key for authentication. Make sure to include the word apikey, followed by a single space and then your token. Example: apikey 1234$abcdef

Path Parameters

project_id
integer
required

Project ID

region_id
integer
required

Region ID

file_share_id
string<uuid4>
required

File Share ID

Response

200 - application/json

OK

connection_point
string | null
required

Connection point. Can be null during File share creation

Example:

"10.254.0.43:/shares/share-7c14ca01-ea5e-4d85-a6e2-c104fe6b561a"

created_at
string
required

Datetime when the file share was created

creator_task_id
string<uuid4>
required

Task that created this entity

id
string<uuid4>
required

File share ID

name
string
required

File share name

network_id
string<uuid4>
required

Network ID.

network_name
string
required

Network name.

project_id
integer
required

Project ID

protocol
string
required

File share protocol

region
string
required

Region name

region_id
integer
required

Region ID

share_network_name
string | null
required

Share network name. May be null if the file share was created with volume type VAST

Example:

"File_share_test-sfs_network"

share_settings
StandardShareSettingsOutputSerializer · object
required

Share settings specific to the file share type

  • StandardShareSettingsOutputSerializer
  • VastShareSettingsOutputSerializer
size
integer
required

File share size in GiB

Required range: x >= 1
status
enum<string>
required

File share status

Available options:
available,
awaiting_transfer,
backup_creating,
backup_restoring,
backup_restoring_error,
creating,
creating_from_snapshot,
deleted,
deleting,
ensuring,
error,
error_deleting,
extending,
extending_error,
inactive,
manage_error,
manage_starting,
migrating,
migrating_to,
replication_change,
reverting,
reverting_error,
shrinking,
shrinking_error,
shrinking_possible_data_loss_error,
unmanage_error,
unmanage_starting,
unmanaged
subnet_id
string<uuid4>
required

Subnet ID.

subnet_name
string
required

Subnet name.

tags
TagSerializer · object[]
required

List of key-value tags associated with the resource. A tag is a key-value pair that can be associated with a resource, enabling efficient filtering and grouping for better organization and management. Some tags are read-only and cannot be modified by the user. Tags are also integrated with cost reports, allowing cost data to be filtered based on tag keys or values.

task_id
string<uuid4> | null
required

The UUID of the active task that currently holds a lock on the resource. This lock prevents concurrent modifications to ensure consistency. If null, the resource is not locked.

Example:

"22b1eau7-8641-4ae9-9n20-9e0b5fcd2gca"

type_name
enum<string>
required

File share type name

Available options:
standard,
vast
volume_type
enum<string>
required
deprecated

Deprecated. Use type_name instead. File share disk type

Available options:
default_share_type,
vast_share_type