Documentation | Everywhere Inference › Clusters › Check Quota For AI Cluster Creation

API Reference

Everywhere Inference

everywhere_inference

Methods

Get Flavors For AI Cluster -> { count, results }

get/v1/ai/flavors/{project_id}/{region_id}

Get flavors available for a potential AI cluster

Deprecated List Images For AI GPU Cluster -> { count, results }

get/v1/ai/images/gpu/{project_id}/{region_id}

Deprecated. Retrieve available AI GPU images.

List Available Regions That Provide AI Cluster Support -> { count, results }

get/v1/ai/regions

List available regions that provide AI cluster support

Everywhere Inference

Clusters

everywhere_inference.clusters

Methods

Assign Security Group To AI Cluster ->

post/v1/ai/clusters/{project_id}/{region_id}/{cluster_id}/addsecuritygroup

Assign the security group to the AI cluster. To assign multiple security groups to all ports, use the NULL value for the port_id field

Attach Interface To AI Cluster Node -> { tasks }

post/v1/ai/clusters/{project_id}/{region_id}/{instance_id}/attach_interface

Attach interface to AI cluster node

Check Quota For AI Cluster Creation -> { baremetal_basic_count_limit, baremetal_basic_count_requested, baremetal_basic_count_usage, 126 more... }

post/v1/ai/clusters/{project_id}/{region_id}/check_limits

Check if regional quota is exceeded, if yes the number of additional quotas needed to create the specified AI cluster 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

curl https://api.gcore.com/cloud/v1/ai/clusters/$PROJECT_ID/$REGION_ID/check_limits \
    -H 'Content-Type: application/json' \
    -H "APIKey: $CLOUD_API_API_KEY"

200Example

