Documentation | Regions

Regions

regions

Methods

List Regions -> OffsetPage<{ id, access_level, ai_service_endpoint_id, 23 more... }>

get/v1/regions

List regions

Get Region -> { id, access_level, ai_service_endpoint_id, 23 more... }

get/v1/regions/{region_id}

Get region

Parameters

region_id: number

Region ID

show_volume_types: boolean

Optional

If true, null available_volume_type is replaced with a list of available volume types.

Response fields

id: number

Region ID. It automatically is being generated when it is created

access_level: "core" | "edge"

The access level of the region.

ai_service_endpoint_id: number

AI service API endpoint ID

available_volume_types: Array<string>

List of available volume types, 'standard', 'ssd_hiiops', 'cold'].

coordinates: { latitude, longitude } | Array<unknown> | string

Coordinates of the region

country: string

Country

created_on: string

(format: date-time)

Datetime object. It automatically is being generated when it is created

ddos_endpoint_id: number

DDoS endpoint ID

display_name: string

Unique constraint. Display name

endpoint_type: "admin" | "internal" | "public"

Endpoint type

external_network_id: string

External network ID for Neutron

has_ai: boolean

Region has AI capability

has_ai_gpu: boolean

Region has AI GPU capability

has_baremetal: boolean

Region has bare metal capability

has_basic_vm: boolean

Region has basic vm capability

has_k8s: boolean

Region has managed kubernetes capability

has_kvm: boolean

Region has KVM virtualization capability

has_sfs: boolean

Region has SFS capability

keystone_id: number

Foreign key to Keystone entity

keystone_name: string

Region name exactly as stated in keystone

metrics_database_id: number

Foreign key to Metrics database entity

state: "ACTIVE" | "DELETED" | "DELETING" | 4 more...

Region state

task_id: string

UUID. Id of the Task entity that is handling region's state transition

vlan_physical_network: string

Physical network name to create vlan networks

zone: "AMERICAS" | "APAC" | "EMEA" | 1 more...

Zone

has_dbaas: boolean

Optional

Region has DBAAS service

Request example

curl https://api.gcore.com/cloud/v1/regions/$REGION_ID \
    -H "APIKey: $CLOUD_API_API_KEY"

200Example

{
  "id": 1,
  "access_level": "core",
  "ai_service_endpoint_id": 6,
  "available_volume_types": [
    "standard",
    "ssd_hiiops",
    "cold"
  ],
  "coordinates": {
    "latitude": 41.40338,
    "longitude": 2.17403
  },
  "country": "LU",
  "created_on": "2019-12-27T18:11:19.117Z",
  "ddos_endpoint_id": 3,
  "display_name": "Luxembourg 1",
  "endpoint_type": "admin",
  "external_network_id": "c843c3e6-ef4d-4b92-8db2-e16ac05c5650",
  "has_ai": true,
  "has_ai_gpu": true,
  "has_baremetal": false,
  "has_basic_vm": false,
  "has_k8s": true,
  "has_kvm": true,
  "has_sfs": false,
  "keystone_id": 1,
  "keystone_name": "ED-8",
  "metrics_database_id": 1,
  "state": "ACTIVE",
  "task_id": "task_id",
  "vlan_physical_network": "br-ex",
  "zone": "AMERICAS",
  "has_dbaas": false
}

Regions

Reseller Regions

regions.reseller_regions

Methods

Delete Reseller S Region Access Records ->

delete/v1/reseller_region/{reseller_id}

Delete reseller's region access records

Get A List Of Region Access Records For A Client Or A Reseller -> { count, results }

get/v1/reseller_region

Get a list of region access records for a client or a reseller

Create Or Update The Limit Of Regions For Clients Of The Reseller -> { id, client_name, reseller_name, 4 more... }

put/v1/reseller_region

Region access management. Resellers can open or close access to specific 'core' or 'edge' regions for all their clients either individually or collectively. Cloud admins can do it for any clients. By default, only 'core' regions are available to clients.