Clusters
List clusters inside an environment for an organisation.
Path Parameters
organisationSlugstring
Pattern
"^[a-z0-9-]+$"environmentSlugstring
Pattern
"^[a-z0-9-]+$"Query Parameters
show-compute?boolean
Optional. Default false. If true, returns accumulated compute information of environment in response.
Default
falseincludeDetails?boolean
Optional. Default false. If true, returns actual cluster status in response.
Default
truepageableobject
Optional. When omitted: pageSize=50, pageNumber=0, sortDirection=ASC
Response Body
Request was successfully processed. The response body contains the requested data.
TypeScript Definitions
Use the response body type in TypeScript.
totalElements?integer
Format
"int64"totalPages?integer
Format
"int32"first?boolean
last?boolean
size?integer
Format
"int32"content?array<object>
@minItems 0
number?integer
Format
"int32"sort?object
numberOfElements?integer
Format
"int32"pageable?object
empty?boolean
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?show-compute=false&includeDetails=true&pageable=%5Bobject+Object%5D"fetch("https://api.avisi.cloud/api/v1/orgs/string/clusters/string?show-compute=false&includeDetails=true&pageable=%5Bobject+Object%5D")package main
import (
"fmt"
"net/http"
"io/ioutil"
)
func main() {
url := "https://api.avisi.cloud/api/v1/orgs/string/clusters/string?show-compute=false&includeDetails=true&pageable=%5Bobject+Object%5D"
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?show-compute=false&includeDetails=true&pageable=%5Bobject+Object%5D"
response = requests.request("GET", url)
print(response.text){
"totalElements": 0,
"totalPages": 0,
"first": true,
"last": true,
"size": 0,
"content": [
{
"name": "string",
"identity": "10a80a7a-1a32-4a74-b592-aa2a4ef691c5",
"environmentIdentity": "bb451031-60ba-4fcd-9556-56368eb5c985",
"maintenanceSchedule": {
"identity": "10a80a7a-1a32-4a74-b592-aa2a4ef691c5",
"name": "string",
"clusterCount": 0,
"windows": [
{
"day": "MONDAY",
"startTime": "string",
"duration": 0
}
]
},
"environmentSlug": {
"slugValue": "string"
},
"customerIdentity": "e7596901-a2e3-4b7e-9dd1-f11d0f6765a7",
"customerSlug": {
"slugValue": "string"
},
"poolID": 0,
"poolName": "string",
"slug": {
"slugValue": "string"
},
"description": "string",
"cloudProvider": "string",
"region": "string",
"version": "string",
"updateChannel": {
"name": "string",
"available": true,
"kubernetesClusterVersion": "string"
},
"autoUpgrade": true,
"highlyAvailable": true,
"enableNetworkEncryption": true,
"podSecurityStandardsProfile": "privileged",
"cni": "custom",
"enableMultiAvailabilityZones": true,
"enableNATGateway": true,
"serviceSubnet": "string",
"clusterPodSubnet": "string",
"status": "new",
"desiredStatus": "starting",
"provisionStatus": "UNKNOWN",
"createdAt": "2019-08-24T14:15:22Z",
"modifiedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"memory": 0,
"cpu": 0,
"ipWhitelist": [
{
"cidr": "string",
"description": "string"
}
],
"ameOIDC": true,
"deleteProtection": true,
"addons": {
"property1": {
"enabled": true,
"customValues": {
"property1": "string",
"property2": "string"
}
},
"property2": {
"enabled": true,
"customValues": {
"property1": "string",
"property2": "string"
}
}
},
"observabilityTenant": {
"id": 0,
"identity": "10a80a7a-1a32-4a74-b592-aa2a4ef691c5",
"customer": "string",
"name": "string",
"slug": "string",
"available": true,
"ipWhiteList": "string",
"createdAt": "2019-08-24T14:15:22Z",
"modifiedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"cluster": {
"id": 0,
"identity": "10a80a7a-1a32-4a74-b592-aa2a4ef691c5",
"name": "string",
"slug": "string",
"environmentSlug": "string",
"version": "string",
"deletedAt": "2019-08-24T14:15:22Z"
},
"environment": {
"id": 0,
"name": "string",
"slug": "string"
}
},
"environmentPrometheusRules": true,
"cloudAccount": {
"identity": "10a80a7a-1a32-4a74-b592-aa2a4ef691c5",
"displayName": "string",
"primaryCloudCredentials": {
"identity": "10a80a7a-1a32-4a74-b592-aa2a4ef691c5",
"displayName": "string",
"isPrimary": true
}
},
"cloudCredentials": {
"identity": "10a80a7a-1a32-4a74-b592-aa2a4ef691c5",
"displayName": "string",
"isPrimary": true
},
"actualState": {
"status": "string",
"version": "string",
"collectedAt": "2019-08-24T14:15:22Z"
},
"clusterAutoscalerSettings": {
"scale-down-utilization-threshold": 0.1,
"scale-down-gpu-utilization-threshold": 0.1,
"scale-down-delay-after-add": "string",
"scale-down-unneeded-time": "string",
"scale-down-unready-time": "string",
"max-node-provision-time": "string",
"unremovable-node-recheck-timeout": "string"
},
"upstreamCluster": {
"identity": "10a80a7a-1a32-4a74-b592-aa2a4ef691c5",
"slug": {
"slugValue": "string"
},
"environmentSlug": {
"slugValue": "string"
},
"version": "string"
}
}
],
"number": 0,
"sort": {
"empty": true,
"sorted": true,
"unsorted": true
},
"numberOfElements": 0,
"pageable": {
"offset": 0,
"sort": {
"empty": true,
"sorted": true,
"unsorted": true
},
"unpaged": true,
"paged": true,
"pageNumber": 0,
"pageSize": 0
},
"empty": true
}{
"message": "string",
"details": [
"string"
]
}{
"message": "string",
"details": [
"string"
]
}{
"message": "string",
"details": [
"string"
]
}{
"message": "string",
"details": [
"string"
]
}