Skip to main content
GET
/
cloud
/
v2
/
k8s
/
clusters
/
{project_id}
/
{region_id}
/
{cluster_name}
/
instances
List instances in k8s cluster
curl --request GET \
  --url https://api.gcore.com/cloud/v2/k8s/clusters/{project_id}/{region_id}/{cluster_name}/instances \
  --header 'Authorization: <api-key>'
{
  "count": 1,
  "results": [
    {
      "addresses": {},
      "blackhole_ports": [
        {
          "AlarmEnd": "2023-11-07T05:31:56Z",
          "AlarmStart": "2023-11-07T05:31:56Z",
          "AlarmState": "ACK_REQ",
          "AlertDuration": "<string>",
          "DestinationIP": "<string>",
          "ID": 123
        }
      ],
      "created_at": "2023-11-07T05:31:56Z",
      "creator_task_id": "<string>",
      "ddos_profile": {
        "id": 123,
        "profile_template": {
          "id": 123,
          "name": "<string>",
          "description": "description",
          "fields": [
            {
              "id": 123,
              "name": "<string>",
              "default": "<string>",
              "description": "description",
              "field_type": "int",
              "required": "false",
              "validation_schema": "<unknown>"
            }
          ]
        },
        "fields": [
          {
            "default": "<unknown>",
            "description": "<string>",
            "field_value": "<unknown>",
            "id": 123,
            "name": "<string>",
            "base_field": 123,
            "field_name": "<string>",
            "field_type": "<string>",
            "required": true,
            "validation_schema": "<unknown>",
            "value": "<string>"
          }
        ],
        "options": {
          "active": true,
          "bgp": true
        },
        "profile_template_description": "ARK server ports. Valid port values are in range 1000-65535",
        "protocols": [
          {
            "additionalProp1": "string",
            "additionalProp2": "string",
            "additionalProp3": "string"
          }
        ],
        "site": "ED",
        "status": {
          "error_description": "",
          "status": "Updated"
        }
      },
      "fixed_ip_assignments": [
        {
          "external": true,
          "ip_address": "<string>",
          "subnet_id": "<string>"
        }
      ],
      "flavor": {
        "architecture": "<string>",
        "flavor_id": "<string>",
        "flavor_name": "<string>",
        "hardware_description": {
          "ram": "<string>",
          "vcpus": "<string>"
        },
        "os_type": "<string>",
        "ram": 123,
        "vcpus": 123
      },
      "id": "<string>",
      "instance_description": "Instance description",
      "instance_isolation": {
        "reason": "Suspicious activities"
      },
      "name": "<string>",
      "project_id": 123,
      "region": "<string>",
      "region_id": 123,
      "security_groups": [
        {
          "name": "<string>"
        }
      ],
      "ssh_key_name": "<string>",
      "status": "ACTIVE",
      "tags": [
        {
          "key": "<string>",
          "read_only": true,
          "value": "<string>"
        }
      ],
      "task_id": null,
      "task_state": "<string>",
      "vm_state": "active",
      "volumes": [
        {
          "delete_on_termination": true,
          "id": "<string>"
        }
      ]
    }
  ]
}

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 identifier

​
region_id
integer
required

Region identifier

​
cluster_name
string
required

Cluster name

Query Parameters

​
with_ddos
boolean

Include DDoS profile information if set to true. The default value is false.

Response

Instances list

​
count
integer
required

Number of objects

Required range: x >= 0
Example:

1

​
results
InstanceSerializer · object[]
required

Objects