Cluster Metadata
Basic cluster information such as Grafana and ClickHouse endpoints, number of rows that have been inserted or cluster disks among many others.
Get the cluster metadata
Obtain a dictionary that contains the cluster metadata.
- Curl
- Python
curl -X 'GET' \
'https://api.gigapipe.com/v1/clusters/<your_cluster_slug>/metadata' \
-H 'accept: application/json' \
-H 'Authorization: Bearer <your_access_token>'
# Payload response ::Dictionary
{
"endpoint": "clickhouse_url",
"grafana_endpoint": "grafana_url",
"rows": 12693251072,
"disks": [
{
"name": "default",
"type": "local",
"free_space": 2693251072,
"total_space": 18211586048
},
...
]
}
response = gigapipe_client.clusters.get_metadata(
cluster_slug="your_cluster_slug"
)
# Payload response ::Dictionary
{
"endpoint": "clickhouse_url",
"grafana_endpoint": "grafana_url",
"rows": 12693251072,
"disks": [
{
"name": "default",
"type": "local",
"free_space": 2693251072,
"total_space": 18211586048
},
...
]
}
Metadata parameters
Attributes
slug ::String
The cluster slug you want to get the metadata from
The metadata response
Attributes
endpoint ::String
The ClickHouse URL of your cluster
grafana_endpoint ::String
The Grafana URL of your cluster
rows ::Integer
The number of rows that have been inserted to the cluster so far
disks ::Dictionary
name ::String
The disk name (always 'default' if it's the first disk or there is only one)
type ::String
The disk type (ssd, hdd, gp2, ...)
free_space ::Integer
The free space (in bytes)
total_space ::Integer
The total space (in bytes)