调用DescribeClusterBasicInfo接口查询集群基本信息-云安全中心-阿里云

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

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
yundun-sas:DescribeClusterBasicInfo	get	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
ClusterId	string	是	指定要查询的集群的 ID。说明您可以调用 DescribeGroupedContainerInstances 接口获取该参数。	c870ec78ecbcb41d2a35c679823ef****
Type	string	是	配置类型。取值： containerNetwork：容器网络拓扑开关 interceptionSwitch：集群微隔离开关	containerNetwork
TargetType	string	是	目标开关的配置的操作维度。取值： Cluster：集群 ID	Cluster

返回参数

名称	类型	描述	示例值
	object	请求返回数据。
RequestId	string	本次调用请求的 ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。	24A20733-10A0-4AF6-BE6B-E3322413BB68
ClusterInfo	object	集群详情信息。
InstanceCount	integer	当前集群中存在的实例数量。	10
ClusterType	string	集群类型。取值： ManagedKubernetes：kubernetes 托管版 NotManagedKubernetes：kubernetes 非托管版 PrivateKubernetes：私有集群 kubernetes：kubernetes 专有版 ask：ask 专有版	kubernetes
State	string	是否可用。取值： unavailable：不可用 Available：可用 Creating：创建中 CreateFailed：创建失败	Available
CreateTime	long	创建集群时间戳，单位为毫秒。	1662038134000
ClusterName	string	集群名称。	testackpro
CurrentVersion	string	当前集群的版本信息。	1.22.10-aliyun.1
TargetResult	boolean	集群开关。 true：开 false：关	true
RegionId	string	集群所在的地域的 ID。	cn-hangzhou
ClusterId	string	集群 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	错误码	错误信息	描述
403	NoPermission	caller has no permission	当前操作未被授权，请联系主账号在RAM控制台进行授权后再执行操作。
500	ServerError	ServerError	服务故障，请稍后重试！

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