GetGovernanceKubernetesCluster - 查询已接入服务治理的集群信息 - 微服务引擎MSE

获取服务治理的kubernetes集群信息。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
mse:GetGovernanceKubernetesCluster	get	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	集群所在地域，MSE 支持的地域。	cn-hangzhou
ClusterId	string	是	集群 ID。	cd23228b3c80c4d4f9ad7af1d87cc****
AcceptLanguage	string	否	返回信息的语言类型： zh：中文 en：英文	zh

返回参数

名称	类型	描述	示例值
	object	数据结构。
Message	string	返回信息。	success
RequestId	string	请求 ID。	5B170A0D-2C5D-4CF8-B808-03966B86****
Data	object	数据概览。
ClusterId	string	集群 ID。	cd23228b3c80c4d4f9ad7af1d87cc30d5
ClusterName	string	集群名称。	myCluster
Region	string	集群所在地域，MSE 支持的地域。	cn-hangzhou
K8sVersion	string	k8s 版本。	1.20.11-aliyun.1
NamespaceInfos	string	命名空间信息。	[{\"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	Pilot 启动时间。	2022-01-11T11:50:38.000+0000
UpdateTime	string	最后更新时间。	2022-01-12T05:24:31.000+0000
Namespaces	array<object>	命名空间列表。
KubernetesNamespace	object	命名空间结构。
Name	string	Kubernetes 命名空间名字。	default
MseNamespace	string	对应接入的 mse 命名空间名字。	default
Success	boolean	请求结果，取值如下： `true`：请求成功。 `false`：请求失败。	True

示例

正常返回示例

JSON格式

{
  "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"
      }
    ]
  },
  "Success": true
}

错误码

HTTP status code	错误码	错误信息	描述
400	IllegalRequest	Invalid request:%s	非法请求： %s
400	InvalidParameter	Parameter error:%s	请求参数错误：%s
403	NoPermission	You are not authorized to perform this operation:%s	没有权限使用此接口：%s
404	NotFound	Not found:%s	资源不存在：%s
500	InternalError	Console error. Try again later:%s	控制台错误.稍后重试：%s

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2023-09-05	OpenAPI 返回结构发生变更	查看变更详情
2023-08-11	OpenAPI 描述信息更新、OpenAPI 返回结构发生变更	查看变更详情
2023-06-26	OpenAPI 返回结构发生变更	查看变更详情