GetGovernanceKubernetesCluster - Microservices Engine - Alibaba Cloud Documentation Center

Queries information about a Container Service for Kubernetes (ACK) cluster that has Microservices Governance enabled.

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:GetGovernanceKubernetesCluster

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region where the cluster is located. MSE supports specific regions.	cn-hangzhou
ClusterId	string	Yes	The cluster ID.	cd23228b3c80c4d4f9ad7af1d87cc****
AcceptLanguage	string	No	The language of the response. Valid values: zh: Chinese. en: English.	zh

Response elements

Parameter	Type	Description	Example
	object	The data structure.
Message	string	The information that is returned.	success
RequestId	string	The request ID.	5B170A0D-2C5D-4CF8-B808-03966B86****
Data	object	The data overview.
ClusterId	string	The cluster ID.	cd23228b3c80c4d4f9ad7af1d87cc30d5
ClusterName	string	The cluster name.	myCluster
Region	string	The region where the cluster is located. MSE supports specific regions.	cn-hangzhou
K8sVersion	string	The Kubernetes version.	1.20.11-aliyun.1
NamespaceInfos	string	The information about namespaces.	[{\"Name\":\"ack-onepilot\",\"Tags\":null},{\"Name\":\"default\",\"Tags\":{\"mse-enable\":\"enabled\"}},{\"Name\":\"kube-node-lease\",\"Tags\":null},{\"Name\":\"kube-public\",\"Tags\":null},{\"Name\":\"kube-system\",\"Tags\":null}]
PilotStartTime	string	The Pilot startup time.	2022-01-11T11:50:38.000+0000
UpdateTime	string	The time when the UDF was last modified.	2022-01-12T05:24:31.000+0000
Namespaces	array	The list of namespaces.
	object	The namespace structure.
Name	string	The Kubernetes namespace name.	default
MseNamespace	string	The corresponding MSE namespace name.	default
PilotVersion	string	The ack-onepilot component version
VersionLifeCycle	string	The version lifecycle.
Success	boolean	Indicates whether the request was successful. Valid values: `true`: The request was successful. `false`: The request failed.	True

Examples

Success response

JSON format

{
  "Message": "success",
  "RequestId": "5B170A0D-2C5D-4CF8-B808-03966B86****",
  "Data": {
    "ClusterId": "cd23228b3c80c4d4f9ad7af1d87cc30d5",
    "ClusterName": "myCluster",
    "Region": "cn-hangzhou",
    "K8sVersion": "1.20.11-aliyun.1",
    "NamespaceInfos": "[{\\\"Name\\\":\\\"ack-onepilot\\\",\\\"Tags\\\":null},{\\\"Name\\\":\\\"default\\\",\\\"Tags\\\":{\\\"mse-enable\\\":\\\"enabled\\\"}},{\\\"Name\\\":\\\"kube-node-lease\\\",\\\"Tags\\\":null},{\\\"Name\\\":\\\"kube-public\\\",\\\"Tags\\\":null},{\\\"Name\\\":\\\"kube-system\\\",\\\"Tags\\\":null}]",
    "PilotStartTime": "2022-01-11T11:50:38.000+0000",
    "UpdateTime": "2022-01-12T05:24:31.000+0000",
    "Namespaces": [
      {
        "Name": "default",
        "MseNamespace": "default"
      }
    ],
    "PilotVersion": "",
    "VersionLifeCycle": ""
  },
  "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.