Updated on 2025-07-15 GMT+08:00

Obtaining a Fleet

Function

This API is used to obtain a fleet.

URI

GET /v1/clustergroups/{clustergroupid}

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

Yes

String

Identity authentication information

Response Parameters

Status code: 200

Table 3 Parameters in the response body

Parameter

Type

Description

kind

String

API type. The value is fixed at ClusterGroup and cannot be changed.

apiVersion

String

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

metadata

ObjectMeta object

Basic information about the fleet. Metadata is a collection of attributes.

spec

ClusterGroupSpec object

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

status

ClusterGroupStatus object

Fleet status

Table 4 ObjectMeta

Parameter

Type

Description

uid

String

Cluster ID

name

String

Cluster name

labels

Map<String,String>

Labels

creationTimestamp

String

Creation time. It is the UTC time in the RFC 3339 format.

updateTimestamp

String

Update timestamp

Table 5 ClusterGroupSpec

Parameter

Type

Description

ruleNamespaces

Array of strings

List of namespaces associated with a permission policy

federationId

String

Fleet federation ID

description

String

Description

dnsSuffix

Array of strings

DNS suffix of the federation corresponding to the fleet. This parameter is visible after federation is enabled.

federationExpirationTimestamp

String

Federation expiration timestamp

policyId

String

Policy management ID

federationVersion

String

Fleet federation version

Table 6 ClusterGroupStatus

Parameter

Type

Description

conditions

Array of ClusterGroupCondition objects

Federation or permission policy information for a fleet

Table 7 ClusterGroupCondition

Parameter

Type

Description

type

String

Type. The options are as follows:

  • Federation: Federation is enabled for the fleet.

  • Policy: Permission policies are enabled for the fleet.

status

String

Status of the federation or permission policy enabled for a fleet

reason

String

Cause of status

message

String

Status information

lastTransitionTime

String

Time when the status was updated

Status code: 400

Table 8 Parameters in the response body

Parameter

Type

Description

-

String

Status code: 403

Table 9 Parameters in the response body

Parameter

Type

Description

-

String

Status code: 404

Table 10 Parameters in the response body

Parameter

Type

Description

-

String

Status code: 500

Table 11 Parameters in the response body

Parameter

Type

Description

-

String

Example Requests

None

Example Responses

Status code: 200

Fleet object

{
  "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-t1109",
    "dnsSuffix" : [ "www.oidc.com" ]
  },
  "status" : {
    "conditions" : [ {
      "type" : "Federation",
      "status" : "Unavailable",
      "reason" : "FederationUnavailable",
      "message" : "component volcano-scheduler is unhealthy",
      "lastTransitionTime" : "0001-01-01T00:00:00Z"
    } ]
  }
}

Status Codes

Status Code

Description

200

Fleet object

400

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

403

The server refused the request.

404

Resources not found.

500

Internal server error.

Error Codes

See Error Codes.