文档首页/ 华为云UCS/ API参考/ API/ 容器舰队/ 查询联邦开启进度 - ShowFederationProgress
更新时间:2025-11-17 GMT+08:00
分享

查询联邦开启进度 - ShowFederationProgress

功能介绍

查询联邦开启进度

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项

URI

GET /v1/clustergroups/{clustergroupid}/federations/progress

表1 路径参数

参数

是否必选

参数类型

描述

clustergroupid

String

容器舰队id

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

身份认证信息,调用接口的认证方式分为Token和AK/SK两种,如果您使用的Token方式,此参数为必填,请填写Token的值

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

kind

String

API类型。

apiVersion

String

API版本,固定值“v1”,该值不可修改。

metadata

ObjectMeta object

ObjectMeta是Kubernetes中所有持久化资源必须包含的元数据结构

spec

JobSpec object

spec是集合类的元素类型,您对需要管理的对象进行详细描述的主体部分都在spec中给出。UCS通过spec的描述来创建或更新对象。

status

JobStatus object

运行状态信息。集合类的元素类型,用于记录对象在系统中的当前运行状态相关信息。

表4 JobSpec

参数

参数类型

描述

type

String

Job类型

federationUID

String

联邦uid

resourceID

String

资源id

resourceName

String

资源名字

extendparam

String

扩展参数

subJobs

Array of Job objects

子Job

表5 Job

参数

参数类型

描述

kind

String

API类型。

apiVersion

String

API版本,固定值“v1”,该值不可修改。

metadata

ObjectMeta object

ObjectMeta是Kubernetes中所有持久化资源必须包含的元数据结构

spec

JobSpec object

spec是集合类的元素类型,您对需要管理的对象进行详细描述的主体部分都在spec中给出。UCS通过spec的描述来创建或更新对象。

status

JobStatus object

运行状态信息。集合类的元素类型,用于记录对象在系统中的当前运行状态相关信息。

表6 ObjectMeta

参数

参数类型

描述

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

用于定义对象间所有权关系,管理对象的依赖关系和垃圾回收机制,支持控制器对资源的管理

表7 ManagedFieldsEntry

参数

参数类型

描述

manager

String

管理者的名称

operation

String

记录导致此条目创建的操作类型,只能是 Apply 或 Update 两种操作类型

apiVersion

String

该管理者定义字段时所依据的资源 API 版本

time

String

此管理条目被创建或最后一次更新的时间戳

fieldsType

String

固定为 "FieldsV1",标记字段结构格式

fieldsV1

Object

用于存储实际被管理的字段信息

表8 OwnerReference

参数

参数类型

描述

apiVersion

String

标识引用对象的API版本

kind

String

引用对象的类型

name

String

引用对象的名称

uid

String

引用对象的uid

controller

Boolean

如果为true,表示该引用指向管理该资源的控制器

blockOwnerDeletion

Boolean

当为true且拥有者有名为"foregroundDeletion"的finalizer 时,会阻止拥有者被删除,直到这个引用被移除

表9 JobStatus

参数

参数类型

描述

phase

String

Job phase

reason

String

Job reason

completionTime

String

Job完成时间

startTime

String

Job开始时间

状态码:400

表10 响应Body参数

参数

参数类型

描述

-

String

状态码:404

表11 响应Body参数

参数

参数类型

描述

-

String

状态码:500

表12 响应Body参数

参数

参数类型

描述

-

String

请求示例

响应示例

状态码:200

返回开启联邦对应的Job

