Querying Service Configuration

Function

This API is used to obtain the global configuration of each cluster type.

URI

GET /v1/serverconfig

Request Parameters

None

Response Parameters

Status code: 200

**Table 1** Response body parameters
Parameter	Type	Description
onpremises	OnPremisesConfig object	Configuration parameters of an on-premises cluster
federations	FederationConfig object	Federation configuration parameters

**Table 2** OnPremisesConfig
Parameter	Type	Description
versionsInfo	Array of OnPremisesVersionInfo objects	On-premises cluster version list

**Table 3** OnPremisesVersionInfo
Parameter	Type	Description
kubernetesVersion	String	Kubernetes cluster version
releaseVersion	String	Release version
ucsctlDownloadURL	String	URL for downloading ucs-ctl
arch	String	Compatible CPU architecture
obsEndpoint	String	OBS endpoint
packagePath	String	Software package storage path
imagesPackagePath	String	Image package storage path
targetVersion	String	Target version

**Table 4** FederationConfig
Parameter	Type	Description
versionsInfo	Array of FederationVersionInfo objects	Federation version list

**Table 5** FederationVersionInfo
Parameter	Type	Description
currentVersion	FederationVersionSpec object	Current federation version
targetVersions	Array of FederationVersionSpec objects	List of target federation versions

**Table 6** FederationVersionSpec
Parameter	Type	Description
FederationVersion	String	Federation version

Status code: 400

**Table 7** Response body parameters
Parameter	Type	Description
-	String	-

Example Requests

None

Example Responses

Status code: 200

Global configuration parameters of the cluster obtained

{
  "onpremises" : {
    "versionsInfo" : [ {
      "kubernetesVersion" : "1.28.5",
      "releaseVersion" : "25.3.0",
      "ucsctlDownloadURL" : "toolkits/ucs-ctl/ucsadm-25.3.0.2/amd64/ucs-ctl",
      "arch" : "amd64",
      "obsEndpoint" : "https://ucs-onprem.obs.cn-north-5.ulanqab.huawei.com",
      "packagePath" : "packages/ucs-onpremise/25.3.0/ucs-onpremise_25.3.0.2_amd64.tar.gz",
      "imagesPackagePath" : "packages/ucs-onpremise/25.3.0/ucs-onpremise_images_25.3.0.2_amd64.tar.gz"
    }, {
      "kubernetesVersion" : "1.28.5",
      "releaseVersion" : "25.3.0",
      "ucsctlDownloadURL" : "toolkits/ucs-ctl/ucsadm-25.3.0.2/arm64/ucs-ctl",
      "arch" : "arm64",
      "obsEndpoint" : "https://ucs-onprem.obs.cn-north-5.ulanqab.huawei.com",
      "packagePath" : "packages/ucs-onpremise/25.3.0/ucs-onpremise_25.3.0.2_arm64.tar.gz",
      "imagesPackagePath" : "packages/ucs-onpremise/25.3.0/ucs-onpremise_images_25.3.0.2_arm64.tar.gz"
    } ]
  },
  "federations" : {
    "versionsInfo" : [ {
      "currentVersion" : {
        "FederationVersion" : "v1.10.7-r29"
      },
      "targetVersions" : [ {
        "FederationVersion" : "v1.10.7-t0813"
      } ]
    }, {
      "currentVersion" : {
        "FederationVersion" : "v1.10.7-r27"
      },
      "targetVersions" : [ {
        "FederationVersion" : "v1.10.7-r28"
      } ]
    }, {
      "currentVersion" : {
        "FederationVersion" : "v1.10.7-r28"
      },
      "targetVersions" : [ {
        "FederationVersion" : "v1.10.7-r29"
      } ]
    }, {
      "currentVersion" : {
        "FederationVersion" : "1.10.3-r10"
      },
      "targetVersions" : [ {
        "FederationVersion" : "v1.10.7-t0928"
      } ]
    } ]
  }
}