Help Center/ Ubiquitous Cloud Native Service/ API Reference/ API/ Configuration Management/ Collecting Statistics on the Statuses of All Configuration Sets of a User
Updated on 2025-12-01 GMT+08:00

Collecting Statistics on the Statuses of All Configuration Sets of a User

Function

This API is used to collect statistics on the statuses of all configuration sets of a user.

URI

GET /v1/configsets/statistics

Table 1 Query Parameters

Parameter

Mandatory

Type

Description

limit

No

Integer

The number of records allowed on each page when the list is queried by page. The default value is -1.

offset

No

Integer

Start offset when the list is queried by page. The default value is 0.

order_by

No

String

Sorting parameter when the list is queried by page. The value can be create_at or update_at. The default value is create_at.

  • create_at: sorting by creation time

  • update_at: sorting by update time

order

No

String

Sorting order when the list is queried by page. The value can be desc or asc. The default value is desc.

  • desc: descending order

  • asc: ascending order

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

overviewStatus

OverviewReconcileStatus object

Status overview of configuration sets in all clusters

items

Array of ClusterReconcileStatus objects

Configuration set status of each cluster

total

Integer

Total number of records on all pages

Table 3 OverviewReconcileStatus

Parameter

Type

Description

configSetTotalNum

Integer

Total number of configuration sets

healthStatusNum

Integer

The number of healthy configuration sets

failedStatusNum

Integer

The number of failed configuration sets

unknownStatusNum

Integer

The number of unknown configuration sets

progressingStatusNum

Integer

The number of configuration sets being processed

Table 4 ClusterReconcileStatus

Parameter

Type

Description

clusterID

String

Cluster ID

configSetTotalNum

Integer

Total number of configuration sets in a cluster

healthStatusNum

Integer

The number of healthy configuration sets

failedStatusNum

Integer

The number of failed configuration sets

unknownStatusNum

Integer

The number of unknown configuration sets

progressingStatusNum

Integer

The number of configuration sets being processed

k8sResourceNum

Integer

The number of Kubernetes resources associated with a cluster

sourceRepoNum

Integer

The number of source code repositories associated with a cluster

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

-

String

-

Example Requests

None

Example Responses

Status code: 200

Status statistics of all configuration sets of a user obtained

{
  "overviewStatus" : {
    "configSetTotalNum" : 1,
    "failedStatusNum" : 1
  },
  "items" : [ {
    "clusterID" : "375f1918-5924-11ee-bfe7-0255ac1001b8",
    "configSetTotalNum" : 1,
    "failedStatusNum" : 1,
    "sourceRepoNum" : 1
  }, {
    "clusterID" : "620a2278-568c-11ee-a207-0255ac10004d"
  } ],
  "total" : 2
}

Status Codes

Status Code

Description

200

Status statistics of all configuration sets of a user obtained

400

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

Error Codes

See Error Codes.