获取单个容器舰队 - ShowClusterGroup
功能介绍
获取单个容器舰队
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。
URI
GET /v1/clustergroups/{clustergroupid}
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
clustergroupid |
是 |
String |
容器舰队id |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
否 |
String |
身份认证信息，调用接口的认证方式分为Token和AK/SK两种，如果您使用的Token方式，此参数为必填，请填写Token的值 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
kind |
String |
API类型，固定值"ClusterGroup"，该值不可修改。 |
|
apiVersion |
String |
API版本，固定值“v1”，该值不可修改。 |
|
metadata |
ObjectMeta object |
舰队的基本信息，为集合类的元素类型，包含一组由不同名称定义的属性。 |
|
spec |
ClusterGroupSpec object |
spec是集合类的元素类型，您对需要管理的对象进行详细描述的主体部分都在spec中给出。UCS通过spec的描述来创建或更新对象。 |
|
status |
ClusterGroupStatus object |
运行状态信息。集合类的元素类型，用于记录对象在系统中的当前运行状态相关信息。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
uid |
String |
资源ID |
|
name |
String |
资源名称 |
|
generateName |
String |
当未提供name时，服务器使用的前缀来生成唯一名称 |
|
namespace |
String |
命名空间 |
|
labels |
Map<String,String> |
标签 |
|
annotations |
Map<String,String> |
注解 |
|
creationTimestamp |
String |
创建时间 |
|
updateTimestamp |
String |
更新时间 |
|
resourceVersion |
String |
资源内部版本 |
|
generation |
String |
资源期望状态的代数 |
|
managedFields |
Array of ManagedFieldsEntry objects |
记录哪些字段由哪些工作流管理 |
|
ownerReferences |
Array of OwnerReference objects |
用于定义对象间所有权关系，管理对象的依赖关系和垃圾回收机制，支持控制器对资源的管理 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
manager |
String |
管理者的名称 |
|
operation |
String |
记录导致此条目创建的操作类型，只能是 Apply 或 Update 两种操作类型 |
|
apiVersion |
String |
该管理者定义字段时所依据的资源 API 版本 |
|
time |
String |
此管理条目被创建或最后一次更新的时间戳 |
|
fieldsType |
String |
固定为 "FieldsV1"，标记字段结构格式 |
|
fieldsV1 |
Object |
用于存储实际被管理的字段信息 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
apiVersion |
String |
标识引用对象的API版本 |
|
kind |
String |
引用对象的类型 |
|
name |
String |
引用对象的名称 |
|
uid |
String |
引用对象的uid |
|
controller |
Boolean |
如果为true，表示该引用指向管理该资源的控制器 |
|
blockOwnerDeletion |
Boolean |
当为true且拥有者有名为"foregroundDeletion"的finalizer 时，会阻止拥有者被删除，直到这个引用被移除 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
ruleNamespaces |
Array of strings |
权限策略关联的命名空间列表 |
|
federationId |
String |
舰队启用联邦ID |
|
description |
String |
描述信息 |
|
dnsSuffix |
Array of strings |
舰队对应联邦的DNS后缀，开启联邦后可见 |
|
federationExpirationTimestamp |
String |
联邦到期时间戳 |
|
policyId |
String |
策略管理id |
|
federationVersion |
String |
舰队启用联邦的版本 |
|
connectGatewayEndpoints |
Array of ConnectEndpoint objects |
集群联邦连接网关节点列表，仅当舰队开启集群联邦时有值 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
type |
String |
取值：当前仅支持 VPCEP |
|
name |
String |
资源名称，当type是VPCEP时为VPCEP Service的名称 |
|
id |
String |
资源id，当type是VPCEP时为VPCEP Service的id |
|
region |
String |
资源所在的region |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
type |
String |
类型。
|
|
status |
String |
舰队启用的联邦或权限策略的状态 |
|
reason |
String |
状态原因 |
|
message |
String |
状态信息 |
|
lastTransitionTime |
String |
状态更新时间 |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
- |
String |
状态码：403
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
- |
String |
状态码：404
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
- |
String |
状态码：500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
- |
String |
请求示例
无
响应示例
状态码：200
容器舰队对象
{
"kind" : "ClusterGroup",
"apiVersion" : "v1",
"metadata" : {
"name" : "cluster-test",
"uid" : "bffbb35b-7949-11ee-886c-0255ac100037",
"creationTimestamp" : "2023-11-02 06:33:35.558128 +0000 UTC",
"updateTimestamp" : "2023-11-14 06:20:20.446476 +0000 UTC"
},
"spec" : {
"federationId" : "e2f27cc6-82b5-11ee-84e3-0255ac100032",
"federationVersion" : "v1.7.0",
"dnsSuffix" : [ "www.oidc.com" ],
"connectGatewayEndpoints" : [ {
"type" : "VPCEP",
"name" : "cn-north-4.5fc05258-f125-48f5-8a0a-a724a37f5ff1",
"id" : "5fc05258-f125-48f5-8a0a-a724a37f5ff1",
"region" : "cn-north-4"
} ]
},
"status" : {
"conditions" : [ {
"type" : "Federation",
"status" : "Unavailable",
"reason" : "FederationUnavailable",
"message" : "component volcano-scheduler is unhealthy",
"lastTransitionTime" : "0001-01-01T00:00:00Z"
} ]
}
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
容器舰队对象 |
|
400 |
客户端请求错误，服务器无法执行请求 |
|
403 |
服务器拒绝执行请求 |
|
404 |
资源不存在 |
|
500 |
服务器内部错误 |
错误码
请参见错误码。
