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

Parameters
project_id: number
region_id: number
Response fields
baremetal_basic_count_limit: number
Optional

Basic bare metal servers count limit

baremetal_basic_count_requested: number
Optional

Basic bare metal servers count requested

baremetal_basic_count_usage: number
Optional

Basic bare metal servers count usage

baremetal_gpu_count_limit: number
Optional

AI GPU bare metal servers count limit

baremetal_gpu_count_requested: number
Optional

AI GPU bare metal servers count requested

baremetal_gpu_count_usage: number
Optional

AI GPU bare metal servers count usage

baremetal_hf_count_limit: number
Optional

High-frequency bare metal servers count limit

baremetal_hf_count_requested: number
Optional

High-frequency bare metal servers count requested

baremetal_hf_count_usage: number
Optional

High-frequency bare metal servers count usage

baremetal_infrastructure_count_limit: number
Optional

Infrastructure bare metal servers count limit

baremetal_infrastructure_count_requested: number
Optional

Infrastructure bare metal servers count requested

baremetal_infrastructure_count_usage: number
Optional

Infrastructure bare metal servers count usage

baremetal_network_count_limit: number
Optional

Bare metal Network Count limit

baremetal_network_count_requested: number
Optional

Bare metal Network Count requested

baremetal_network_count_usage: number
Optional

Bare metal Network Count usage

baremetal_storage_count_limit: number
Optional

Storage bare metal servers count limit

baremetal_storage_count_requested: number
Optional

Storage bare metal servers count requested

baremetal_storage_count_usage: number
Optional

Storage bare metal servers count usage

caas_container_count_limit: number
Optional

Containers count limit

caas_container_count_requested: number
Optional

Containers count requested

caas_container_count_usage: number
Optional

Containers count usage

caas_cpu_count_limit: number
Optional

mCPU count for containers limit

caas_cpu_count_requested: number
Optional

mCPU count for containers requested

caas_cpu_count_usage: number
Optional

mCPU count for containers usage

caas_gpu_count_limit: number
Optional

Containers gpu count limit

caas_gpu_count_requested: number
Optional

Containers gpu count requested

caas_gpu_count_usage: number
Optional

Containers gpu count usage

caas_ram_size_limit: number
Optional

MB memory count for containers limit

caas_ram_size_requested: number
Optional

MB memory count for containers requested

caas_ram_size_usage: number
Optional

MB memory count for containers usage

cluster_count_limit: number
Optional

K8s clusters count limit

cluster_count_requested: number
Optional

K8s clusters count requested

cluster_count_usage: number
Optional

K8s clusters count usage

cpu_count_limit: number
Optional

vCPU Count limit

cpu_count_requested: number
Optional

vCPU Count requested

cpu_count_usage: number
Optional

vCPU Count usage

dbaas_postgres_cluster_count_limit: number
Optional

DBaaS cluster count limit

dbaas_postgres_cluster_count_requested: number
Optional

DBaaS cluster count requested

dbaas_postgres_cluster_count_usage: number
Optional

DBaaS cluster count usage

external_ip_count_limit: number
Optional

External IP Count limit

external_ip_count_requested: number
Optional

External IP Count requested

external_ip_count_usage: number
Optional

External IP Count usage

faas_cpu_count_limit: number
Optional

mCPU count for functions limit

faas_cpu_count_requested: number
Optional

mCPU count for functions requested

faas_cpu_count_usage: number
Optional

mCPU count for functions usage

faas_function_count_limit: number
Optional

Functions count limit

faas_function_count_requested: number
Optional

Functions count requested

faas_function_count_usage: number
Optional

Functions count usage

faas_namespace_count_limit: number
Optional

Functions namespace count limit

faas_namespace_count_requested: number
Optional

Functions namespace count requested

faas_namespace_count_usage: number
Optional

Functions namespace count usage

faas_ram_size_limit: number
Optional

MB memory count for functions limit

faas_ram_size_requested: number
Optional

MB memory count for functions requested

faas_ram_size_usage: number
Optional

MB memory count for functions usage

firewall_count_limit: number
Optional

Firewalls Count limit

firewall_count_requested: number
Optional

Firewalls Count requested

firewall_count_usage: number
Optional

Firewalls Count usage

floating_count_limit: number
Optional

Floating IP Count limit

floating_count_requested: number
Optional

Floating IP Count requested

floating_count_usage: number
Optional

Floating IP Count usage

gpu_count_limit: number
Optional

GPU Count limit

gpu_count_requested: number
Optional

GPU Count requested

gpu_count_usage: number
Optional

GPU Count usage

image_count_limit: number
Optional

Images Count limit

image_count_requested: number
Optional

Images Count requested

image_count_usage: number
Optional

Images Count usage

image_size_limit: number
Optional

