Help Center/ Ubiquitous Cloud Native Service/ API Reference/ API/ Fleets/ Querying Federation Enabling Progress
Updated on 2025-07-15 GMT+08:00

Querying Federation Enabling Progress

Function

This API is used to query the federation enabling progress.

URI

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

Table 1 Path parameters

Parameter

Mandatory

Type

Description

clustergroupid

Yes

String

Fleet ID

Request Parameters

Table 2 Parameters in the request header

Parameter

Mandatory

Type

Description

X-Auth-Token

No

String

Identity authentication information

Response Parameters

Status code: 200

Table 3 Parameters in the response body

Parameter

Type

Description

kind

String

API type.

apiVersion

String

API version. The value is fixed at v1 and cannot be changed.

spec

JobSpec object

Details about the job. UCS creates or updates the job by spec.

status

JobStatus object

Job status

Table 4 JobSpec

Parameter

Type

Description

type

String

Job type

federationuid

String

Federation UID

resourceid

String

Resource ID

resourcename

String

Resource name

extendparam

String

Extended parameter

subjobs

Array of Job objects

Subjobs

Table 5 Job

Parameter

Type

Description

kind

String

API type.

apiVersion

String

API version. The value is fixed at v1 and cannot be changed.

spec

JobSpec object

Details about the job. UCS creates or updates the job by spec.

status

JobStatus object

Job status

Table 6 JobStatus

Parameter

Type

Description

phase

String

Job phase

reason

String

Job reason

completiontime

String

Job completion time

starttime

String

Job start time

Status code: 400

Table 7 Parameters in the response body

Parameter

Type

Description

-

String

Status code: 404

Table 8 Parameters in the response body

Parameter

Type

Description

-

String

Status code: 500

Table 9 Parameters in the response body

Parameter

Type

Description

-

String

Example Requests

None

Example Responses

Status code: 200

Job for enabling cluster federation has been returned.

{
  "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",
    "annotations" : {
      "currentTimestamp" : "2023-07-31 13:17:24.933313136 +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",
        "annotations" : {
          "currentTimestamp" : "2023-07-31 13:17:24.934274579 +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",
        "annotations" : {
          "currentTimestamp" : "2023-07-31 13:17:24.934277116 +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",
        "annotations" : {
          "currentTimestamp" : "2023-07-31 13:17:24.934288685 +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",
        "annotations" : {
          "currentTimestamp" : "2023-07-31 13:17:24.934291673 +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"
  }
}

Status Codes

Status Code

Description

200

Job for enabling cluster federation has been returned.

400

Client request error. The server could not execute the request.

404

Resources not found.

500

Internal server error.

Error Codes

See Error Codes.