{
  "kind" : "Job",
  "apiVersion" : "v3",
  "metadata" : {
    "uid" : "70b5a14f-2fa4-11ee-bf07-0255ac1000b9",
    "creationTimestamp" : "2023-07-31 13:16:20.715779 +0000 UTC",
    "updateTimestamp" : "2023-07-31 13:17:24.497868 +0000 UTC"
  },
  "spec" : {
    "type" : "CreateFederationContainer",
    "federationUID" : "70acf480-2fa4-11ee-ad1d-0255ac1001c4",
    "resourceID" : "70acf480-2fa4-11ee-ad1d-0255ac1001c4",
    "resourceName" : "70acf480-2fa4-11ee-ad1d-0255ac1001c4",
    "subJobs" : [ {
      "kind" : "Job",
      "apiVersion" : "v3",
      "metadata" : {
        "uid" : "70b66b9a-2fa4-11ee-bf07-0255ac1000b9",
        "creationTimestamp" : "2023-07-31 13:16:20.740512 +0000 UTC",
        "updateTimestamp" : "2023-07-31 13:16:22.100528 +0000 UTC"
      },
      "spec" : {
        "type" : "InstallFederationChart",
        "federationUID" : "70acf480-2fa4-11ee-ad1d-0255ac1001c4"
      },
      "status" : {
        "phase" : "Success",
        "completionTime" : "2023-07-31 13:16:22.100528 +0000 UTC",
        "startTime" : "2023-07-31 13:16:22.100528 +0000 UTC"
      }
    }, {
      "kind" : "Job",
      "apiVersion" : "v3",
      "metadata" : {
        "uid" : "70b66b68-2fa4-11ee-bf07-0255ac1000b9",
        "creationTimestamp" : "2023-07-31 13:16:20.736232 +0000 UTC",
        "updateTimestamp" : "2023-07-31 13:17:24.490359 +0000 UTC"
      },
      "spec" : {
        "type" : "CreateNetworkResource",
        "federationUID" : "70acf480-2fa4-11ee-ad1d-0255ac1001c4",
        "extendParam" : {
          "JobExtendParamKeyElbID" : "69694819-67dc-44ac-ab6e-9b18087c5c4c"
        }
      },
      "status" : {
        "phase" : "Success",
        "completionTime" : "2023-07-31 13:17:24.490359 +0000 UTC",
        "startTime" : "2023-07-31 13:16:20.744891 +0000 UTC"
      }
    }, {
      "kind" : "Job",
      "apiVersion" : "v3",
      "metadata" : {
        "uid" : "70b66afa-2fa4-11ee-bf07-0255ac1000b9",
        "creationTimestamp" : "2023-07-31 13:16:20.731295 +0000 UTC",
        "updateTimestamp" : "2023-07-31 13:16:22.100452 +0000 UTC"
      },
      "spec" : {
        "type" : "CreateCert",
        "federationUID" : "70acf480-2fa4-11ee-ad1d-0255ac1001c4"
      },
      "status" : {
        "phase" : "Success",
        "completionTime" : "2023-07-31 13:16:22.100452 +0000 UTC",
        "startTime" : "2023-07-31 13:16:22.100452 +0000 UTC"
      }
    }, {
      "kind" : "Job",
      "apiVersion" : "v3",
      "metadata" : {
        "uid" : "70b66ad0-2fa4-11ee-bf07-0255ac1000b9",
        "creationTimestamp" : "2023-07-31 13:16:20.726434 +0000 UTC",
        "updateTimestamp" : "2023-07-31 13:16:22.093902 +0000 UTC"
      },
      "spec" : {
        "type" : "CreateNode",
        "federationUID" : "70acf480-2fa4-11ee-ad1d-0255ac1001c4"
      },
      "status" : {
        "phase" : "Success",
        "completionTime" : "2023-07-31 13:16:22.093902 +0000 UTC",
        "startTime" : "2023-07-31 13:16:20.745187 +0000 UTC"
      }
    } ]
  },
  "status" : {
    "phase" : "Success",
    "completionTime" : "2023-07-31 13:17:24.497868 +0000 UTC",
    "startTime" : "2023-07-31 13:16:20.721007 +0000 UTC"
  }
}

状态码

状态码

描述

200

返回开启联邦对应的Job

400

客户端请求错误,服务器无法执行请求

404

资源不存在

500

服务器内部错误

错误码

请参见错误码

相关文档