Documentation | File Shares › Create File Share

File Shares

file_shares

Methods

Check Quota For File Share Creation -> { baremetal_basic_count_limit, baremetal_basic_count_requested, baremetal_basic_count_usage, 126 more... }

post/v1/file_shares/{project_id}/{region_id}/check_limits

Check if regional quota is exceeded, if yes the number of additional quotas needed to create the specified File Share will be calculated

Create File Share -> { tasks }

post/v1/file_shares/{project_id}/{region_id}

Create File Share

Parameters

project_id: number

region_id: number

Response fields

tasks: Array<string>

Optional

Task list

Request example

curl https://api.gcore.com/cloud/v1/file_shares/$PROJECT_ID/$REGION_ID \
    -H 'Content-Type: application/json' \
    -H "APIKey: $CLOUD_API_API_KEY" \
    -d '{
      "name": "test-share-file-system",
      "network": {
        "network_id": "024a29e9-b4b7-4c91-9a46-505be123d9f8"
      },
      "protocol": "NFS",
      "size": 5
    }'

200Example

{
  "tasks": [
    "d478ae29-dedc-4869-82f0-96104425f565"
  ]
}

Delete File Share -> { tasks }

delete/v1/file_shares/{project_id}/{region_id}/{sfs_id}

Delete File Share

Extend File Share -> { tasks }

post/v1/file_shares/{project_id}/{region_id}/{sfs_id}/extend

Extend File Share

List File Shares -> { count, results }

get/v1/file_shares/{project_id}/{region_id}

List File Shares

Get File Share ->

SfsSchema

get/v1/file_shares/{project_id}/{region_id}/{sfs_id}

Get File Share

Change File Share Name ->

SfsSchema

patch/v1/file_shares/{project_id}/{region_id}/{sfs_id}

Initiate File Share name change

Domain types

SfsSchema = { protocol, id, connection_point, 17 more... }

Sfs schema

File Shares

Access Rule

file_shares.access_rule

Methods

Create Access Rule -> { access_level, access_to, state, 1 more... }

post/v1/file_shares/{project_id}/{region_id}/{sfs_id}/access_rule

Create new access rule for File Shares

Delete Access Rule ->

delete/v1/file_shares/{project_id}/{region_id}/{sfs_id}/access_rule/{ac_id}

Delete access rule from File Share

Get Access Rule List -> { count, results }

get/v1/file_shares/{project_id}/{region_id}/{sfs_id}/access_rule

Get access rule list for File Share

File Shares

Metadata

file_shares.metadata

Methods

Create Or Update File Share Metadata ->

post/v1/file_shares/{project_id}/{region_id}/{sfs_id}/metadata

Create or update one or more metadata items for a File Share. If an item does not exist, it gets created. If an item already exists, it's value is overwritten

List File Share Metadata -> { count, results }

get/v1/file_shares/{project_id}/{region_id}/{sfs_id}/metadata

List all metadata for a File Share

Replace Metadata All For File Share ->

put/v1/file_shares/{project_id}/{region_id}/{sfs_id}/metadata

All existing metadata is deleted and replaced with the metadata from the request

File Shares

Access Rule

Metadata

Metadata Item