Skip to main content

Get Cluster

Given a cluster slug, it returns the cluster info.

Obtain a single cluster

Obtain a single cluster, provided that it belongs to your organization.

curl -X 'GET' \
'https://api.gigapipe.com/v1/clusters/<your_cluster_slug>' \
-H 'accept: application/json' \
-H 'Authorization: Bearer <your_access_token>'
# Payload response ::Dictionary
{
"name": "Cluster Test",
"slug": "cluster-test",
"region": {
"name": "Ashburn, Virginia",
"code": "us-east-1"
},
"provider": {
"id": 2,
"name": "AWS"
},
"status": "Active",
"shards": 3,
"replicas": 1,
"user": {
"first_name": "John",
"last_name": "Doe"
},
"machine": {
"ram": 8,
"cpu": 2,
"id": 1,
"ram_unit": "Binary"
},
"disks": [
{
"type": {
"name": "gp2",
"price": 0.00000000045,
"unit": "Decimal"
},
"size": 150.0,
"unit": "GB",
"autoscaling": false
}
],
"created_at": "2022-02-14T10:11:26.567713"
}

Obtain all the clusters

Obtain a list of all the clusters of your organization.

curl -X 'GET' \
'https://api.gigapipe.com/v1/clusters' \
-H 'accept: application/json' \
-H 'Authorization: Bearer <your_access_token>'
# Payload response ::Dictionary
[
{
"name": "Cluster Test",
"slug": "cluster-test",
"region": {
"name": "Ashburn, Virginia",
"code": "us-east-1"
},
"provider": {
"id": 2,
"name": "AWS"
},
"status": "Active",
"shards": 3,
"replicas": 1,
"user": {
"first_name": "John",
"last_name": "Doe"
},
"machine": {
"ram": 8,
"cpu": 2,
"id": 1,
"ram_unit": "Binary"
},
"disks": [
{
"type": {
"name": "gp2",
"price": 0.00000000045,
"unit": "Decimal"
},
"size": 150.0,
"unit": "GB",
"autoscaling": false
}
],
"created_at": "2022-02-14T10:11:26.567713"
}
]

Query parameters

Only when getting a single cluster

Attributes


slug  ::String

The cluster slug you want to fetch


Cluster response

Attributes


name  ::String

The cluster name


slug  ::String

The cluster slug (made of the cluster name)


region  ::Dictionary

Region where the cluster is physically located

name  ::String

The region name

code  ::String

The region code according to its provider


provider  ::Dictionary

The cluster provider

id  ::Integer

The provider ID

name  ::String

The provider name (GCP, AWS, Digital Ocean...)


status  ::String

The cluster status (Creating, Active, Stopped, ...)


shard  ::Integer

The number of shards the cluster has


replicas  ::Integer

The number of replicas the cluster has


user  ::Dictionary

The user who created the cluster

first_name  ::String

The user's first name

last name  ::String

The user's last name


machine  ::Dictionary

The type of machine the cluster possesses

ram  ::Integer

The RAM of the machine (GB/GiB)

cpu  ::Integer

The number of cores the cluster CPU has


disks  ::List[Dictionary]

The cluster disks

type  ::Dictionary

name  ::String

The disk name

price  ::Float

The price per minute

unit  ::String

The unit the disk uses (Binary/Decimal)

size  ::Float

The disk size

unit  ::String

The disk unit (GB, TB, GiB, TiB)

autoscaling  ::Boolean

Whether the disks scales automatically

created_at  ::Datetime

When the cluster was created