全部产品
Search

搜索本产品

    云安全中心：DescribeClusterBasicInfo - 根据集群编号查询集群信息

    文档中心

    云安全中心：DescribeClusterBasicInfo - 根据集群编号查询集群信息

    更新时间：Nov 25, 2024

    根据集群编号查询集群信息。

    调试

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

    授权信息

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

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

    请求参数

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

    指定要查询的集群的 ID。

    说明 您可以调用 DescribeGroupedContainerInstances 接口获取该参数。
    		c870ec78ecbcb41d2a35c679823ef****
    Typestring是

    配置类型。取值：

    • containerNetwork：容器网络拓扑开关
    • interceptionSwitch：集群微隔离开关
    		containerNetwork
    TargetTypestring是

    目标开关的配置的操作维度。取值：

    • Cluster：集群 ID
    		Cluster

    返回参数

    名称类型描述示例值
    object

    请求返回数据。

    RequestIdstring

    本次调用请求的 ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。

    		24A20733-10A0-4AF6-BE6B-E3322413BB68
    ClusterInfoobject

    集群详情信息。

    InstanceCountinteger

    当前集群中存在的实例数量。

    		10
    ClusterTypestring

    集群类型。取值：

    • ManagedKubernetes：kubernetes 托管版
    • NotManagedKubernetes：kubernetes 非托管版
    • PrivateKubernetes：私有集群
    • kubernetes：kubernetes 专有版
    • ask：ask 专有版
    		kubernetes
    Statestring

    是否可用。取值：

    • unavailable：不可用
    • Available：可用
    • Creating：创建中
    • CreateFailed：创建失败
    		Available
    CreateTimelong

    创建集群时间戳，单位为毫秒。

    		1662038134000
    ClusterNamestring

    集群名称。

    		testackpro
    CurrentVersionstring

    当前集群的版本信息。

    		1.22.10-aliyun.1
    TargetResultboolean

    集群开关。

    • true：开
    • false：关
    		true
    RegionIdstring

    集群所在的地域的 ID。

    		cn-hangzhou
    ClusterIdstring

    集群 ID。

    		c870ec78ecbcb41d2a35c679823ef****

    示例

    正常返回示例

    JSON格式

    {
  "RequestId": "24A20733-10A0-4AF6-BE6B-E3322413BB68",
  "ClusterInfo": {
    "InstanceCount": 10,
    "ClusterType": "kubernetes",
    "State": "Available",
    "CreateTime": 1662038134000,
    "ClusterName": "testackpro",
    "CurrentVersion": "1.22.10-aliyun.1",
    "TargetResult": true,
    "RegionId": "cn-hangzhou",
    "ClusterId": "c870ec78ecbcb41d2a35c679823ef****\n"
  }
}

    错误码

    HTTP status code错误码错误信息描述
    403NoPermissioncaller has no permission当前操作未被授权，请联系主账号在RAM控制台进行授权后再执行操作。
    500ServerErrorServerError服务故障，请稍后重试！

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