Skip to main content
API docs by Redocly

public/portworx/platform/targetcluster/apiv1/targetcluster.proto (version not set)

Download OpenAPI specification:Download

TargetClusterService

List API lists all the target clusters for a tenant

query Parameters
tenantId
required
string

List target clusters associated with a tenant.

pagination.pageNumber
string <int64>

Page number is the page number to return based on the size.

pagination.pageSize
string <int64>

Page size is the maximum number of records to include per page.

sort.sortBy
string
Default: "FIELD_UNSPECIFIED"
Enum: "FIELD_UNSPECIFIED" "NAME" "CREATED_AT" "UPDATED_AT" "PHASE"

Name of the attribute to sort results by.

  • FIELD_UNSPECIFIED: Unspecified, do not use.
  • NAME: Sorting based on the name of the resource.
  • CREATED_AT: Sorting on create time of the resource.
  • UPDATED_AT: Sorting on update time of the resource.
  • PHASE: Sorting on phase of the resource.
sort.sortOrder
string
Default: "VALUE_UNSPECIFIED"
Enum: "VALUE_UNSPECIFIED" "ASC" "DESC"

Order of sorting to be applied on requested list. If sort_by having some value and sort_order is not provided, by default ascending order will be used to sort the list.

  • VALUE_UNSPECIFIED: Unspecified, do not use.
  • ASC: Sort order ascending.
  • DESC: Sort order descending.
respData
string
Default: "RESP_DATA_UNSPECIFIED"
Enum: "RESP_DATA_UNSPECIFIED" "INDEX" "LITE" "FULL"

Response data flags for listing target clusters.

  • RESP_DATA_UNSPECIFIED: RespData Unspecified. complete resource will be populated.
  • INDEX: only uid, name, labels should be populated.
  • LITE: only meta data should be populated.
  • FULL: complete resource should be populated.

Responses

Response samples

Content type
application/json
{
  • "clusters": [
    ],
  • "pagination": {
    }
}

GetTargetCluster API returns the info about the TargetCluster for given name.

path Parameters
id
required
string

Unique identifier of the cluster whose details needs to be fetched.

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "config": { },
  • "status": {
    }
}

DeleteTargetCluster API deletes the specified TargetCluster.

path Parameters
id
required
string

Unique identifier of the cluster whose details needs to be fetched.

query Parameters
force
boolean

Flag to indicate force delete.

Responses

Response samples

Content type
application/json
{ }

UpdateTargetCluster API updates the metadata(e.g name/labels/annotations and desc) of the specified TargetCluster.

path Parameters
targetCluster.meta.uid
required
string

UID of the resource of the format -.

Request Body schema: application/json
required

Target cluster details.

object (Metadata of the target cluster(Resource Meta).)

Metadata of the target cluster(Resource Meta).

config
object (platformTargetClusterv1Config)

Desired configuration of the Target Cluster.

object (platformTargetClusterv1Status)

Status of the Target Cluster.

Responses

Request samples

Content type
application/json
{
  • "meta": {
    },
  • "config": { },
  • "status": {
    }
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "config": { },
  • "status": {
    }
}

List API lists all the target clusters for a tenant

Request Body schema: application/json
required

ListTargetClusterRequest is a request message to the List TargetCluster API.

tenantId
required
string

List target clusters associated with a tenant.

object (v1PageBasedPaginationRequest)

Request parameters for page-based pagination.

object (v1Selector)

Selector is used to query resources using the associated labels or field names.

object (v1Selector)

Selector is used to query resources using the associated labels or field names.

object (v1ResourceSelector)

ResourceSelector is used to query resources using the associated infra resources.

object (v1Sort)

The details of the attribute for which the requested list of resource to be sorted.

respData
string (v1RespData)
Default: "RESP_DATA_UNSPECIFIED"
Enum: "RESP_DATA_UNSPECIFIED" "INDEX" "LITE" "FULL"

RespData provides flags which provides info about the fields that should be populated in the response.

  • RESP_DATA_UNSPECIFIED: RespData Unspecified. complete resource will be populated.
  • INDEX: only uid, name, labels should be populated.
  • LITE: only meta data should be populated.
  • FULL: complete resource should be populated.

Responses

Request samples

Content type
application/json
{
  • "tenantId": "string",
  • "pagination": {
    },
  • "labelSelector": {
    },
  • "fieldSelector": {
    },
  • "infraResourceSelector": {
    },
  • "sort": {
    },
  • "respData": "RESP_DATA_UNSPECIFIED"
}

Response samples

Content type
application/json
{
  • "clusters": [
    ],
  • "pagination": {
    }
}