全部产品
Search
文档中心

边缘节点服务ENS:DescribeCluster - 查询边缘容器集群

更新时间:Oct 17, 2024

查询边缘容器集群。

接口说明

  • 单用户调用频率: 100 次/秒。

调试

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

授权信息

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

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

请求参数

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

集群 ID。

c8f0377146d104687ac562eef9403****

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

CEF72CEB-54B6-4AE8-B225-F876FF7BA984
Clustersarray<object>

集群信息列表。

Clustersobject

Kubernetes 集群实例。

Namestring

集群名称。

vc-a622bb**
ClusterIdstring

集群 ID。

c8f0377146d104687ac562eef9403****
CurrentVersionstring

当前集群的版本信息。

1.18.8
NextVersionstring

集群下一版本信息。

1.20.8
Statusstring

集群健康状态。

枚举值:
  • healthyhealthy
  • unhealthyunhealthy
healthy

示例

正常返回示例

JSON格式

{
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BA984",
  "Clusters": [
    {
      "Name": "vc-a622bb**",
      "ClusterId": "c8f0377146d104687ac562eef9403****",
      "CurrentVersion": "1.18.8",
      "NextVersion": "1.20.8",
      "Status": "healthy"
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
400BadRequest请求参数错误 -
400NoPermissionPermission denied.没有足够的权限,请联系云账号管理员授予您相应权限。
400InvalidParameter.%sThe specified field %s invalid. Please check it again.-
500InternalServerError内部服务错误-

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