Skip to main content
GET
/
cloud
/
v3
/
gpu
/
virtual
/
{project_id}
/
{region_id}
/
clusters
/
{cluster_id}
/
servers
Python
import os
from gcore import Gcore

client = Gcore(
    api_key=os.environ.get("GCORE_API_KEY"),  # This is the default and can be omitted
)
gpu_virtual_cluster_server_list = client.cloud.gpu_virtual_clusters.servers.list(
    cluster_id="1aaaab48-10d0-46d9-80cc-85209284ceb4",
    project_id=1,
    region_id=7,
)
print(gpu_virtual_cluster_server_list.count)
{
  "count": 1,
  "results": [
    {
      "created_at": "2023-11-07T05:31:56Z",
      "flavor": "<string>",
      "id": "<string>",
      "image_id": "ded40aad-505c-463b-aa59-8f5f455d1b6f",
      "ip_addresses": [
        "<string>"
      ],
      "name": "<string>",
      "security_groups": [
        {
          "id": "<string>",
          "name": "<string>"
        }
      ],
      "ssh_key_name": "ded40aad-505c-463b-aa59-8f5f455d1b6f",
      "status": "ACTIVE",
      "tags": [
        {
          "key": "<string>",
          "read_only": true,
          "value": "<string>"
        }
      ],
      "task_id": "ded40aad-505c-463b-aa59-8f5f455d1b6f",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

Authorization
string
header
required

API key for authentication. Make sure to include the word apikey, followed by a single space and then your token. Example: apikey 1234$abcdef

Path Parameters

project_id
integer
required

Project ID

region_id
integer
required

Region ID

cluster_id
string<uuid4>
required

Cluster unique identifier

Query Parameters

changed_before
string<date-time>

Filters the results to include only servers whose last change timestamp is less than the specified datetime. Format: ISO 8601.

changed_since
string<date-time>

Filters the results to include only servers whose last change timestamp is greater than or equal to the specified datetime. Format: ISO 8601.

ip_address
string

Filter servers by ip address.

limit
integer
default:10

Limit of items on a single page

Required range: x <= 1000
name
string

Filter servers by name. You can provide a full or partial name, servers with matching names will be returned. For example, entering 'test' will return all servers that contain 'test' in their name.

offset
integer
default:0

Offset in results list

Required range: x >= 0
order_by
enum<string>
default:created_at.desc

Order field

Available options:
created_at.asc,
created_at.desc,
status.asc,
status.desc
status
enum<string>

Filters servers by status.

Available options:
ACTIVE,
BUILD,
ERROR,
HARD_REBOOT,
MIGRATING,
PAUSED,
REBOOT,
REBUILD,
RESIZE,
REVERT_RESIZE,
SHELVED,
SHELVED_OFFLOADED,
SHUTOFF,
SOFT_DELETED,
SUSPENDED,
VERIFY_RESIZE
uuids
string[]

Filter servers by uuid.

Response

200 - application/json

OK

count
integer
required

Number of objects

Required range: x >= 0
results
ClusterInstanceServer · object[]
required

Objects