首页 微服务引擎MSE API参考指南 API目录 微服务治理中心 K8s集群治理 QueryGovernanceKubernetesCluster - 获取微服务治理K8s集群信息列表

QueryGovernanceKubernetesCluster - 获取微服务治理K8s集群信息列表

获取微服务治理K8s集群信息列表。

调试

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

调试

授权信息

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

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

请求参数

名称 类型 必填 描述 示例值
ClusterName string

Kubernetes集群名。

example-cluster
ClusterId string

Kubernetes集群ID。

c24c9354acxxxxxxx
PageNumber integer

当前页码。

1
PageSize integer

每页元素数量。

10
AcceptLanguage string

返回信息的语言类型:

  • zh:中文
  • en:英文
zh

返回参数

名称 类型 描述 示例值
object

数据结构。

HttpStatusCode integer

HTTP状态码。

200
Message string

返回信息。

success
RequestId string

请求ID。

DE34D413-2B79-5E77-9696-36D875E822AD
Data object

响应数据。

Result array

数据结构。

object

数据结构。

ClusterName string

集群名字。

example-cluster
ClusterId string

集群ID。

abcdef123456789
Region string

集群所在地域。

cn-shanghai
K8sVersion string

集群版本。

1.22
NamespaceInfos string

命名空间信息。

[{"Name":"ack-onepilot","Tags":{"name":"ack-onepilot"}}]
PilotStartTime string

Pilot启动时间。

2022-05-17T05:39:43.000+0000
TotalSize integer

集群总数。

3
PageNumber integer

当前页码。

1
PageSize integer

当前页大小。

10
Code integer

业务状态码。

200
Success boolean

是否成功。

true

示例

正常返回示例

JSON格式

{
  "HttpStatusCode": 200,
  "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"
      }
    ],
    "TotalSize": 3,
    "PageNumber": 1,
    "PageSize": 10
  },
  "Code": 200,
  "Success": true
}

错误码

Http code 错误码 错误信息 描述
400 duplicatedClusterAliasName duplicated cluster alias name 实例名称已重复,请换一个
400 illegalRequest illegal request:%s 非法请求:%s
400 invalidParameter parameter error:%s 请求入参异常:%s
403 NoPermission You are not authorized to perform this operation. 没有权限使用此接口
404 clusterNotFound cluster not found 找不到此集群
500 systemError system error 系统开小差了,请稍后重试
500 regcenterError register center error:%s 注册配置中心请求错误:%s

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

阿里云首页 微服务引擎 相关技术圈