调用DescribeClusterInfoList查询集群列表_云安全中心(Security Center)-阿里云帮助中心

查询集群信息列表。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
yundun-sas:DescribeClusterInfoList	List	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
Type	string	是	配置类型。取值： containerNetwork：容器网络 interceptionSwitch：集群微隔离	containerNetwork
TargetType	string	是	目标开关的配置的操作维度。取值： Cluster：集群 ID	Cluster
Target	string	否	目标开关的配置的操作值。该值表示集群 ID。	c23551de6149343e8a54e69fbefe6****

返回参数

名称	类型	描述	示例值
	object	请求返回数据。
RequestId	string	本次调用请求的 ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。	7E0618A9-D5EF-4220-9471-C42B5E92719F
ClusterList	object []	集群信息列表。
State	string	是否可用。取值： unavailable：不可用 Available：可用 Creating：创建中 CreateFailed：创建失败	Available
ClusterType	string	集群类型。取值： ManagedKubernetes：kubernetes 托管版 NotManagedKubernetes：kubernetes 非托管版 PrivateKubernetes：私有集群 kubernetes：kubernetes 专有版 ask：ask 专有版	ManagedKubernetes
ClusterName	string	容器集群名称。	test111
ClusterId	string	容器集群的 ID。	cfeb7a9f99ce740e98c5595d0fe37****
RegionId	string	容器集群的地域。	cn-hangzhou
TargetResult	boolean	集群开关。 true：开 false：关	true

示例

正常返回示例

JSON格式

{
  "RequestId": "7E0618A9-D5EF-4220-9471-C42B5E92719F",
  "ClusterList": [
    {
      "State": "Available",
      "ClusterType": "ManagedKubernetes",
      "ClusterName": "test111",
      "ClusterId": "cfeb7a9f99ce740e98c5595d0fe37****",
      "RegionId": "cn-hangzhou",
      "TargetResult": true
    }
  ]
}

错误码

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

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