{
  "baremetal_basic_count_limit": 0,
  "baremetal_basic_count_requested": 1,
  "baremetal_basic_count_usage": 0,
  "baremetal_gpu_count_limit": 0,
  "baremetal_gpu_count_requested": 1,
  "baremetal_gpu_count_usage": 0,
  "baremetal_hf_count_limit": 0,
  "baremetal_hf_count_requested": 1,
  "baremetal_hf_count_usage": 0,
  "baremetal_infrastructure_count_limit": 0,
  "baremetal_infrastructure_count_requested": 1,
  "baremetal_infrastructure_count_usage": 0,
  "baremetal_network_count_limit": 0,
  "baremetal_network_count_requested": 1,
  "baremetal_network_count_usage": 0,
  "baremetal_storage_count_limit": 0,
  "baremetal_storage_count_requested": 1,
  "baremetal_storage_count_usage": 0,
  "caas_container_count_limit": 0,
  "caas_container_count_requested": 1,
  "caas_container_count_usage": 0,
  "caas_cpu_count_limit": 0,
  "caas_cpu_count_requested": 1,
  "caas_cpu_count_usage": 0,
  "caas_gpu_count_limit": 0,
  "caas_gpu_count_requested": 1,
  "caas_gpu_count_usage": 0,
  "caas_ram_size_limit": 0,
  "caas_ram_size_requested": 1,
  "caas_ram_size_usage": 0,
  "cluster_count_limit": 0,
  "cluster_count_requested": 1,
  "cluster_count_usage": 0,
  "cpu_count_limit": 0,
  "cpu_count_requested": 1,
  "cpu_count_usage": 0,
  "dbaas_postgres_cluster_count_limit": 0,
  "dbaas_postgres_cluster_count_requested": 1,
  "dbaas_postgres_cluster_count_usage": 0,
  "external_ip_count_limit": 0,
  "external_ip_count_requested": 1,
  "external_ip_count_usage": 0,
  "faas_cpu_count_limit": 0,
  "faas_cpu_count_requested": 1,
  "faas_cpu_count_usage": 0,
  "faas_function_count_limit": 0,
  "faas_function_count_requested": 1,
  "faas_function_count_usage": 0,
  "faas_namespace_count_limit": 0,
  "faas_namespace_count_requested": 1,
  "faas_namespace_count_usage": 0,
  "faas_ram_size_limit": 0,
  "faas_ram_size_requested": 1,
  "faas_ram_size_usage": 0,
  "firewall_count_limit": 0,
  "firewall_count_requested": 1,
  "firewall_count_usage": 0,
  "floating_count_limit": 0,
  "floating_count_requested": 1,
  "floating_count_usage": 0,
  "gpu_count_limit": 0,
  "gpu_count_requested": 1,
  "gpu_count_usage": 0,
  "image_count_limit": 0,
  "image_count_requested": 1,
  "image_count_usage": 0,
  "image_size_limit": 0,
  "image_size_requested": 1,
  "image_size_usage": 0,
  "ipu_count_limit": 0,
  "ipu_count_requested": 1,
  "ipu_count_usage": 0,
  "laas_topic_count_limit": 0,
  "laas_topic_count_requested": 1,
  "laas_topic_count_usage": 0,
  "loadbalancer_count_limit": 0,
  "loadbalancer_count_requested": 1,
  "loadbalancer_count_usage": 0,
  "network_count_limit": 0,
  "network_count_requested": 1,
  "network_count_usage": 0,
  "ram_limit": 0,
  "ram_requested": 1,
  "ram_usage": 0,
  "registry_count_limit": 0,
  "registry_count_requested": 1,
  "registry_count_usage": 0,
  "registry_storage_limit": 0,
  "registry_storage_requested": 1,
  "registry_storage_usage": 0,
  "router_count_limit": 0,
  "router_count_requested": 1,
  "router_count_usage": 0,
  "secret_count_limit": 0,
  "secret_count_requested": 1,
  "secret_count_usage": 0,
  "servergroup_count_limit": 0,
  "servergroup_count_requested": 1,
  "servergroup_count_usage": 0,
  "sfs_count_limit": 0,
  "sfs_count_requested": 1,
  "sfs_count_usage": 0,
  "sfs_size_limit": 0,
  "sfs_size_requested": 1,
  "sfs_size_usage": 0,
  "shared_vm_count_limit": 0,
  "shared_vm_count_requested": 1,
  "shared_vm_count_usage": 0,
  "snapshot_schedule_count_limit": 0,
  "snapshot_schedule_count_requested": 1,
  "snapshot_schedule_count_usage": 0,
  "subnet_count_limit": 0,
  "subnet_count_requested": 1,
  "subnet_count_usage": 0,
  "vm_count_limit": 0,
  "vm_count_requested": 1,
  "vm_count_usage": 0,
  "volume_count_limit": 0,
  "volume_count_requested": 1,
  "volume_count_usage": 0,
  "volume_size_limit": 0,
  "volume_size_requested": 1,
  "volume_size_usage": 0,
  "volume_snapshots_count_limit": 0,
  "volume_snapshots_count_requested": 1,
  "volume_snapshots_count_usage": 0,
  "volume_snapshots_size_limit": 0,
  "volume_snapshots_size_requested": 1,
  "volume_snapshots_size_usage": 0
}

Delete AI Cluster -> { tasks }

delete/v2/ai/clusters/{project_id}/{region_id}/{cluster_id}

Delete AI cluster

Detach Interface From AI Cluster Node -> { tasks }

post/v1/ai/clusters/{project_id}/{region_id}/{instance_id}/detach_interface

Detach interface from AI cluster node

Get AI Cluster Node Console URL -> { remote_console }

get/v1/ai/clusters/{project_id}/{region_id}/{instance_id}/get_console

Get AI cluster node console URL

List AI Clusters -> OffsetPage<{ cluster_id, cluster_status, creator_task_id, 20 more... }>

get/v2/ai/clusters/{project_id}/{region_id}

List AI clusters

Un Assign Security Group From AI Cluster ->

post/v1/ai/clusters/{project_id}/{region_id}/{cluster_id}/delsecuritygroup

Un-assign the security group from the AI cluster. To un-assign multiple security groups to all ports, use the NULL value for the port_id field

Get AI Cluster -> { cluster_id, cluster_status, creator_task_id, 20 more... }

