获取集群列表
功能介绍
获取集群信息列表
URI
GET /v1/clusters
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
category |
否 |
String |
获取特定category的集群。 |
|
enablestatus |
否 |
Boolean |
是否获取集群的资源信息。不填或者填写为true为获取集群资源汇总信息，置为false为不获取集群状态信息；缺省值为true。 |
|
clustergroupid |
否 |
String |
容器舰队ID。不填会返回用户所有集群，填了之后会返回属于该容器舰队的集群。 |
|
limit |
否 |
Integer |
分页获取列表时，页的大小，默认为-1 |
|
offset |
否 |
Integer |
分页获取列表时，起始偏移量，默认为0 |
|
order_by |
否 |
String |
分页获取列表时，排序参数，支持 create_at 和 update_at |
|
order |
否 |
String |
分页获取列表时，排序方向，支持 desc 和 asc |
|
managetype |
否 |
String |
获取集群列表时，根据集群类型筛选，不传参时默认为 all ，支持 all ，grouped，discrete 三种类型。
|
|
clusterids |
否 |
String |
集群ID。多个ID以英文逗号分隔。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
身份认证信息 最小长度：1 最大长度：16384 |
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
items |
Array of Cluster objects |
集群成员的列表 |
|
total |
Integer |
集群总数 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
kind |
String |
API类型，固定值“Cluster”，该值不可修改。 |
|
apiVersion |
String |
API版本，固定值“v1”，该值不可修改。 |
|
metadata |
ObjectMeta object |
集群的基本信息，为集合类的元素类型，包含一组由不同名称定义的属性。 |
|
spec |
ClusterSpec object |
spec是集合类的元素类型，您对需要管理的集群对象进行详细描述的主体部分都在spec中给出。UCS通过spec的描述来创建或更新对象。 |
|
status |
ClusterStatus object |
集合类的元素类型，用于记录对象在系统中的当前状态信息。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
uid |
String |
集群ID |
|
name |
String |
集群名称。 |
|
labels |
Map<String,String> |
标签 |
|
creationTimestamp |
String |
创建时间。它以 RFC3339 形式表示，采用 UTC。 |
|
updateTimestamp |
String |
更新时间戳 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
syncMode |
String |
集群和karmada控制面之间的同步模式 |
|
clusterGroupID |
String |
容器舰队id |
|
manageType |
String |
集群类型，取值如下：
|
|
ruleNamespaces |
Array of RuleNamespace objects |
集群包含的RuleNamespace列表 |
|
apiEndpoint |
String |
apiserver地址 |
|
secretRef |
LocalSecretReference object |
访问集群的secret信息 |
|
insecureSkipTLSVerification |
Boolean |
是否跳过https校验 |
|
proxyURL |
String |
代理链接 |
|
provider |
String |
提供商 |
|
type |
String |
类型 |
|
category |
String |
类别 |
|
enableDistMgt |
Boolean |
CCE Turbo集群是否支持管理边缘基础设施。 |
|
region |
String |
区域 |
|
country |
String |
国家 |
|
city |
String |
城市 |
|
projectID |
String |
项目id |
|
projectName |
String |
项目名 |
|
zone |
String |
地区 |
|
taints |
Array of Taint objects |
污点 |
|
IsDownloadedCert |
Boolean |
是否已经下载过证书 |
|
policyId |
String |
策略管理id |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
rules |
Array of RuleInfo objects |
权限策略列表 |
|
namespaces |
Array of strings |
命名空间列表 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
kubernetesVersion |
String |
kubernetes版本 |
|
conditions |
Array of ConditionStatus objects |
conditions信息 |
|
nodeSummary |
NodeSummary object |
节点统计信息 |
|
resourceSummary |
ResourceSummary object |
资源统计信息 |
|
endpoints |
Endpoint object |
端点 |
|
phase |
String |
阶段状态信息 |
|
reason |
String |
表述上次状况变化的原因 |
|
message |
String |
上次状态转换的详细信息 |
|
arrearFreeze |
String |
欠费冻结 |
|
policeFreeze |
String |
公安冻结 |
|
apiEnablements |
Array of APIEnablement objects |
开启的资源列表 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
type |
String |
状态类型 |
|
status |
String |
状态 |
|
observedgeneration |
Integer |
状态对象的版本 |
|
lasttransitiontime |
String |
上次状态更新的实践 |
|
reason |
String |
状态原因 |
|
message |
String |
状态信息 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
allocatable |
map<string, object> |
可分配的资源 |
|
allocating |
map<string, object> |
分配中的资源 |
|
allocated |
map<string, object> |
已分配的资源 |
|
capacity |
map<string, object> |
资源总量 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
groupVersion |
String |
资源组、版本 |
|
resources |
Array of APIResource objects |
资源类型、名称 |
请求示例
无
响应示例
状态码： 200
获取所有集群信息
{
"items" : [ {
"kind" : "Cluster",
"apiVersion" : "v1",
"metadata" : {
"name" : "test-cluster",
"uid" : "b0d1ecb5-7947-11ee-9467-0255ac1001bf",
"creationTimestamp" : "2023-11-02T06:36:14Z",
"labels" : {
"FeatureGates" : "elbv3,SupportClientCertificateRevocation,xGPU"
},
"annotations" : {
"vpcId" : "11c9fe72-5a90-4295-bcfe-774726fb9066"
}
},
"spec" : {
"syncMode" : "",
"clusterGroupID" : "bffbb35b-7949-11ee-886c-0255ac100037",
"manageType" : "grouped",
"provider" : "huaweicloud",
"type" : "cce",
"category" : "self",
"region" : "cn-north-4",
"country" : "CN",
"city" : "150900",
"projectID" : "b6315dd3d0ff4be5b31a963256794989",
"projectName" : "cn-north-4",
"IsDownloadedCert" : false,
"operatorNamespace" : "2cd7ebd02e4743eba4e6342c09e49344"
},
"status" : {
"kubernetesVersion" : "v1.25",
"conditions" : [ {
"type" : "Ready",
"status" : "True",
"lastTransitionTime" : "2023-11-27T11:05:09+08:00",
"reason" : "ClusterAvailable"
}, {
"type" : "Cluster",
"status" : "Available",
"lastTransitionTime" : "2023-11-27T11:05:09+08:00",
"reason" : "ClusterAvailable"
}, {
"type" : "Federation",
"status" : "Federalized",
"lastTransitionTime" : "2023-11-14T14:31:58.744215+08:00"
} ],
"endpoints" : [ {
"url" : "https://192.168.1.251:5443",
"type" : "Internal"
} ],
"phase" : "Available",
"arrearFreeze" : "false",
"policeFreeze" : "false"
}
} ],
"total" : 1
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
获取所有集群信息 |
|
400 |
客户端请求错误，服务器无法执行请求 |
|
403 |
服务器拒绝执行请求 |
|
500 |
服务器内部错误 |
错误码
请参见错误码。
