Query Kubernetes Clusters for Microservice Governance - MSE - Alibaba Cloud - Microservices Engine

Queries Kubernetes clusters for microservice administration.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

mse:QueryGovernanceKubernetesCluster

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ClusterName	string	No	The name of the Kubernetes cluster.	example-cluster
ClusterId	string	No	The ID of the Kubernetes cluster.	c24c9354acxxxxxxx
PageNumber	integer	Yes	The page number.	1
PageSize	integer	Yes	The number of items per page.	10
AcceptLanguage	string	No	The language of the response. Valid values: `zh`: Chinese `en`: English	zh

Response elements

Element	Type	Description	Example
	object	The response object.
Message	string	The response message.	success
RequestId	string	The request ID.	DE34D413-2B79-5E77-9696-36D875E822AD
Data	object	The data returned in the response.
Result	array<object>	A list of cluster objects.
	object	Details of a cluster.
ClusterName	string	The cluster name.	example-cluster
ClusterId	string	The cluster ID.	abcdef123456789
Region	string	The region where the cluster is located.	cn-shanghai
K8sVersion	string	The Kubernetes version.	1.22
NamespaceInfos	string	A JSON string that contains an array of namespace objects.	[{"Name":"ack-onepilot","Tags":{"name":"ack-onepilot"}}]
PilotStartTime	string	The time when Pilot started, in UTC (ISO 8601 format).	2022-05-17T05:39:43.000+0000
VersionLifeCycle	string	The lifecycle status of the version.
PilotVersion	string	The Pilot version.
TotalSize	integer	The total number of clusters that match the query.	3
PageNumber	integer	The current page number.	1
PageSize	integer	The number of entries per page.	10
Success	boolean	Indicates whether the request was successful.	true

Examples

Success response

JSON format

{
  "Message": "success",
  "RequestId": "DE34D413-2B79-5E77-9696-36D875E822AD",
  "Data": {
    "Result": [
      {
        "ClusterName": "example-cluster",
        "ClusterId": "abcdef123456789",
        "Region": "cn-shanghai",
        "K8sVersion": "1.22",
        "NamespaceInfos": "[{\"Name\":\"ack-onepilot\",\"Tags\":{\"name\":\"ack-onepilot\"}}]",
        "PilotStartTime": "2022-05-17T05:39:43.000+0000",
        "VersionLifeCycle": "",
        "PilotVersion": ""
      }
    ],
    "TotalSize": 3,
    "PageNumber": 1,
    "PageSize": 10
  },
  "Success": true
}

Error codes

HTTP status code	Error code	Error message	Description
400	IllegalRequest	Invalid request:%s	Invalid request: %s
400	InvalidParameter	Parameter error:%s	Request parameter error: %s
500	InternalError	Console error. Try again later:%s	Console error. Try again later: %s
403	NoPermission	You are not authorized to perform this operation:%s	You do not have the permission to use this interface:%s
404	NotFound	Not found:%s	The resource does not exist:%s

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.