调用DescribeServiceMeshClusters获取服务网格的可用集群

调用DescribeServiceMeshClusters获取服务网格的可用集群。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

servicemesh:DescribeServiceMeshClusters

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
ServiceMeshId	string	否	服务网格 ID。	cb8963379255149cb98c8686f274x****
Offset	integer	否	本次访问的起始位置。	20
Limit	integer	否	集群列表最大数量。	30

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	31d3a0f0-07ed-4f6e-9004-1804498c****
Clusters	array<object>	集群列表信息。
	object
SgId	string	安全组 ID。	sg-bp197668l6iupljy****
VpcId	string	专有网络 ID。	vpc-8vbrwmt95b4zf6wf7****
CreationTime	string	集群创建时间。	2020-05-12T15:38:16+08:00
UpdateTime	string	集群最后修改时间。	2020-05-12T15:38:16+08:00
ErrorMessage	string	集群的异常信息。	fail
State	string	集群状态，取值： `running`：运行中。 `starting` ：启动中。 `stopping` ：终止中。 `stopped`：已停止。 `failed`：失败。	running
ServiceMeshId	string	服务网格 ID。	cb8963379255149cb98c8686f274x****
RegionId	string	集群所在地域 ID。	cn-hangzhou
ClusterDomain	string	集群域名。	c.com
Version	string	集群版本号。	v1.16.6-aliyun.1
ClusterType	string	集群类型。	Ask
Name	string	集群名称。	ask1
ClusterId	string	集群 ID。	c80f45444b3da447da60a911390c2****
ForbiddenFlag	integer	数据面集群不能加入 ASM 的原因，取值： `0`：表示正常，可加入。 `1`：表示您没有集群的 adminlevel 权限。 `2`：集群和网格位于不同的 VPC 中，并且它们之间没有 CEN。 `3`：集群的 CIDR 与网格冲突。 `4`：集群已具有名为 istio-system 的命名空间。	0
ForbiddenInfo	string	数据面集群不能加入 ASM 的详细原因，格式为 JSON 字符串，格式为： `[ { "cluster": "cdd55bd6e054b4c6ca18ec02614****", "object": "Pod", "cidr": "172.16.0.0/24" }, { "cluster": "cfa37fdf7cb1641e1976f8293ac**", "object": "Pod", "cidr": "172.16.0.0/24" } ]` 以上例子中表示集群`cdd55bd6e054b4c6ca18ec02614**`的 Pod CIDR `172.16.0.0/24`与集群`cfa37fdf7cb1641e1976f8293ac****`的 Pod CIDR `172.16.0.0/24`发生了冲突。 `object`取值： `Pod` `Service` `VSwitch` `VPC` `VPC CIDR`	[{"cluster":"cdd55bd6e054b4c6ca18ec02614****", "object":"Pod", "cidr":"172.16.0.0/24"},{"cluster":"cfa37fdf7cb1641e1976f8293ac****", "object":"Pod", "cidr":"172.16.0.0/24"}]
NumberOfClusters	integer	当前 Region 下的容器服务集群总数。	5

示例

正常返回示例

JSON格式

{
  "RequestId": "31d3a0f0-07ed-4f6e-9004-1804498c****",
  "Clusters": [
    {
      "SgId": "sg-bp197668l6iupljy****",
      "VpcId": "vpc-8vbrwmt95b4zf6wf7****",
      "CreationTime": "2020-05-12T15:38:16+08:00",
      "UpdateTime": "2020-05-12T15:38:16+08:00",
      "ErrorMessage": "fail",
      "State": "running",
      "ServiceMeshId": "cb8963379255149cb98c8686f274x****",
      "RegionId": "cn-hangzhou",
      "ClusterDomain": "c.com",
      "Version": "v1.16.6-aliyun.1",
      "ClusterType": "Ask",
      "Name": "ask1",
      "ClusterId": "c80f45444b3da447da60a911390c2****",
      "ForbiddenFlag": 0,
      "ForbiddenInfo": "[{\"cluster\":\"cdd55bd6e054b4c6ca18ec02614******\", \"object\":\"Pod\", \"cidr\":\"172.16.0.0/24\"},{\"cluster\":\"cfa37fdf7cb1641e1976f8293ac******\", \"object\":\"Pod\", \"cidr\":\"172.16.0.0/24\"}]"
    }
  ],
  "NumberOfClusters": 5
}

错误码

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

变更历史

更多信息，参考变更详情。