Ytsaurus API, gRPC: ClusterService.Get
Returns the specified cluster.
gRPC request
rpc Get (GetClusterRequest) returns (Cluster)
GetClusterRequest
{
"cluster_id": "string"
}
|
Field |
Description |
|
cluster_id |
string Required field. ID of the cluster to return. |
Cluster
{
"id": "string",
"folder_id": "string",
"zone_id": "string",
"name": "string",
"description": "string",
"labels": "map<string, string>",
"subnet_id": "string",
"security_group_ids": [
"string"
],
"spec": {
"storage": {
"hdd": {
"size_gb": "int64",
"count": "int64"
},
"ssd": {
"size_gb": "int64",
"type": "string",
"count": "int64"
}
},
"compute": [
{
"preset": "string",
"disks": [
{
"type": "string",
"size_gb": "int64",
"locations": [
"string"
]
}
],
"scale_policy": {
// Includes only one of the fields `fixed`, `auto`
"fixed": {
"size": "int64"
},
"auto": {
"min_size": "int64",
"max_size": "int64"
}
// end of the list of possible fields
},
"name": "string"
}
],
"tablet": {
"preset": "string",
"count": "int64"
},
"proxy": {
"http": {
"count": "int64"
},
"rpc": {
"count": "int64"
}
},
"odin": {
"checks_ttl": "google.protobuf.Duration"
},
"flavor": "Flavor"
},
"created_at": "google.protobuf.Timestamp",
"created_by": "string",
"updated_at": "google.protobuf.Timestamp",
"updated_by": "string",
"status": "Status",
"health": "Health",
"endpoints": {
"ui": "string",
"external_http_proxy_balancer": "string",
"internal_http_proxy_alias": "string",
"internal_rpc_proxy_alias": "string"
}
}
|
Field |
Description |
|
id |
string ID of the cluster. Generated at creation time. |
|
folder_id |
string ID of the folder that the cluster belongs to. |
|
zone_id |
string ID of the availability zone where the cluster resides. |
|
name |
string Name of the cluster. |
|
description |
string Description of the cluster. |
|
labels |
object (map<string, string>) Cluster labels as |
|
subnet_id |
string ID of the subnet where the cluster resides. |
|
security_group_ids[] |
string Network interfaces security groups. |
|
spec |
Cluster specification. |
|
created_at |
Time when the cluster was created. |
|
created_by |
string User who created the cluster. |
|
updated_at |
Time when the cluster was last updated. |
|
updated_by |
string User who last updated the cluster. |
|
status |
enum Status Status of the cluster.
|
|
health |
enum Health Health of the cluster.
|
|
endpoints |
Endpoints of the cluster. |
ClusterSpec
|
Field |
Description |
|
storage |
|
|
compute[] |
|
|
tablet |
|
|
proxy |
|
|
odin |
|
|
flavor |
enum Flavor
|
StorageSpec
|
Field |
Description |
|
hdd |
|
|
ssd |
HddSpec
|
Field |
Description |
|
size_gb |
int64 |
|
count |
int64 |
SsdSpec
|
Field |
Description |
|
size_gb |
int64 |
|
type |
string |
|
count |
int64 |
ComputeSpec
|
Field |
Description |
|
preset |
string |
|
disks[] |
|
|
scale_policy |
|
|
name |
string Name for exec pool. |
DiskSpec
|
Field |
Description |
|
type |
string |
|
size_gb |
int64 |
|
locations[] |
string |
ScalePolicy
|
Field |
Description |
|
fixed |
Includes only one of the fields |
|
auto |
Includes only one of the fields |
FixedScale
|
Field |
Description |
|
size |
int64 |
AutoScale
|
Field |
Description |
|
min_size |
int64 |
|
max_size |
int64 |
TabletSpec
|
Field |
Description |
|
preset |
string |
|
count |
int64 |
ProxySpec
|
Field |
Description |
|
http |
|
|
rpc |
HttpProxySpec
|
Field |
Description |
|
count |
int64 |
RpcProxySpec
|
Field |
Description |
|
count |
int64 |
OdinSpec
|
Field |
Description |
|
checks_ttl |
Endpoints
|
Field |
Description |
|
ui |
string https://CID.ui.ytsaurus.yandexcloud.net |
|
external_http_proxy_balancer |
string https://CID.proxy.ytsaurus.yandexcloud.net |
|
internal_http_proxy_alias |
string https://hp.CID.ytsaurus.mdb.yandexcloud.net:PORT |
|
internal_rpc_proxy_alias |
string rp.CID.ytsaurus.mdb.yandexcloud.net:PORT |