get/v2/ai/clusters/{project_id}/{region_id}/{cluster_id}

Get AI cluster

Everywhere Inference Clusters

GPU

everywhere_inference.clusters.gpu

Methods

Create AI GPU Cluster -> { tasks }

post/v1/ai/clusters/gpu/{project_id}/{region_id}

Create a new AI cluster.

Rebuild One Or Many Nodes From GPU Cluster -> { tasks }

post/v1/ai/clusters/gpu/{project_id}/{region_id}/{cluster_id}/rebuild

Rebuild one or many nodes from GPU cluster. All cluster nodes need to be provided to change the cluster image.

Remove Single Node From GPU Cluster -> { tasks }

delete/v1/ai/clusters/gpu/{project_id}/{region_id}/{cluster_id}/node/{instance_id}

Remove single node from GPU cluster.

Resize AI GPU Cluster -> { tasks }

post/v1/ai/clusters/gpu/{project_id}/{region_id}/{cluster_id}/resize

Resize an existing AI GPU cluster.

Everywhere Inference Clusters

Metadata

everywhere_inference.clusters.metadata

Methods

Create Or Update Metadata Of AI Cluster ->

post/v2/ai/clusters/{project_id}/{region_id}/{cluster_id}/metadata

Create or update one or more metadata items of the cluster. If an item does not exist, it gets created in the cluster metadata. If an item already exists, it's value is overwritten

List All Metadata Of AI Cluster -> { count, results }

get/v1/ai/clusters/{project_id}/{region_id}/{cluster_id}/metadata

List all metadata of AI cluster

List Network Interfaces For AI Cluster -> { count, results }

get/v1/ai/clusters/{project_id}/{region_id}/{cluster_id}/interfaces

List network interfaces attached to AI cluster poplar servers

List Network Ports For AI Cluster -> { count, results }

get/v1/ai/clusters/{project_id}/{region_id}/{cluster_id}/ports

List network ports of AI cluster poplar servers

Replace Metadata ->

put/v2/ai/clusters/{project_id}/{region_id}/{cluster_id}/metadata

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

Deprecated Create Or Update Metadata Of AI Cluster ->

put/v1/ai/clusters/{project_id}/{region_id}/{cluster_id}/metadata

Create or update one or more metadata items of the cluster. If an item does not exist, it gets created in the cluster metadata. If an item already exists, it's value is overwritten

Everywhere Inference Clusters

Metadata Item

everywhere_inference.clusters.metadata_item

Methods

Deprecated Delete AI Cluster Metadata Item By Key ->

delete/v1/ai/cluster/{project_id}/{region_id}/{cluster_id}/metadata_item

Delete AI cluster metadata item by key

Deprecated Get AI Cluster Metadata Item By Key -> { key, read_only, value }

get/v1/ai/cluster/{project_id}/{region_id}/{cluster_id}/metadata_item

Get AI cluster metadata item by key

Everywhere Inference Clusters

Powercycle

everywhere_inference.clusters.powercycle

Methods

Powercycle All AI Cluster Nodes -> { count, results }

post/v2/ai/clusters/{project_id}/{region_id}/{cluster_id}/powercycle

Powercycle (stop and start) all AI cluster nodes, aka hard reboot

Powercycle One AI Cluster Node -> { addresses, blackhole_ports, creator_task_id, 21 more... }

post/v1/ai/clusters/{project_id}/{region_id}/{instance_id}/powercycle

Powercycle (stop and start) one AI cluster node, aka hard reboot

Everywhere Inference Clusters

Reboot

everywhere_inference.clusters.reboot

Methods

Reboot All AI Cluster Nodes -> { count, results }

post/v2/ai/clusters/{project_id}/{region_id}/{cluster_id}/reboot

Reboot all AI cluster nodes

Reboot One AI Cluster Node -> { addresses, blackhole_ports, creator_task_id, 21 more... }

post/v1/ai/clusters/{project_id}/{region_id}/{instance_id}/reboot

Reboot one AI cluster node