Avisi cloud logo
Clusters

Gets a node pool.

GET
/api/v1/orgs/{organisationSlug}/clusters/{environmentSlug}/{clusterSlug}/pools/{pool}

Path Parameters

organisationSlugstring
Pattern"^[a-z0-9-_]+$"
environmentSlugstring
Pattern"^[a-z0-9-_]+$"
clusterSlugstring
Pattern"^[a-z0-9-_]+$"
poolinteger
Format"int64"

Response Body

Request was successfully processed. The response body contains the requested data.

TypeScript Definitions

Use the response body type in TypeScript.

id?integer
Format"int64"
identity?string
Format"uuid"
name?string
availabilityZone?string
nodeSize?string
autoScaling?boolean
enableNodeAutoReplacement?boolean
enableNodeReboots?boolean
upgradeStrategy?string
Value in"REPLACE" | "INPLACE" | "INPLACE_WITHOUT_DRAIN" | "REPLACE_MINOR_INPLACE_PATCH" | "REPLACE_MINOR_INPLACE_PATCH_WITHOUT_DRAIN"
minSize?integer
Format"int64"
maxSize?integer
Format"int64"
annotations?object

Empty Object

labels?object

Empty Object

taints?array<object>

@minItems 0

createdAt?string
Format"date-time"
modifiedAt?string
Format"date-time"
provisionStatus?string
Value in"UNKNOWN" | "ACCEPTED" | "PROVISIONED"

Invalid request parameters. Please review the documentation for valid parameter values.

TypeScript Definitions

Use the response body type in TypeScript.

response?unknown

You do not have the necessary permissions to access this resource.

TypeScript Definitions

Use the response body type in TypeScript.

response?unknown

The requested resource could not be found. Please check the resource URL or identifier.

TypeScript Definitions

Use the response body type in TypeScript.

response?unknown

An internal error occurred on the server.

TypeScript Definitions

Use the response body type in TypeScript.

response?unknown
curl -X GET "https://api.avisi.cloud/api/v1/orgs/string/clusters/string/string/pools/0"
fetch("https://api.avisi.cloud/api/v1/orgs/string/clusters/string/string/pools/0")
package main

import (
  "fmt"
  "net/http"
  "io/ioutil"
)

func main() {
  url := "https://api.avisi.cloud/api/v1/orgs/string/clusters/string/string/pools/0"

  req, _ := http.NewRequest("GET", url, nil)
  
  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  body, _ := ioutil.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))
}
import requests

url = "https://api.avisi.cloud/api/v1/orgs/string/clusters/string/string/pools/0"

response = requests.request("GET", url)

print(response.text)
{
  "id": 0,
  "identity": "10a80a7a-1a32-4a74-b592-aa2a4ef691c5",
  "name": "string",
  "availabilityZone": "string",
  "nodeSize": "string",
  "autoScaling": true,
  "enableNodeAutoReplacement": true,
  "enableNodeReboots": true,
  "upgradeStrategy": "REPLACE",
  "minSize": 0,
  "maxSize": 0,
  "annotations": {
    "property1": "string",
    "property2": "string"
  },
  "labels": {
    "property1": "string",
    "property2": "string"
  },
  "taints": [
    {
      "key": "string",
      "value": "string",
      "effect": "string"
    }
  ],
  "createdAt": "2019-08-24T14:15:22Z",
  "modifiedAt": "2019-08-24T14:15:22Z",
  "provisionStatus": "UNKNOWN"
}
{
  "message": "string",
  "details": [
    "string"
  ]
}
{
  "message": "string",
  "details": [
    "string"
  ]
}
{
  "message": "string",
  "details": [
    "string"
  ]
}
{
  "message": "string",
  "details": [
    "string"
  ]
}