Obtaining Details About a Configuration Set

Function

This API is used to obtain details about a configuration set, including the repository source information.

URI

GET /v1/configsets/{configsetid}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
configsetid	Yes	String	Configuration set ID

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	No	String	Identity authentication information. Requests for calling an API can be authenticated using either a token or AK/SK. If token-based authentication is used, this parameter is mandatory and must be set to a user token.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
uid	String	Configuration set UID
name	String	Configuration set name
namespace	String	Namespace
configSetType	String	Configuration set type
repoName	String	Repository name
bucket	Object	Basic bucket information
helmChart	Object	Basic information about a Helm chart
gitRepository	GitRepository object	Git repository information such as its definition and status
helmRepository	Object	Helm repository information such as its definition and status
repoStatus	String	Repository status
helmRelease	Object	Release configuration and status of a Helm chart
kustomization	Kustomization object	Kustomize configuration definition and current application status
configSetStatus	String	Configuration set status
clusterInfo	ClusterInfo object	Basic cluster information
secretInfo	SecretInfo object	Secret information

**Table 4** GitRepository
Parameter	Type	Description
metadata	GitRepositoryMetaData object	Resource metadata
spec	GitRepositorySpec object	Git repository configuration information
status	GitRepositoryStatus object	Git repository status

**Table 5** GitRepositoryMetaData
Parameter	Type	Description
name	String	Repository name
namespace	String	Namespace
uid	String	UID
resourceVersion	String	Internal version ID of a resource. It is used for concurrency control.
generation	Integer	Generation of the desired resource state. The value increases each time the spec is modified.
creationTimestamp	String	Creation time
finalizers	Array of strings	Cleanup operations before the deletion
managedFields	Array of ManagedFieldsEntry objects	Used to trace resource field management permissions and record the manager of each field

**Table 6** ManagedFieldsEntry
Parameter	Type	Description
manager	String	Manager name
operation	String	Operation type that causes this entry being created. The value can only be Apply or Update.
apiVersion	String	Resource API version used by a manager for defining fields
time	String	Timestamp when this entry was created or last updated
fieldsType	String	Field structure format. The value is fixed at "FieldsV1".
fieldsV1	Object	Information about the managed fields

**Table 7** GitRepositorySpec
Parameter	Type	Description
url	String	Git repository address
ref	GitRepositoryRef object	Git reference to be parsed and checked out
secretRef	LocalObjectReference object	Secret that contains authentication information
interval	String	Interval for periodically checking repository updates. For example, 1m indicates 1 minute.
timeout	String	Timeout duration for Git operations (such as clone). The default value is 60 seconds.

**Table 8** GitRepositoryRef
Parameter	Type	Description
branch	String	Git branch to be checked out. If no other fields are defined, the master branch is checked out by default.

**Table 9** LocalObjectReference
Parameter	Type	Description
name	String	Referent name

**Table 10** GitRepositoryStatus
Parameter	Type	Description
observedGeneration	Integer	Version of the GitRepository processed by the controller last time
conditions	Array of objects	Current GitRepository condition set, which includes different states of an object
artifact	Artifact object	Artifact generated in the last GitRepository reconciliation

**Table 11** Artifact
Parameter	Type	Description
path	String	Relative file path of the artifact
url	String	HTTP address, which can be used to download or access the artifact content
revision	String	Version identifier
digest	String	File digest, in the format of [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br]:[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""})(br]
lastUpdateTime	String	Last update time
size	Integer	File size, in bytes

**Table 12** Kustomization
Parameter	Type	Description
metadata	KustomizationMetaData object	Resource metadata, including the name and namespace
spec	KustomizationSpec object	Custom desired state of a kustomization file
status	KustomizationStatus object	Actual status written by the controller

**Table 13** KustomizationMetaData
Parameter	Type	Description
name	String	Kustomization name
namespace	String	Namespace
uid	String	UID
resourceVersion	String	Internal version ID of a resource. It is used for concurrency control.
generation	Integer	Generation of the desired resource state. The value increases each time the spec is modified.
creationTimestamp	String	Creation time
finalizers	Array of strings	Cleanup operations before the deletion

**Table 14** KustomizationSpec
Parameter	Type	Description
path	String	Path of the kustomization.yaml file
interval	String	Interval at which the controller executes kustomization synchronization and verification
timeout	String	Timeout for the verification, application, and health check operations
sourceRef	SourceRef object	Source reference of the kustomization file
targetNamespace	String	Namespace to be set or overridden in the kustomization.yaml file
prune	Boolean	Whether to enable garbage collection