Images Size, GiB limit

image_size_requested: number
Optional

Images Size, GiB requested

image_size_usage: number
Optional

Images Size, GiB usage

ipu_count_limit: number
Optional

IPU Count limit

ipu_count_requested: number
Optional

IPU Count requested

ipu_count_usage: number
Optional

IPU Count usage

laas_topic_count_limit: number
Optional

LaaS Topics Count limit

laas_topic_count_requested: number
Optional

LaaS Topics Count requested

laas_topic_count_usage: number
Optional

LaaS Topics Count usage

loadbalancer_count_limit: number
Optional

Load Balancers Count limit

loadbalancer_count_requested: number
Optional

Load Balancers Count requested

loadbalancer_count_usage: number
Optional

Load Balancers Count usage

network_count_limit: number
Optional

Networks Count limit

network_count_requested: number
Optional

Networks Count requested

network_count_usage: number
Optional

Networks Count usage

ram_limit: number
Optional

RAM Size, GiB limit

ram_requested: number
Optional

RAM Size, GiB requested

ram_usage: number
Optional

RAM Size, GiB usage

registry_count_limit: number
Optional

Registries count limit

registry_count_requested: number
Optional

Registries count requested

registry_count_usage: number
Optional

Registries count usage

registry_storage_limit: number
Optional

Registries volume usage, GiB limit

registry_storage_requested: number
Optional

Registries volume usage, GiB requested

registry_storage_usage: number
Optional

Registries volume usage, GiB usage

router_count_limit: number
Optional

Routers Count limit

router_count_requested: number
Optional

Routers Count requested

router_count_usage: number
Optional

Routers Count usage

secret_count_limit: number
Optional

Secret Count limit

secret_count_requested: number
Optional

Secret Count requested

secret_count_usage: number
Optional

Secret Count usage

servergroup_count_limit: number
Optional

Placement Group Count limit

servergroup_count_requested: number
Optional

Placement Group Count requested

servergroup_count_usage: number
Optional

Placement Group Count usage

sfs_count_limit: number
Optional

Shared file system Count limit

sfs_count_requested: number
Optional

Shared file system Count requested

sfs_count_usage: number
Optional

Shared file system Count usage

sfs_size_limit: number
Optional

Shared file system Size, GiB limit

sfs_size_requested: number
Optional

Shared file system Size, GiB requested

sfs_size_usage: number
Optional

Shared file system Size, GiB usage

shared_vm_count_limit: number
Optional

Basic VMs Count limit

shared_vm_count_requested: number
Optional

Basic VMs Count requested

shared_vm_count_usage: number
Optional

Basic VMs Count usage

snapshot_schedule_count_limit: number
Optional

Snapshot Schedules Count limit

snapshot_schedule_count_requested: number
Optional

Snapshot Schedules Count requested

snapshot_schedule_count_usage: number
Optional

Snapshot Schedules Count usage

subnet_count_limit: number
Optional

Subnets Count limit

subnet_count_requested: number
Optional

Subnets Count requested

subnet_count_usage: number
Optional

Subnets Count usage

vm_count_limit: number
Optional

Instances Dedicated Count limit

vm_count_requested: number
Optional

Instances Dedicated Count requested

vm_count_usage: number
Optional

Instances Dedicated Count usage

volume_count_limit: number
Optional

Volumes Count limit

volume_count_requested: number
Optional

Volumes Count requested

volume_count_usage: number
Optional

Volumes Count usage

volume_size_limit: number
Optional

Volumes Size, GiB limit

volume_size_requested: number
Optional

Volumes Size, GiB requested

volume_size_usage: number
Optional

Volumes Size, GiB usage

volume_snapshots_count_limit: number
Optional

Snapshots Count limit

volume_snapshots_count_requested: number
Optional

Snapshots Count requested

volume_snapshots_count_usage: number
Optional

Snapshots Count usage

volume_snapshots_size_limit: number
Optional

Snapshots Size, GiB limit

volume_snapshots_size_requested: number
Optional

Snapshots Size, GiB requested

volume_snapshots_size_usage: number
Optional

Snapshots Size, GiB usage

Request example
200Example
Create File Share -> { tasks }
post/v1/file_shares/{project_id}/{region_id}

Create File Share

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 ->
get/v1/file_shares/{project_id}/{region_id}/{sfs_id}

Get File Share

Change File Share Name ->
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

Metadata Item

file_shares.metadata_item

Methods

Delete File Share Metadata Item By Key ->
delete/v1/file_shares/{project_id}/{region_id}/{sfs_id}/metadata_item

Delete File Share metadata item by key

Get File Share Metadata Item By Key -> { key, read_only, value }
get/v1/file_shares/{project_id}/{region_id}/{sfs_id}/metadata_item

Get File Share metadata item by key