Managed Services for Kubernetes API, REST: Cluster.Get

Статья создана

Обновлена 17 октября 2024 г.

HTTP request
Path parameters
Response
Master
ZonalMaster
RegionalMaster
Location
MasterEndpoints
MasterAuth
VersionInfo
MasterMaintenancePolicy
MaintenanceWindow
DailyMaintenanceWindow
TimeOfDay
WeeklyMaintenanceWindow
DaysOfWeekMaintenanceWindow
MasterLogging
IPAllocationPolicy
NetworkPolicy
KMSProvider
Cilium

Returns the specified Kubernetes cluster.

To get the list of available Kubernetes cluster, make a List request.

HTTP request

GET https://mks.api.cloud.yandex.net/managed-kubernetes/v1/clusters/{clusterId}

Path parameters

Field

Description

clusterId

string

Required field. ID of the Kubernetes cluster to return.

Response

HTTP Code: 200 - OK

{
  "id": "string",
  "folderId": "string",
  "createdAt": "string",
  "name": "string",
  "description": "string",
  "labels": "string",
  "status": "string",
  "health": "string",
  "networkId": "string",
  "master": {
    // Includes only one of the fields `zonalMaster`, `regionalMaster`
    "zonalMaster": {
      "zoneId": "string",
      "internalV4Address": "string",
      "externalV4Address": "string"
    },
    "regionalMaster": {
      "regionId": "string",
      "internalV4Address": "string",
      "externalV4Address": "string",
      "externalV6Address": "string"
    },
    // end of the list of possible fields
    "locations": [
      {
        "zoneId": "string",
        "subnetId": "string"
      }
    ],
    "etcdClusterSize": "string",
    "version": "string",
    "endpoints": {
      "internalV4Endpoint": "string",
      "externalV4Endpoint": "string",
      "externalV6Endpoint": "string"
    },
    "masterAuth": {
      "clusterCaCertificate": "string"
    },
    "versionInfo": {
      "currentVersion": "string",
      "newRevisionAvailable": "boolean",
      "newRevisionSummary": "string",
      "versionDeprecated": "boolean"
    },
    "maintenancePolicy": {
      "autoUpgrade": "boolean",
      "maintenanceWindow": {
        // Includes only one of the fields `anytime`, `dailyMaintenanceWindow`, `weeklyMaintenanceWindow`
        "anytime": "object",
        "dailyMaintenanceWindow": {
          "startTime": {
            "hours": "integer",
            "minutes": "integer",
            "seconds": "integer",
            "nanos": "integer"
          },
          "duration": "string"
        },
        "weeklyMaintenanceWindow": {
          "daysOfWeek": [
            {
              "days": [
                "string"
              ],
              "startTime": {
                "hours": "integer",
                "minutes": "integer",
                "seconds": "integer",
                "nanos": "integer"
              },
              "duration": "string"
            }
          ]
        }
        // end of the list of possible fields
      }
    },
    "securityGroupIds": [
      "string"
    ],
    "masterLogging": {
      "enabled": "boolean",
      // Includes only one of the fields `logGroupId`, `folderId`
      "logGroupId": "string",
      "folderId": "string",
      // end of the list of possible fields
      "auditEnabled": "boolean",
      "clusterAutoscalerEnabled": "boolean",
      "kubeApiserverEnabled": "boolean",
      "eventsEnabled": "boolean"
    }
  },
  "ipAllocationPolicy": {
    "clusterIpv4CidrBlock": "string",
    "nodeIpv4CidrMaskSize": "string",
    "serviceIpv4CidrBlock": "string",
    "clusterIpv6CidrBlock": "string",
    "serviceIpv6CidrBlock": "string"
  },
  // Includes only one of the fields `gatewayIpv4Address`
  "gatewayIpv4Address": "string",
  // end of the list of possible fields
  "serviceAccountId": "string",
  "nodeServiceAccountId": "string",
  "releaseChannel": "string",
  "networkPolicy": {
    "provider": "string"
  },
  "kmsProvider": {
    "keyId": "string"
  },
  "logGroupId": "string",
  // Includes only one of the fields `cilium`
  "cilium": {
    "routingMode": "string"
  }
  // end of the list of possible fields
}

A Kubernetes cluster.

Field	Description
id	string ID of the Kubernetes cluster.
folderId	string ID of the folder that the Kubernetes cluster belongs to.
createdAt	string (date-time) Creation timestamp. String in RFC3339 text format. The range of possible values is from `0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).
name	string Name of the Kubernetes cluster.
description	string Description of the Kubernetes cluster. 0-256 characters long.
labels	string Resource labels as `key:value` pairs. Maximum of 64 per resource.
status	enum (Status) Status of the Kubernetes cluster. `STATUS_UNSPECIFIED` `PROVISIONING`: Kubernetes cluster is waiting for resources to be allocated. `RUNNING`: Kubernetes cluster is running. `RECONCILING`: Kubernetes cluster is being reconciled. `STOPPING`: Kubernetes cluster is being stopped. `STOPPED`: Kubernetes cluster stopped. `DELETING`: Kubernetes cluster is being deleted. `STARTING`: Kubernetes cluster is being started.
health	enum (Health) Health of the Kubernetes cluster. `HEALTH_UNSPECIFIED` `HEALTHY`: Kubernetes cluster is alive and well. `UNHEALTHY`: Kubernetes cluster is inoperable.
networkId	string ID of the network the Kubernetes cluster belongs to.
master	Master Properties of the master for the Kubernetes cluster.
ipAllocationPolicy	IPAllocationPolicy Allocation policy for IP addresses of services and pods inside the Kubernetes cluster in different availability zones.
gatewayIpv4Address	string Gateway IPv4 address. Includes only one of the fields `gatewayIpv4Address`.
serviceAccountId	string Service account to be used for provisioning Compute Cloud and VPC resources for Kubernetes cluster.
nodeServiceAccountId	string Service account to be used by the worker nodes of the Kubernetes cluster to access Container Registry or to push node logs and metrics.
releaseChannel	enum (ReleaseChannel) When creating a Kubernetes cluster, you should specify one of three release channels. The release channel contains several Kubernetes versions. Channels differ in the set of available versions, the management of auto-updates, and the updates received. You can't change the channel once the Kubernetes cluster is created, you can only recreate the Kubernetes cluster and specify a new release channel. For more details see documentation. `RELEASE_CHANNEL_UNSPECIFIED` `RAPID`: Minor updates with new functions and improvements are often added. You can't disable automatic updates in this channel, but you can specify a time period for automatic updates. `REGULAR`: New functions and improvements are added in chunks shortly after they appear on `RAPID`. `STABLE`: Only updates related to bug fixes or security improvements are added.
networkPolicy	NetworkPolicy
kmsProvider	KMSProvider KMS provider configuration.
logGroupId	string Log group where cluster stores cluster system logs, like audit, events, or controlplane logs.
cilium	Cilium Includes only one of the fields `cilium`.

Master

Field	Description
zonalMaster	ZonalMaster Parameters of the availability zone for the master. Includes only one of the fields `zonalMaster`, `regionalMaster`.
regionalMaster	RegionalMaster Parameters of the region for the master. Includes only one of the fields `zonalMaster`, `regionalMaster`.
locations[]	Location Locations specification for Kubernetes control-plane (master) instances.
etcdClusterSize	string (int64) Number of etcd nodes in cluster.
version	string Version of Kubernetes components that runs on the master.
endpoints	MasterEndpoints Endpoints of the master. Endpoints constitute of scheme and port (i.e. `https://ip-address:port`) and can be used by the clients to communicate with the Kubernetes API of the Kubernetes cluster.
masterAuth	MasterAuth Master authentication parameters are used to establish trust between the master and a client.
versionInfo	VersionInfo Detailed information about the Kubernetes version that is running on the master.
maintenancePolicy	MasterMaintenancePolicy Maintenance policy of the master.
securityGroupIds[]	string Master security groups.
masterLogging	MasterLogging Cloud Logging for master components.

ZonalMaster

Field	Description
zoneId	string ID of the availability zone where the master resides.
internalV4Address	string IPv4 internal network address that is assigned to the master.
externalV4Address	string IPv4 external network address that is assigned to the master.

RegionalMaster

Field	Description
regionId	string ID of the region where the master resides.
internalV4Address	string IPv4 internal network address that is assigned to the master.
externalV4Address	string IPv4 external network address that is assigned to the master.
externalV6Address	string IPv6 external network address that is assigned to the master.

Location

Field

Description

zoneId

string

ID of the availability zone where the master resides.

subnetId

string

ID of the VPC network's subnet where the master resides.

MasterEndpoints

Field	Description
internalV4Endpoint	string Internal endpoint that can be used to connect to the master from cloud networks.
externalV4Endpoint	string External endpoint that can be used to access Kubernetes cluster API from the internet (outside of the cloud).
externalV6Endpoint	string External IPv6 endpoint that can be used to access Kubernetes cluster API from the internet (outside of the cloud).

MasterAuth

Field

Description

clusterCaCertificate

string

PEM-encoded public certificate that is the root of trust for the Kubernetes cluster.

VersionInfo

Field	Description
currentVersion	string Current Kubernetes version, format: major.minor (e.g. 1.15).
newRevisionAvailable	boolean Newer revisions may include Kubernetes patches (e.g 1.15.1 -> 1.15.2) as well as some internal component updates - new features or bug fixes in platform specific components either on the master or nodes.
newRevisionSummary	string Description of the changes to be applied when updating to the latest revision. Empty if new_revision_available is false.
versionDeprecated	boolean The current version is on the deprecation schedule, component (master or node group) should be upgraded.

MasterMaintenancePolicy

Field

Description

autoUpgrade

boolean

If set to true, automatic updates are installed in the specified period of time with no interaction from the user.
If set to false, automatic upgrades are disabled.

maintenanceWindow

MaintenanceWindow

Maintenance window settings. Update will start at the specified time and last no more than the specified duration.
The time is set in UTC.

MaintenanceWindow

Field	Description
anytime	object Updating the master at any time. Includes only one of the fields `anytime`, `dailyMaintenanceWindow`, `weeklyMaintenanceWindow`. Maintenance policy.
dailyMaintenanceWindow	DailyMaintenanceWindow Updating the master on any day during the specified time window. Includes only one of the fields `anytime`, `dailyMaintenanceWindow`, `weeklyMaintenanceWindow`. Maintenance policy.
weeklyMaintenanceWindow	WeeklyMaintenanceWindow Updating the master on selected days during the specified time window. Includes only one of the fields `anytime`, `dailyMaintenanceWindow`, `weeklyMaintenanceWindow`. Maintenance policy.

DailyMaintenanceWindow

Field

Description

startTime

TimeOfDay

Required field. Window start time, in the UTC timezone.

duration

string (duration)

Window duration.

Represents a time of day. The date and time zone are either not significant
or are specified elsewhere. An API may choose to allow leap seconds. Related
types are google.type.Date and google.protobuf.Timestamp.

Field	Description
hours	integer (int32) Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
minutes	integer (int32) Minutes of hour of day. Must be from 0 to 59.
seconds	integer (int32) Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
nanos	integer (int32) Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

WeeklyMaintenanceWindow

Field

Description

daysOfWeek[]

DaysOfWeekMaintenanceWindow

Days of the week and the maintenance window for these days when automatic updates are allowed.

DaysOfWeekMaintenanceWindow

