Obtaining the CCE Cluster List of a Tenant
Function
This API is used to obtain the CCE cluster list of the current tenant.
URI
GET /v1/managedclusters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
unimported |
No |
Boolean |
Whether to register a cluster with UCS |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
Identity authentication information |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
[Array] |
Array of Cluster objects |
CCE clusters that were not registered with UCS were returned. |
Parameter |
Type |
Description |
---|---|---|
kind |
String |
API type. The value is fixed at Cluster 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 cluster. Metadata is a collection of attributes. |
spec |
ClusterSpec object |
Details about the cluster. UCS creates or updates the cluster based on spec. |
status |
ClusterStatus object |
Cluster status |
Parameter |
Type |
Description |
---|---|---|
uid |
String |
Cluster ID |
name |
String |
Cluster name |
labels |
Map<String,String> |
Labels |
creationTimestamp |
String |
Creation time. It is a UTC time in the RFC 3339 format. |
updateTimestamp |
String |
Update timestamp |
Parameter |
Type |
Description |
---|---|---|
syncMode |
String |
Synchronization mode between the cluster and the Karmada control plane |
clusterGroupID |
String |
Fleet ID |
manageType |
String |
Cluster type. The options are as follows: |
ruleNamespaces |
Array of RuleNamespace objects |
List of namespaces associated with permission policies in a cluster |
apiEndpoint |
String |
API server address |
secretRef |
LocalSecretReference object |
Secret information for accessing a cluster |
insecureSkipTLSVerification |
Boolean |
Whether to skip HTTPS verification |
proxyURL |
String |
Proxy URL |
provider |
String |
Provider |
type |
String |
Type |
category |
String |
Category |
enableDistMgt |
Boolean |
Whether CCE Turbo clusters can manage edge infrastructure |
region |
String |
Region |
country |
String |
Country |
city |
String |
City |
projectID |
String |
Project ID |
projectName |
String |
Project name |
zone |
String |
Zone |
taints |
Array of Taint objects |
Taints |
IsDownloadedCert |
Boolean |
Whether the certificate has been downloaded |
policyId |
String |
Policy management ID |
Parameter |
Type |
Description |
---|---|---|
rules |
Array of RuleInfo objects |
Permission policy list |
namespaces |
Array of strings |
Namespace list |
Parameter |
Type |
Description |
---|---|---|
ruleID |
String |
Permission policy ID |
ruleName |
String |
Permission policy name |
Parameter |
Type |
Description |
---|---|---|
namespace |
String |
Namespace that the resource belongs to |
name |
String |
Resource name |
Parameter |
Type |
Description |
---|---|---|
key |
String |
Key |
value |
String |
Value |
effect |
String |
Effect information |
timeadded |
String |
Timestamp information |
Parameter |
Type |
Description |
---|---|---|
kubernetesVersion |
String |
Kubernetes version |
conditions |
Array of ConditionStatus objects |
Conditions |
nodeSummary |
NodeSummary object |
Node statistics |
resourceSummary |
ResourceSummary object |
Resource statistics |
endpoints |
Endpoint object |
Endpoint |
phase |
String |
Phase information |
reason |
String |
Reason of the last change |
message |
String |
Details about the last state transition |
arrearFreeze |
String |
Frozen due to arrears |
policeFreeze |
String |
Frozen for legal reasons |
apiEnablements |
Array of APIEnablement objects |
List of enabled resources |
Parameter |
Type |
Description |
---|---|---|
type |
String |
Status type |
status |
String |
Status |
observedgeneration |
Integer |
Version of a status object |
lasttransitiontime |
String |
Time of the last transition |
reason |
String |
Cause of status |
message |
String |
Status information |
Parameter |
Type |
Description |
---|---|---|
totalNum |
String |
The number of all nodes in a cluster |
readyNum |
String |
The number of ready nodes in a cluster |
Parameter |
Type |
Description |
---|---|---|
allocatable |
ResourceList object |
Allocable resources |
allocating |
ResourceList object |
Resources in allocation |
allocated |
ResourceList object |
Allocated resources |
capacity |
ResourceList object |
Total resources |
Parameter |
Type |
Description |
---|---|---|
{Custom key} |
Map<String,String> |
ResourceList is a group of resource name and quantity pairs. |
Parameter |
Type |
Description |
---|---|---|
{Custom key} |
Map<String,String> |
ResourceList is a group of resource name and quantity pairs. |
Parameter |
Type |
Description |
---|---|---|
{Custom key} |
Map<String,String> |
ResourceList is a group of resource name and quantity pairs. |
Parameter |
Type |
Description |
---|---|---|
{Custom key} |
Map<String,String> |
ResourceList is a group of resource name and quantity pairs. |
Parameter |
Type |
Description |
---|---|---|
url |
String |
URL |
type |
String |
Port type |
status |
String |
Port status |
Parameter |
Type |
Description |
---|---|---|
groupVersion |
String |
Resource group and version |
resources |
Array of APIResource objects |
Resource type and name |
Parameter |
Type |
Description |
---|---|---|
name |
String |
Resource name |
kind |
String |
Resource category |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
- |
String |
Example Request
None
Example Response
Status code: 200
CCE clusters that were not registered with UCS were returned.
[ { "kind" : "Cluster", "apiVersion" : "v1", "metadata" : { "name" : "cluster-test", "uid" : "57ef11e7-7d72-11ee-a590-0255ac100b05", "creationTimestamp" : "2023-11-07T13:34:15Z", "labels" : { "FeatureGates" : "elbv3,SupportClientCertificateRevocation,xGPU" } }, "spec" : { "syncMode" : "", "apiEndpoint" : "https://cce-internal.cn-north-4.myhuaweicloud.com", "provider" : "huaweicloud", "type" : "cce", "category" : "self", "region" : "cn-north-4", "country" : "CN", "city" : "150900", "projectID" : "b6315dd3d0ff4be5b31a963256794989", "projectName" : "cn-north-4", "IsDownloadedCert" : false }, "status" : { "kubernetesVersion" : "v1.27", "conditions" : [ { "type" : "Ready", "status" : "True", "lastTransitionTime" : "2023-11-27T12:42:24.182645394+08:00", "reason" : "ClusterAvailable" }, { "type" : "Cluster", "status" : "Available", "lastTransitionTime" : "2023-11-27T12:42:24.182646152+08:00", "reason" : "ClusterAvailable" } ], "endpoints" : [ { "url" : "https://192.168.1.44:5443", "type" : "Internal" } ], "phase" : "Available" } } ]
Status Codes
Status Code |
Description |
---|---|
200 |
CCE clusters that were not registered with UCS were returned. |
400 |
Client request error. The server could not execute the request. |
Error Codes
For details, 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