文档

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

更新时间:

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

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
ClusterNamestring

Kubernetes 集群名。

example-cluster
ClusterIdstring

Kubernetes 集群 ID。

c24c9354acxxxxxxx
PageNumberinteger

当前页码。

1
PageSizeinteger

每页元素数量。

10
AcceptLanguagestring

返回信息的语言类型:

  • zh:中文
  • en:英文
zh

返回参数

名称类型描述示例值
object

数据结构。

Messagestring

返回信息。

success
RequestIdstring

请求 ID。

DE34D413-2B79-5E77-9696-36D875E822AD
Dataobject

响应数据。

Resultobject []

数据结构。

ClusterNamestring

集群名字。

example-cluster
ClusterIdstring

集群 ID。

abcdef123456789
Regionstring

集群所在地域。

cn-shanghai
K8sVersionstring

集群版本。

1.22
NamespaceInfosstring

命名空间信息。

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

Pilot 启动时间。

2022-05-17T05:39:43.000+0000
TotalSizeinteger

集群总数。

3
PageNumberinteger

当前页码。

1
PageSizeinteger

当前页大小。

10
Successboolean

是否成功。

true

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息描述
400IllegalRequestInvalid request:%s非法请求: %s
400InvalidParameterParameter error:%s请求参数错误:%s
403NoPermissionYou are not authorized to perform this operation:%s没有权限使用此接口:%s
404NotFoundNot found:%s资源不存在:%s
500InternalErrorConsole error. Try again later:%s控制台错误.稍后重试:%s

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

变更历史

变更时间变更内容概要操作
2023-05-10OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:500
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)
文档反馈