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
|
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. |
|
order |
No |
String |
Sorting order when the list is queried by page. The value can be desc or asc. The default value is desc. |
Request Parameters
None
Response Parameters
Status code: 200
|
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 |
|
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 |
|
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
|
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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot