List
Retrieves the list of Helm releases in the specified Kubernetes Cluster.
- TypeScript
- Python
import { cloudApi, serviceClients, Session } from "@yandex-cloud/nodejs-sdk";
const ListHelmReleasesRequest =
cloudApi.k8s.marketplace_helm_release_service.ListHelmReleasesRequest;
(async () => {
const authToken = process.env["YC_OAUTH_TOKEN"];
const session = new Session({ oauthToken: authToken });
const client = session.client(serviceClients.HelmReleaseServiceClient);
const result = await client.list(
ListHelmReleasesRequest.fromPartial({
clusterId: "clusterId",
// pageSize: 0,
// pageToken: "pageToken"
})
);
console.log(result);
})();
import os
import grpc
import yandexcloud
from yandex.cloud.k8s.marketplace.v1.helm_release_service_pb2_grpc import HelmReleaseServiceStub
from yandex.cloud.k8s.marketplace.v1.helm_release_service_pb2 import ListHelmReleasesRequest
token = os.getenv("YC_OAUTH_TOKEN")
sdk = yandexcloud.SDK(token=token)
service = sdk.client(HelmReleaseServiceStub)
response = service.List(
ListHelmReleasesRequest(
cluster_id="clusterId",
# page_size = 0,
# page_token = "pageToken"
)
)
print(response)
ListHelmReleasesRequest
clusterId
: string
The ID of the Kubernetes cluster to list Helm releases from.
pageSize
: int64
The maximum number of results per page that should be returned.
pageToken
: string
Token for pagination to retrieve the next page of results.
ListHelmReleasesResponse
helmReleases
: HelmRelease
List of Helm releases in the Kubernetes cluster.
nextPageToken
: string
Token for retrieving the next page of Helm releases.
HelmRelease
A Helm Release.
Status
STATUS_UNSPECIFIED
UNKNOWN
Helm release status is unknown
DEPLOYED
Helm release deployed.
UNINSTALLED
Helm release uninstalled.
SUPERSEDED
Helm release superseded.
FAILED
Helm release installation failed.
UNINSTALLING
Helm release is being uninstalled.
PENDING_INSTALL
Helm release is to be installed.
PENDING_UPGRADE
Helm release is to be updated.
PENDING_ROLLBACK
Helm release is to be rolled back.
id
: string
ID of a helm release.
clusterId
: string
ID of the Kubernetes cluster.
appName
: string
Name of the application.
appNamespace
: string
Namespace of the application.
productId
: string
Kubernetes marketplace product id.
productName
: string
Kubernetes marketplace product name.
productVersion
: string
Kubernetes marketplace product version.
status
: Status
Status of a helm release.
createdAt
: google.protobuf.Timestamp
Creation timestamp.