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

client = Gcore(
    api_key="My API Key",
)
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": "2023-04-25T11:06:49.226920",
  "creator_task_id": "6ab1ead7-8640-4ae9-9e20-9e0bafcd2eca",
  "id": "bd8c47ee-e565-4e26-8840-b537e6827b08",
  "name": "test-sfs",
  "network_id": "e72fd98e-32fa-474d-b0a3-bca11c3064ff",
  "network_name": "File_share_test-sfs",
  "project_id": 1337,
  "protocol": "NFS",
  "region": "Luxembourg 1",
  "region_id": 7,
  "share_network_name": "File_share_test-sfs_network",
  "share_settings": {
    "type_name": "<string>"
  },
  "size": 10,
  "status": "available",
  "subnet_id": "ac601bb9-4d77-4356-96de-66ab29711815",
  "subnet_name": "subnet_test-sfs",
  "tags": [
    {
      "key": "my-tag",
      "read_only": false,
      "value": "my-tag-value"
    }
  ],
  "task_id": "22b1eau7-8641-4ae9-9n20-9e0b5fcd2gca",
  "type_name": "standard",
  "volume_type": "default_share_type"
}

Authorizations

​
Authorization
string
header
required

Path Parameters

​
project_id
integer
required
Examples:
​
region_id
integer
required
Examples:
​
file_share_id
string<uuid4>
required
Examples:

Response

200 - application/json
​
connection_point
string | null
required
Examples:
​
created_at
string
required
Examples:
​
creator_task_id
string<uuid4>
required
Examples:
​
id
string<uuid4>
required
Examples:
​
name
string
required
Examples:
​
network_id
string<uuid4>
required
Examples:
​
network_name
string
required
Examples:
​
project_id
integer
required
Examples:
​
protocol
string
required
Examples:
​
region
string
required
Examples:
​
region_id
integer
required
Examples:
​
share_network_name
string | null
required
Examples:
​
share_settings
object
required
  • StandardShareSettingsOutputSerializer
  • VastShareSettingsOutputSerializer
​
size
integer
required
Required range: x >= 1
Examples:
​
status
enum<string>
required
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
Examples:
​
subnet_name
string
required
Examples:
​
tags
TagSerializer · object[]
required
Examples:
​
task_id
string<uuid4> | null
required
Examples:
​
type_name
enum<string>
required
Available options:
standard,
vast
​
volume_type
enum<string>
required
Available options:
default_share_type,
vast_share_type