Field	Description
days[]	enum (DayOfWeek) Days of the week when automatic updates are allowed. `DAY_OF_WEEK_UNSPECIFIED`: The unspecified day-of-week. `MONDAY`: The day-of-week of Monday. `TUESDAY`: The day-of-week of Tuesday. `WEDNESDAY`: The day-of-week of Wednesday. `THURSDAY`: The day-of-week of Thursday. `FRIDAY`: The day-of-week of Friday. `SATURDAY`: The day-of-week of Saturday. `SUNDAY`: The day-of-week of Sunday.
startTime	TimeOfDay Required field. Window start time, in the UTC timezone.
duration	string (duration) Window duration.

MasterLogging

Field	Description
enabled	boolean Identifies whether Cloud Logging is enabled for master components.
logGroupId	string ID of the log group where logs of master components should be stored. Includes only one of the fields `logGroupId`, `folderId`. The destination of master components' logs.
folderId	string ID of the folder where logs should be stored (in default group). Includes only one of the fields `logGroupId`, `folderId`. The destination of master components' logs.
auditEnabled	boolean Identifies whether Cloud Logging is enabled for audit logs.
clusterAutoscalerEnabled	boolean Identifies whether Cloud Logging is enabled for cluster-autoscaler.
kubeApiserverEnabled	boolean Identifies whether Cloud Logging is enabled for kube-apiserver.
eventsEnabled	boolean Identifies whether Cloud Logging is enabled for events.

IPAllocationPolicy

Field	Description
clusterIpv4CidrBlock	string CIDR block. IP range for allocating pod addresses. It should not overlap with any subnet in the network the Kubernetes cluster located in. Static routes will be set up for this CIDR blocks in node subnets.
nodeIpv4CidrMaskSize	string (int64) Size of the masks that are assigned for each node in the cluster. If not specified, 24 is used.
serviceIpv4CidrBlock	string CIDR block. IP range Kubernetes service Kubernetes cluster IP addresses will be allocated from. It should not overlap with any subnet in the network the Kubernetes cluster located in.
clusterIpv6CidrBlock	string IPv6 range for allocating pod IP addresses.
serviceIpv6CidrBlock	string IPv6 range for allocating Kubernetes service IP addresses

NetworkPolicy

Field

Description

provider

enum (Provider)

PROVIDER_UNSPECIFIED
CALICO

KMSProvider

Field

Description

keyId

string

KMS key ID for secrets encryption.
To obtain a KMS key ID use a yandex.cloud.kms.v1.SymmetricKeyService.List request.

Cilium

Field

Description

routingMode

enum (RoutingMode)

ROUTING_MODE_UNSPECIFIED
TUNNEL

Managed Services for Kubernetes API, REST: Cluster.Get

HTTP requestHTTP request

Path parametersPath parameters

ResponseResponse

MasterMaster

ZonalMasterZonalMaster

RegionalMasterRegionalMaster

LocationLocation

MasterEndpointsMasterEndpoints

MasterAuthMasterAuth

VersionInfoVersionInfo

MasterMaintenancePolicyMasterMaintenancePolicy

MaintenanceWindowMaintenanceWindow

DailyMaintenanceWindowDailyMaintenanceWindow

TimeOfDayTimeOfDay

WeeklyMaintenanceWindowWeeklyMaintenanceWindow

DaysOfWeekMaintenanceWindowDaysOfWeekMaintenanceWindow

MasterLoggingMasterLogging

IPAllocationPolicyIPAllocationPolicy

NetworkPolicyNetworkPolicy

KMSProviderKMSProvider

CiliumCilium

Была ли статья полезна?

HTTP request

Path parameters

Response

Master

ZonalMaster

RegionalMaster

Location

MasterEndpoints

MasterAuth

VersionInfo

MasterMaintenancePolicy

MaintenanceWindow

DailyMaintenanceWindow

TimeOfDay

WeeklyMaintenanceWindow

DaysOfWeekMaintenanceWindow

MasterLogging

IPAllocationPolicy

NetworkPolicy

KMSProvider

Cilium