**Table 15** SourceRef
Parameter	Type	Description
kind	String	Type of the referent. The value must be OCIRepository, GitRepository, or Bucket.
name	String	Referent name

**Table 16** KustomizationStatus
Parameter	Type	Description
observedGeneration	Integer	Last reconciled generation, which identifies the object generation processed by the controller
conditions	Array of objects	Status condition list of the current object
lastAttemptedRevision	String	Revision of the last reconciliation attempt

**Table 17** ClusterInfo
Parameter	Type	Description
clusterID	String	Cluster ID
clusterName	String	Cluster name
clusterPath	String	Cluster path

**Table 18** SecretInfo
Parameter	Type	Description
authMode	String	Authentication mode
secret	Object	Secret that stores the authentication credential

Status code: 400

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

Status code: 500

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

Example Requests

None

Example Responses

Status code: 200

{
  "name" : "config-0320-10",
  "configSetType" : "Kustomization",
  "namespace" : "default",
  "repoName" : "podinfo-repo-21",
  "gitRepository" : {
    "metadata" : {
      "name" : "podinfo-repo-21",
      "namespace" : "default",
      "uid" : "d44adb1d-6a88-4f74-92b1-f96d6d797884",
      "resourceVersion" : "6048341",
      "generation" : 1,
      "creationTimestamp" : "2023-03-20T13:49:01Z",
      "finalizers" : [ "finalizers.fluxcd.io" ]
    },
    "spec" : {
      "url" : "https://github.com/wangyuan249/podinfo",
      "secretRef" : {
        "name" : "https-ca-credentials"
      },
      "interval" : "1m0s",
      "timeout" : "1m0s",
      "ref" : {
        "branch" : "master"
      }
    },
    "status" : {
      "observedGeneration" : 1,
      "conditions" : [ {
        "type" : "Ready",
        "status" : "True",
        "observedGeneration" : 1,
        "lastTransitionTime" : "2023-03-23T23:32:54Z",
        "reason" : "Succeeded",
        "message" : "stored artifact for revision 'master/1abc44f0d8dd6cd9df76090ea4ad694b70e03ee4'"
      }, {
        "type" : "ArtifactInStorage",
        "status" : "True",
        "observedGeneration" : 1,
        "lastTransitionTime" : "2023-03-20T13:49:21Z",
        "reason" : "Succeeded",
        "message" : "stored artifact for revision 'master/1abc44f0d8dd6cd9df76090ea4ad694b70e03ee4'"
      } ],
      "artifact" : {
        "path" : "gitrepository/default/podinfo-repo-21/1abc44f0d8dd6cd9df76090ea4ad694b70e03ee4.tar.gz",
        "url" : "http://source-controller.flux-system.svc.cluster.local./gitrepository/default/podinfo-repo-21/1abc44f0d8dd6cd9df76090ea4ad694b70e03ee4.tar.gz",
        "revision" : "master/1abc44f0d8dd6cd9df76090ea4ad694b70e03ee4",
        "lastUpdateTime" : "2023-03-20T13:49:21Z",
        "size" : 92464
      }
    }
  },
  "kustomization" : {
    "metadata" : {
      "name" : "config-0320-10",
      "namespace" : "default",
      "uid" : "990eb189-e5e0-41d8-a75b-b1622d9dcc34",
      "resourceVersion" : "5098199",
      "generation" : 1,
      "creationTimestamp" : "2023-03-20T13:49:01Z",
      "finalizers" : [ "finalizers.fluxcd.io" ]
    },
    "spec" : {
      "interval" : "0s",
      "path" : "kustomize-not-found",
      "prune" : false,
      "sourceRef" : {
        "kind" : "GitRepository",
        "name" : "podinfo-repo-21"
      },
      "targetNamespace" : "default"
    },
    "status" : {
      "observedGeneration" : 1,
      "conditions" : [ {
        "type" : "Ready",
        "status" : "False",
        "lastTransitionTime" : "2023-03-22T14:48:58Z",
        "reason" : "ArtifactFailed",
        "message" : "kustomization path not found: stat /tmp/kustomization-2606438047/kustomize-not-found: no such file or directory"
      } ],
      "lastAttemptedRevision" : "master/1abc44f0d8dd6cd9df76090ea4ad694b70e03ee4"
    }
  },
  "clusterInfo" : { },
  "secretInfo" : { }
}