Kubernetes Marketplace, gRPC: HelmReleaseService.List
Retrieves the list of Helm releases in the specified Kubernetes Cluster.
gRPC request
rpc List (ListHelmReleasesRequest) returns (ListHelmReleasesResponse)
ListHelmReleasesRequest
{
"cluster_id": "string",
"page_size": "int64",
"page_token": "string"
}
|
Field |
Description |
|
cluster_id |
string Required field. The ID of the Kubernetes cluster to list Helm releases from. |
|
page_size |
int64 The maximum number of results per page that should be returned. Acceptable values are 0 to 1000, inclusive. |
|
page_token |
string Token for pagination to retrieve the next page of results. The maximum string length in characters is 100. |
ListHelmReleasesResponse
{
"helm_releases": [
{
"id": "string",
"cluster_id": "string",
"app_name": "string",
"app_namespace": "string",
"product_id": "string",
"product_name": "string",
"product_version": "string",
"status": "Status",
"created_at": "google.protobuf.Timestamp"
}
],
"next_page_token": "string"
}
|
Field |
Description |
|
helm_releases[] |
List of Helm releases in the Kubernetes cluster. |
|
next_page_token |
string Token for retrieving the next page of Helm releases. |
HelmRelease
A Helm Release.
|
Field |
Description |
|
id |
string ID of a Helm release. |
|
cluster_id |
string ID of the Kubernetes cluster. |
|
app_name |
string Name of the application. |
|
app_namespace |
string Namespace of the application. |
|
product_id |
string Kubernetes marketplace product ID. |
|
product_name |
string Kubernetes marketplace product name. |
|
product_version |
string Kubernetes marketplace product version. |
|
status |
enum Status Status of the Helm release.
|
|
created_at |
Creation timestamp. |