查询边缘集群列表

功能介绍

应用服务器可调用此接口查询边缘集群列表。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

GET /v3/{project_id}/clusters

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目ID。获取方法请参见获取项目ID。

表2 Query参数
参数	是否必选	参数类型	描述
cluster_name	否	String	边缘集群名称最小长度：1 最大长度：32
state	否	String	边缘集群状态最小长度：1 最大长度：32
cluster_ids	否	Array	边缘集群ID列表数组长度：0 - 1000
limit	否	Integer	每页记录数，默认值为10，取值区间为1-1000。最小值：1 最大值：1000 缺省值：10
offset	否	Integer	查询的起始位置，取值范围为非负整数，默认为0。最小值：0 最大值：1000000 缺省值：0

请求参数

表3 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	用户Token。通过调用IAM服务获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。

响应参数

状态码： 200

表4 响应Body参数
参数	参数类型	描述
count	Integer	总记录数最小值：0 最大值：1000000
page_info	PageInfoDTO object	分页信息
clusters	Array of QueryClusterBriefResponseDTO objects	每页记录数数组长度：0 - 1000000

表5 PageInfoDTO
参数	参数类型	描述
offset	Integer	页码最小值：0 最大值：1000000
limit	Integer	每页记录数最小值：1 最大值：1000

表6 QueryClusterBriefResponseDTO
参数	参数类型	描述
cluster_id	String	集群ID
cluster_name	String	集群名称最小长度：4 最大长度：32
description	String	集群描述
version	String	边缘集群版本
state	String	边缘集群状态
create_time	String	创建时间最小长度：0 最大长度：256
update_time	String	最后一次修改时间最小长度：0 最大长度：256
is_upgradeable	Boolean	是否可升级

请求示例

GET https://{endpoint}/v2/{project_id}/clusters

响应示例

状态码： 200

{
  "count" : 1000000,
  "page_info" : {
    "offset" : 1000000,
    "limit" : 1000
  },
  "clusters" : [ {
    "cluster_id" : "123343534",
    "cluster_name" : "test-cluster",
    "description" : "this is a test cluster",
    "version" : "string",
    "state" : "string",
    "create_time" : "string",
    "update_time" : "string",
    "is_upgradeable" : true
  } ]
}