diff --git a/docs/ucs/api-ref/ALL_META.TXT.json b/docs/ucs/api-ref/ALL_META.TXT.json deleted file mode 100644 index c4b19513f..000000000 --- a/docs/ucs/api-ref/ALL_META.TXT.json +++ /dev/null @@ -1,1029 +0,0 @@ -[ - { - "dockw":"API Reference" - }, - { - "uri":"ucs_api_0001.html", - "node_id":"ucs_api_0001.xml", - "product_code":"ucs", - "code":"1", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "doc_type":"api", - "kw":"Before You Start", - "search_title":"", - "metedata":[ - { - "documenttype":"api", - "prodname":"ucs" - } - ], - "title":"Before You Start", - "githuburl":"" - }, - { - "uri":"ucs_api_0002.html", - "node_id":"ucs_api_0002.xml", - "product_code":"ucs", - "code":"2", - "des":"Ubiquitous Cloud Native Service (UCS) is the first distributed cloud native product in the industry. It provides a consistent experience in cloud native application deplo", - "doc_type":"api", - "kw":"Overview,Before You Start,API Reference", - "search_title":"", - "metedata":[ - { - "documenttype":"api", - "prodname":"ucs" - } - ], - "title":"Overview", - "githuburl":"" - }, - { - "uri":"ucs_api_0003.html", - "node_id":"ucs_api_0003.xml", - "product_code":"ucs", - "code":"3", - "des":"UCS supports Representational State Transfer (REST) APIs, allowing you to call APIs using HTTPS. For details about API calling, see Calling APIs.", - "doc_type":"api", - "kw":"API Calling,Before You Start,API Reference", - "search_title":"", - "metedata":[ - { - "documenttype":"api", - "prodname":"ucs" - } - ], - "title":"API Calling", - "githuburl":"" - }, - { - "uri":"ucs_api_0004.html", - "node_id":"ucs_api_0004.xml", - "product_code":"ucs", - "code":"4", - "des":"An endpoint is the request address for calling an API. Endpoints vary depending on services and regions. The endpoint of UCS consists of the service name, region ID, and ", - "doc_type":"api", - "kw":"Endpoints,Before You Start,API Reference", - "search_title":"", - "metedata":[ - { - "documenttype":"api", - "prodname":"ucs" - } - ], - "title":"Endpoints", - "githuburl":"" - }, - { - "uri":"ucs_api_0005.html", - "node_id":"ucs_api_0005.xml", - "product_code":"ucs", - "code":"5", - "des":"UCS imposes quotas on the number and capacity of resources that a user can access. By default, you can create a maximum of 50 fleets, 50 clusters, and 50 permission polic", - "doc_type":"api", - "kw":"Constraints,Before You Start,API Reference", - "search_title":"", - "metedata":[ - { - "documenttype":"api", - "prodname":"ucs" - } - ], - "title":"Constraints", - "githuburl":"" - }, - { - "uri":"ucs_api_0006.html", - "node_id":"ucs_api_0006.xml", - "product_code":"ucs", - "code":"6", - "des":"DomainA domain is created upon successful signing up. The domain has full access permissions for all of its cloud services and resources. It can be used to reset user pas", - "doc_type":"api", - "kw":"Concepts,Before You Start,API Reference", - "search_title":"", - "metedata":[ - { - "documenttype":"api", - "prodname":"ucs" - } - ], - "title":"Concepts", - "githuburl":"" - }, - { - "uri":"ucs_api_0007.html", - "node_id":"ucs_api_0007.xml", - "product_code":"ucs", - "code":"7", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "doc_type":"api", - "kw":"Calling APIs", - "search_title":"", - "metedata":[ - { - "documenttype":"api", - "prodname":"ucs" - } - ], - "title":"Calling APIs", - "githuburl":"" - }, - { - "uri":"ucs_api_0008.html", - "node_id":"ucs_api_0008.xml", - "product_code":"ucs", - "code":"8", - "des":"This section describes the structure of a REST API request, and uses the IAM API for obtaining a user tokenobtaining a user token as an example to demonstrate how to call", - "doc_type":"api", - "kw":"Making an API Request,Calling APIs,API Reference", - "search_title":"", - "metedata":[ - { - "documenttype":"api", - "prodname":"ucs" - } - ], - "title":"Making an API Request", - "githuburl":"" - }, - { - "uri":"ucs_api_0009.html", - "node_id":"ucs_api_0009.xml", - "product_code":"ucs", - "code":"9", - "des":"Requests for calling an API can be authenticated using an AK/SK pair.An AK/SK is used to verify the identity of a request sender. In AK/SK authentication, a signature nee", - "doc_type":"api", - "kw":"Authentication,Calling APIs,API Reference", - "search_title":"", - "metedata":[ - { - "documenttype":"api", - "prodname":"ucs" - } - ], - "title":"Authentication", - "githuburl":"" - }, - { - "uri":"ucs_api_0010.html", - "node_id":"ucs_api_0010.xml", - "product_code":"ucs", - "code":"10", - "des":"After sending a request, you will receive a response, including a status code, response header, and response body.A status code is a group of digits, ranging from 1xx to ", - "doc_type":"api", - "kw":"Response,Calling APIs,API Reference", - "search_title":"", - "metedata":[ - { - "documenttype":"api", - "prodname":"ucs" - } - ], - "title":"Response", - "githuburl":"" - }, - { - "uri":"ucs_api_0011.html", - "node_id":"ucs_api_0011.xml", - "product_code":"ucs", - "code":"11", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "doc_type":"api", - "kw":"API", - "search_title":"", - "metedata":[ - { - "documenttype":"api", - "prodname":"ucs" - } - ], - "title":"API", - "githuburl":"" - }, - { - "uri":"topic_300000000.html", - "node_id":"topic_300000000.xml", - "product_code":"ucs", - "code":"12", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "doc_type":"api", - "kw":"UCS Clusters", - "search_title":"", - "metedata":[ - { - "prodname":"ucs", - "documenttype":"api", - "opensource":"true", - "operation_id":"ShowClusterList;ShowCluster;RegisterCluster;UpdateCluster;DeleteCluster;ShowClusterAccessInfo;RetryClusterActivation;UpdateClusterRules;ListManagedClusters;ListRegisteredClusterVersions;JoinGroup;LeaveGroup;RegisterClusterGroup;DeleteClusterGroup;ShowClusterGroup;UpdateClusterGroupAssociatedClusters;UpdateClusterGroup;UpdateClusterGroupAssociatedRules;ListClusterGroup;EnableFederation;DisableFederation;ShowFederationProgress;CreateFederationCert;CreateFederationConnection;DownloadFederationKubeconfig;CreateRule;ListRule;DeleteRule;UpdateRule" - } - ], - "title":"UCS Clusters", - "githuburl":"" - }, - { - "uri":"ShowClusterList.html", - "node_id":"showclusterlist.xml", - "product_code":"ucs", - "code":"13", - "des":"This API is used to obtain the cluster list.GET /v1/clustersStatus code: 200NoneStatus code: 200Information about all clusters is obtained.See Error Codes.", - "doc_type":"api", - "kw":"Obtaining the Cluster List,UCS Clusters,API Reference", - "search_title":"", - "metedata":[ - { - "prodname":"ucs", - "documenttype":"api", - "opensource":"true", - "operation_id":"ShowClusterList;ShowCluster;RegisterCluster;UpdateCluster;DeleteCluster;ShowClusterAccessInfo;RetryClusterActivation;UpdateClusterRules;ListManagedClusters;ListRegisteredClusterVersions;JoinGroup;LeaveGroup;RegisterClusterGroup;DeleteClusterGroup;ShowClusterGroup;UpdateClusterGroupAssociatedClusters;UpdateClusterGroup;UpdateClusterGroupAssociatedRules;ListClusterGroup;EnableFederation;DisableFederation;ShowFederationProgress;CreateFederationCert;CreateFederationConnection;DownloadFederationKubeconfig;CreateRule;ListRule;DeleteRule;UpdateRule" - } - ], - "title":"Obtaining the Cluster List", - "githuburl":"" - }, - { - "uri":"ShowCluster.html", - "node_id":"showcluster.xml", - "product_code":"ucs", - "code":"14", - "des":"This API is used to obtain a cluster. The cluster ID must comply with the Kubernetes UUID format rules, and you must have the required permissions on the cluster. Otherwi", - "doc_type":"api", - "kw":"Obtaining a Cluster,UCS Clusters,API Reference", - "search_title":"", - "metedata":[ - { - "prodname":"ucs", - "documenttype":"api", - "opensource":"true", - "operation_id":"ShowClusterList;ShowCluster;RegisterCluster;UpdateCluster;DeleteCluster;ShowClusterAccessInfo;RetryClusterActivation;UpdateClusterRules;ListManagedClusters;ListRegisteredClusterVersions;JoinGroup;LeaveGroup;RegisterClusterGroup;DeleteClusterGroup;ShowClusterGroup;UpdateClusterGroupAssociatedClusters;UpdateClusterGroup;UpdateClusterGroupAssociatedRules;ListClusterGroup;EnableFederation;DisableFederation;ShowFederationProgress;CreateFederationCert;CreateFederationConnection;DownloadFederationKubeconfig;CreateRule;ListRule;DeleteRule;UpdateRule" - } - ], - "title":"Obtaining a Cluster", - "githuburl":"" - }, - { - "uri":"RegisterCluster.html", - "node_id":"registercluster.xml", - "product_code":"ucs", - "code":"15", - "des":"This API is used to register a cluster. Third-party clusters and CCE clusters can be registered.POST /v1/clustersStatus code: 201Registering a CCE cluster{\n \"metadata\" :", - "doc_type":"api", - "kw":"Registering a Cluster,UCS Clusters,API Reference", - "search_title":"", - "metedata":[ - { - "prodname":"ucs", - "documenttype":"api", - "opensource":"true", - "operation_id":"ShowClusterList;ShowCluster;RegisterCluster;UpdateCluster;DeleteCluster;ShowClusterAccessInfo;RetryClusterActivation;UpdateClusterRules;ListManagedClusters;ListRegisteredClusterVersions;JoinGroup;LeaveGroup;RegisterClusterGroup;DeleteClusterGroup;ShowClusterGroup;UpdateClusterGroupAssociatedClusters;UpdateClusterGroup;UpdateClusterGroupAssociatedRules;ListClusterGroup;EnableFederation;DisableFederation;ShowFederationProgress;CreateFederationCert;CreateFederationConnection;DownloadFederationKubeconfig;CreateRule;ListRule;DeleteRule;UpdateRule" - } - ], - "title":"Registering a Cluster", - "githuburl":"" - }, - { - "uri":"UpdateCluster.html", - "node_id":"updatecluster.xml", - "product_code":"ucs", - "code":"16", - "des":"This API is used to update a cluster. Currently, only the country/city of attached clusters and on-premises clusters, and the number of worker nodes in a multi-cloud clus", - "doc_type":"api", - "kw":"Updating a Cluster,UCS Clusters,API Reference", - "search_title":"", - "metedata":[ - { - "prodname":"ucs", - "documenttype":"api", - "opensource":"true", - "operation_id":"ShowClusterList;ShowCluster;RegisterCluster;UpdateCluster;DeleteCluster;ShowClusterAccessInfo;RetryClusterActivation;UpdateClusterRules;ListManagedClusters;ListRegisteredClusterVersions;JoinGroup;LeaveGroup;RegisterClusterGroup;DeleteClusterGroup;ShowClusterGroup;UpdateClusterGroupAssociatedClusters;UpdateClusterGroup;UpdateClusterGroupAssociatedRules;ListClusterGroup;EnableFederation;DisableFederation;ShowFederationProgress;CreateFederationCert;CreateFederationConnection;DownloadFederationKubeconfig;CreateRule;ListRule;DeleteRule;UpdateRule" - } - ], - "title":"Updating a Cluster", - "githuburl":"" - }, - { - "uri":"DeleteCluster.html", - "node_id":"deletecluster.xml", - "product_code":"ucs", - "code":"17", - "des":"This API is used to unregister a cluster. The cluster ID must comply with the Kubernetes UUID format rules, and you must have the required permissions on the correspondin", - "doc_type":"api", - "kw":"Unregistering a Cluster,UCS Clusters,API Reference", - "search_title":"", - "metedata":[ - { - "prodname":"ucs", - "documenttype":"api", - "opensource":"true", - "operation_id":"ShowClusterList;ShowCluster;RegisterCluster;UpdateCluster;DeleteCluster;ShowClusterAccessInfo;RetryClusterActivation;UpdateClusterRules;ListManagedClusters;ListRegisteredClusterVersions;JoinGroup;LeaveGroup;RegisterClusterGroup;DeleteClusterGroup;ShowClusterGroup;UpdateClusterGroupAssociatedClusters;UpdateClusterGroup;UpdateClusterGroupAssociatedRules;ListClusterGroup;EnableFederation;DisableFederation;ShowFederationProgress;CreateFederationCert;CreateFederationConnection;DownloadFederationKubeconfig;CreateRule;ListRule;DeleteRule;UpdateRule" - } - ], - "title":"Unregistering a Cluster", - "githuburl":"" - }, - { - "uri":"ShowClusterAccessInfo.html", - "node_id":"showclusteraccessinfo.xml", - "product_code":"ucs", - "code":"18", - "des":"This API is used to obtain the cluster access information. The cluster ID must comply with the Kubernetes UUID format rules, and you must have the permission to query the", - "doc_type":"api", - "kw":"Obtaining Cluster Access Information,UCS Clusters,API Reference", - "search_title":"", - "metedata":[ - { - "prodname":"ucs", - "documenttype":"api", - "opensource":"true", - "operation_id":"ShowClusterList;ShowCluster;RegisterCluster;UpdateCluster;DeleteCluster;ShowClusterAccessInfo;RetryClusterActivation;UpdateClusterRules;ListManagedClusters;ListRegisteredClusterVersions;JoinGroup;LeaveGroup;RegisterClusterGroup;DeleteClusterGroup;ShowClusterGroup;UpdateClusterGroupAssociatedClusters;UpdateClusterGroup;UpdateClusterGroupAssociatedRules;ListClusterGroup;EnableFederation;DisableFederation;ShowFederationProgress;CreateFederationCert;CreateFederationConnection;DownloadFederationKubeconfig;CreateRule;ListRule;DeleteRule;UpdateRule" - } - ], - "title":"Obtaining Cluster Access Information", - "githuburl":"" - }, - { - "uri":"RetryClusterActivation.html", - "node_id":"retryclusteractivation.xml", - "product_code":"ucs", - "code":"19", - "des":"This API is used to activate a cluster. The cluster ID must comply with the Kubernetes UUID format rules, and you must have the required permission on the corresponding c", - "doc_type":"api", - "kw":"Activating a Cluster,UCS Clusters,API Reference", - "search_title":"", - "metedata":[ - { - "prodname":"ucs", - "documenttype":"api", - "opensource":"true", - "operation_id":"ShowClusterList;ShowCluster;RegisterCluster;UpdateCluster;DeleteCluster;ShowClusterAccessInfo;RetryClusterActivation;UpdateClusterRules;ListManagedClusters;ListRegisteredClusterVersions;JoinGroup;LeaveGroup;RegisterClusterGroup;DeleteClusterGroup;ShowClusterGroup;UpdateClusterGroupAssociatedClusters;UpdateClusterGroup;UpdateClusterGroupAssociatedRules;ListClusterGroup;EnableFederation;DisableFederation;ShowFederationProgress;CreateFederationCert;CreateFederationConnection;DownloadFederationKubeconfig;CreateRule;ListRule;DeleteRule;UpdateRule" - } - ], - "title":"Activating a Cluster", - "githuburl":"" - }, - { - "uri":"ListManagedClusters.html", - "node_id":"listmanagedclusters.xml", - "product_code":"ucs", - "code":"20", - "des":"This API is used to obtain the CCE cluster list of the current tenant.GET /v1/managedclustersStatus code: 200NoneStatus code: 200CCE clusters that are not registered with", - "doc_type":"api", - "kw":"Obtaining the CCE Cluster List of a Tenant,UCS Clusters,API Reference", - "search_title":"", - "metedata":[ - { - "prodname":"ucs", - "documenttype":"api", - "opensource":"true", - "operation_id":"ShowClusterList;ShowCluster;RegisterCluster;UpdateCluster;DeleteCluster;ShowClusterAccessInfo;RetryClusterActivation;UpdateClusterRules;ListManagedClusters;ListRegisteredClusterVersions;JoinGroup;LeaveGroup;RegisterClusterGroup;DeleteClusterGroup;ShowClusterGroup;UpdateClusterGroupAssociatedClusters;UpdateClusterGroup;UpdateClusterGroupAssociatedRules;ListClusterGroup;EnableFederation;DisableFederation;ShowFederationProgress;CreateFederationCert;CreateFederationConnection;DownloadFederationKubeconfig;CreateRule;ListRule;DeleteRule;UpdateRule" - } - ], - "title":"Obtaining the CCE Cluster List of a Tenant", - "githuburl":"" - }, - { - "uri":"ListRegisteredClusterVersions.html", - "node_id":"listregisteredclusterversions.xml", - "product_code":"ucs", - "code":"21", - "des":"This API is used to query the version list of clusters that can be connected to UCS.GET /v1/config/registeredclusterversionsStatus code: 200NoneStatus code: 200Version li", - "doc_type":"api", - "kw":"Querying the Version List of Clusters That Can Be Connected to UCS,UCS Clusters,API Reference", - "search_title":"", - "metedata":[ - { - "prodname":"ucs", - "documenttype":"api", - "opensource":"true", - "operation_id":"ShowClusterList;ShowCluster;RegisterCluster;UpdateCluster;DeleteCluster;ShowClusterAccessInfo;RetryClusterActivation;UpdateClusterRules;ListManagedClusters;ListRegisteredClusterVersions;JoinGroup;LeaveGroup;RegisterClusterGroup;DeleteClusterGroup;ShowClusterGroup;UpdateClusterGroupAssociatedClusters;UpdateClusterGroup;UpdateClusterGroupAssociatedRules;ListClusterGroup;EnableFederation;DisableFederation;ShowFederationProgress;CreateFederationCert;CreateFederationConnection;DownloadFederationKubeconfig;CreateRule;ListRule;DeleteRule;UpdateRule" - } - ], - "title":"Querying the Version List of Clusters That Can Be Connected to UCS", - "githuburl":"" - }, - { - "uri":"topic_300000001.html", - "node_id":"topic_300000001.xml", - "product_code":"ucs", - "code":"22", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "doc_type":"api", - "kw":"Fleets", - "search_title":"", - "metedata":[ - { - "prodname":"ucs", - "documenttype":"api", - "opensource":"true", - "operation_id":"ShowClusterList;ShowCluster;RegisterCluster;UpdateCluster;DeleteCluster;ShowClusterAccessInfo;RetryClusterActivation;UpdateClusterRules;ListManagedClusters;ListRegisteredClusterVersions;JoinGroup;LeaveGroup;RegisterClusterGroup;DeleteClusterGroup;ShowClusterGroup;UpdateClusterGroupAssociatedClusters;UpdateClusterGroup;UpdateClusterGroupAssociatedRules;ListClusterGroup;EnableFederation;DisableFederation;ShowFederationProgress;CreateFederationCert;CreateFederationConnection;DownloadFederationKubeconfig;CreateRule;ListRule;DeleteRule;UpdateRule" - } - ], - "title":"Fleets", - "githuburl":"" - }, - { - "uri":"JoinGroup.html", - "node_id":"joingroup.xml", - "product_code":"ucs", - "code":"23", - "des":"This API is used to add a cluster to a fleet.POST /v1/clusters/{clusterid}/joinNoneAdding a cluster to a fleetStatus code: 200The cluster has been added to the fleet.See ", - "doc_type":"api", - "kw":"Adding a Cluster to a Fleet,Fleets,API Reference", - "search_title":"", - "metedata":[ - { - "prodname":"ucs", - "documenttype":"api", - "opensource":"true", - "operation_id":"ShowClusterList;ShowCluster;RegisterCluster;UpdateCluster;DeleteCluster;ShowClusterAccessInfo;RetryClusterActivation;UpdateClusterRules;ListManagedClusters;ListRegisteredClusterVersions;JoinGroup;LeaveGroup;RegisterClusterGroup;DeleteClusterGroup;ShowClusterGroup;UpdateClusterGroupAssociatedClusters;UpdateClusterGroup;UpdateClusterGroupAssociatedRules;ListClusterGroup;EnableFederation;DisableFederation;ShowFederationProgress;CreateFederationCert;CreateFederationConnection;DownloadFederationKubeconfig;CreateRule;ListRule;DeleteRule;UpdateRule" - } - ], - "title":"Adding a Cluster to a Fleet", - "githuburl":"" - }, - { - "uri":"LeaveGroup.html", - "node_id":"leavegroup.xml", - "product_code":"ucs", - "code":"24", - "des":"This API is used to remove a cluster from a fleet.POST /v1/clusters/{clusterid}/unjoinNoneNoneNoneSee Error Codes.", - "doc_type":"api", - "kw":"Removing a Cluster from a Fleet,Fleets,API Reference", - "search_title":"", - "metedata":[ - { - "prodname":"ucs", - "documenttype":"api", - "opensource":"true", - "operation_id":"ShowClusterList;ShowCluster;RegisterCluster;UpdateCluster;DeleteCluster;ShowClusterAccessInfo;RetryClusterActivation;UpdateClusterRules;ListManagedClusters;ListRegisteredClusterVersions;JoinGroup;LeaveGroup;RegisterClusterGroup;DeleteClusterGroup;ShowClusterGroup;UpdateClusterGroupAssociatedClusters;UpdateClusterGroup;UpdateClusterGroupAssociatedRules;ListClusterGroup;EnableFederation;DisableFederation;ShowFederationProgress;CreateFederationCert;CreateFederationConnection;DownloadFederationKubeconfig;CreateRule;ListRule;DeleteRule;UpdateRule" - } - ], - "title":"Removing a Cluster from a Fleet", - "githuburl":"" - }, - { - "uri":"RegisterClusterGroup.html", - "node_id":"registerclustergroup.xml", - "product_code":"ucs", - "code":"25", - "des":"This API is used to create a fleet. You can select clusters during fleet creation.POST /v1/clustergroupsStatus code: 201Creating a fleet and (optional) adding clusters to", - "doc_type":"api", - "kw":"Creating a Fleet,Fleets,API Reference", - "search_title":"", - "metedata":[ - { - "prodname":"ucs", - "documenttype":"api", - "opensource":"true", - "operation_id":"ShowClusterList;ShowCluster;RegisterCluster;UpdateCluster;DeleteCluster;ShowClusterAccessInfo;RetryClusterActivation;UpdateClusterRules;ListManagedClusters;ListRegisteredClusterVersions;JoinGroup;LeaveGroup;RegisterClusterGroup;DeleteClusterGroup;ShowClusterGroup;UpdateClusterGroupAssociatedClusters;UpdateClusterGroup;UpdateClusterGroupAssociatedRules;ListClusterGroup;EnableFederation;DisableFederation;ShowFederationProgress;CreateFederationCert;CreateFederationConnection;DownloadFederationKubeconfig;CreateRule;ListRule;DeleteRule;UpdateRule" - } - ], - "title":"Creating a Fleet", - "githuburl":"" - }, - { - "uri":"DeleteClusterGroup.html", - "node_id":"deleteclustergroup.xml", - "product_code":"ucs", - "code":"26", - "des":"This API is used to delete a fleet. A fleet can only be deleted when there are no clusters in it. To delete a fleet, remove the clusters from the fleet first. The cluster", - "doc_type":"api", - "kw":"Deleting a Fleet,Fleets,API Reference", - "search_title":"", - "metedata":[ - { - "prodname":"ucs", - "documenttype":"api", - "opensource":"true", - "operation_id":"ShowClusterList;ShowCluster;RegisterCluster;UpdateCluster;DeleteCluster;ShowClusterAccessInfo;RetryClusterActivation;UpdateClusterRules;ListManagedClusters;ListRegisteredClusterVersions;JoinGroup;LeaveGroup;RegisterClusterGroup;DeleteClusterGroup;ShowClusterGroup;UpdateClusterGroupAssociatedClusters;UpdateClusterGroup;UpdateClusterGroupAssociatedRules;ListClusterGroup;EnableFederation;DisableFederation;ShowFederationProgress;CreateFederationCert;CreateFederationConnection;DownloadFederationKubeconfig;CreateRule;ListRule;DeleteRule;UpdateRule" - } - ], - "title":"Deleting a Fleet", - "githuburl":"" - }, - { - "uri":"ShowClusterGroup.html", - "node_id":"showclustergroup.xml", - "product_code":"ucs", - "code":"27", - "des":"This API is used to obtain a fleet.GET /v1/clustergroups/{clustergroupid}Status code: 200NoneStatus code: 200Fleet objectSee Error Codes.", - "doc_type":"api", - "kw":"Obtaining a Fleet,Fleets,API Reference", - "search_title":"", - "metedata":[ - { - "prodname":"ucs", - "documenttype":"api", - "opensource":"true", - "operation_id":"ShowClusterList;ShowCluster;RegisterCluster;UpdateCluster;DeleteCluster;ShowClusterAccessInfo;RetryClusterActivation;UpdateClusterRules;ListManagedClusters;ListRegisteredClusterVersions;JoinGroup;LeaveGroup;RegisterClusterGroup;DeleteClusterGroup;ShowClusterGroup;UpdateClusterGroupAssociatedClusters;UpdateClusterGroup;UpdateClusterGroupAssociatedRules;ListClusterGroup;EnableFederation;DisableFederation;ShowFederationProgress;CreateFederationCert;CreateFederationConnection;DownloadFederationKubeconfig;CreateRule;ListRule;DeleteRule;UpdateRule" - } - ], - "title":"Obtaining a Fleet", - "githuburl":"" - }, - { - "uri":"UpdateClusterGroupAssociatedClusters.html", - "node_id":"updateclustergroupassociatedclusters.xml", - "product_code":"ucs", - "code":"28", - "des":"This API is used to add clusters to a fleet. One or more clusters can be added at the same time. This API cannot be used to remove all or some clusters from a fleet.PUT /", - "doc_type":"api", - "kw":"Adding Clusters to a Fleet,Fleets,API Reference", - "search_title":"", - "metedata":[ - { - "prodname":"ucs", - "documenttype":"api", - "opensource":"true", - "operation_id":"ShowClusterList;ShowCluster;RegisterCluster;UpdateCluster;DeleteCluster;ShowClusterAccessInfo;RetryClusterActivation;UpdateClusterRules;ListManagedClusters;ListRegisteredClusterVersions;JoinGroup;LeaveGroup;RegisterClusterGroup;DeleteClusterGroup;ShowClusterGroup;UpdateClusterGroupAssociatedClusters;UpdateClusterGroup;UpdateClusterGroupAssociatedRules;ListClusterGroup;EnableFederation;DisableFederation;ShowFederationProgress;CreateFederationCert;CreateFederationConnection;DownloadFederationKubeconfig;CreateRule;ListRule;DeleteRule;UpdateRule" - } - ], - "title":"Adding Clusters to a Fleet", - "githuburl":"" - }, - { - "uri":"UpdateClusterGroup.html", - "node_id":"updateclustergroup.xml", - "product_code":"ucs", - "code":"29", - "des":"This API is used to update the description of a fleet. You must have the permissions to update the fleet.PUT /v1/clustergroups/{clustergroupid}/descriptionNoneUpdating fl", - "doc_type":"api", - "kw":"Updating Fleet Description,Fleets,API Reference", - "search_title":"", - "metedata":[ - { - "prodname":"ucs", - "documenttype":"api", - "opensource":"true", - "operation_id":"ShowClusterList;ShowCluster;RegisterCluster;UpdateCluster;DeleteCluster;ShowClusterAccessInfo;RetryClusterActivation;UpdateClusterRules;ListManagedClusters;ListRegisteredClusterVersions;JoinGroup;LeaveGroup;RegisterClusterGroup;DeleteClusterGroup;ShowClusterGroup;UpdateClusterGroupAssociatedClusters;UpdateClusterGroup;UpdateClusterGroupAssociatedRules;ListClusterGroup;EnableFederation;DisableFederation;ShowFederationProgress;CreateFederationCert;CreateFederationConnection;DownloadFederationKubeconfig;CreateRule;ListRule;DeleteRule;UpdateRule" - } - ], - "title":"Updating Fleet Description", - "githuburl":"" - }, - { - "uri":"ListClusterGroup.html", - "node_id":"listclustergroup.xml", - "product_code":"ucs", - "code":"30", - "des":"This API is used to obtain the fleet list.GET /v1/clustergroupsStatus code: 200NoneStatus code: 200The fleet list has been obtained.See Error Codes.", - "doc_type":"api", - "kw":"Obtaining the Fleet List,Fleets,API Reference", - "search_title":"", - "metedata":[ - { - "prodname":"ucs", - "documenttype":"api", - "opensource":"true", - "operation_id":"ShowClusterList;ShowCluster;RegisterCluster;UpdateCluster;DeleteCluster;ShowClusterAccessInfo;RetryClusterActivation;UpdateClusterRules;ListManagedClusters;ListRegisteredClusterVersions;JoinGroup;LeaveGroup;RegisterClusterGroup;DeleteClusterGroup;ShowClusterGroup;UpdateClusterGroupAssociatedClusters;UpdateClusterGroup;UpdateClusterGroupAssociatedRules;ListClusterGroup;EnableFederation;DisableFederation;ShowFederationProgress;CreateFederationCert;CreateFederationConnection;DownloadFederationKubeconfig;CreateRule;ListRule;DeleteRule;UpdateRule" - } - ], - "title":"Obtaining the Fleet List", - "githuburl":"" - }, - { - "uri":"EnableFederation.html", - "node_id":"enablefederation.xml", - "product_code":"ucs", - "code":"31", - "des":"This API is used to enable cluster federation.POST /v1/clustergroups/{clustergroupid}/federationsStatus code: 201container fleet has in enable federation progress.Status ", - "doc_type":"api", - "kw":"Enabling Cluster Federation,Fleets,API Reference", - "search_title":"", - "metedata":[ - { - "prodname":"ucs", - "documenttype":"api", - "opensource":"true", - "operation_id":"ShowClusterList;ShowCluster;RegisterCluster;UpdateCluster;DeleteCluster;ShowClusterAccessInfo;RetryClusterActivation;UpdateClusterRules;ListManagedClusters;ListRegisteredClusterVersions;JoinGroup;LeaveGroup;RegisterClusterGroup;DeleteClusterGroup;ShowClusterGroup;UpdateClusterGroupAssociatedClusters;UpdateClusterGroup;UpdateClusterGroupAssociatedRules;ListClusterGroup;EnableFederation;DisableFederation;ShowFederationProgress;CreateFederationCert;CreateFederationConnection;DownloadFederationKubeconfig;CreateRule;ListRule;DeleteRule;UpdateRule" - } - ], - "title":"Enabling Cluster Federation", - "githuburl":"" - }, - { - "uri":"DisableFederation.html", - "node_id":"disablefederation.xml", - "product_code":"ucs", - "code":"32", - "des":"This API is used to disable cluster federation for a fleet.DELETE /v1/clustergroups/{clustergroupid}/federationsNoneNoneStatus code: 200Cluster federation has been disabl", - "doc_type":"api", - "kw":"Disabling Cluster Federation,Fleets,API Reference", - "search_title":"", - "metedata":[ - { - "prodname":"ucs", - "documenttype":"api", - "opensource":"true", - "operation_id":"ShowClusterList;ShowCluster;RegisterCluster;UpdateCluster;DeleteCluster;ShowClusterAccessInfo;RetryClusterActivation;UpdateClusterRules;ListManagedClusters;ListRegisteredClusterVersions;JoinGroup;LeaveGroup;RegisterClusterGroup;DeleteClusterGroup;ShowClusterGroup;UpdateClusterGroupAssociatedClusters;UpdateClusterGroup;UpdateClusterGroupAssociatedRules;ListClusterGroup;EnableFederation;DisableFederation;ShowFederationProgress;CreateFederationCert;CreateFederationConnection;DownloadFederationKubeconfig;CreateRule;ListRule;DeleteRule;UpdateRule" - } - ], - "title":"Disabling Cluster Federation", - "githuburl":"" - }, - { - "uri":"ShowFederationProgress.html", - "node_id":"showfederationprogress.xml", - "product_code":"ucs", - "code":"33", - "des":"This API is used to query the federation enabling progress.GET /v1/clustergroups/{clustergroupid}/federations/progressStatus code: 200NoneStatus code: 200Job for enabling", - "doc_type":"api", - "kw":"Querying Federation Enabling Progress,Fleets,API Reference", - "search_title":"", - "metedata":[ - { - "prodname":"ucs", - "documenttype":"api", - "opensource":"true", - "operation_id":"ShowClusterList;ShowCluster;RegisterCluster;UpdateCluster;DeleteCluster;ShowClusterAccessInfo;RetryClusterActivation;UpdateClusterRules;ListManagedClusters;ListRegisteredClusterVersions;JoinGroup;LeaveGroup;RegisterClusterGroup;DeleteClusterGroup;ShowClusterGroup;UpdateClusterGroupAssociatedClusters;UpdateClusterGroup;UpdateClusterGroupAssociatedRules;ListClusterGroup;EnableFederation;DisableFederation;ShowFederationProgress;CreateFederationCert;CreateFederationConnection;DownloadFederationKubeconfig;CreateRule;ListRule;DeleteRule;UpdateRule" - } - ], - "title":"Querying Federation Enabling Progress", - "githuburl":"" - }, - { - "uri":"CreateFederationCert.html", - "node_id":"createfederationcert.xml", - "product_code":"ucs", - "code":"34", - "des":"This API is used to create a VPC endpoint for connecting to the federation API server and downloading kubeconfig of the federation API server after federation is enabled ", - "doc_type":"api", - "kw":"Creating a Federation Connection and Downloading kubeconfig,Fleets,API Reference", - "search_title":"", - "metedata":[ - { - "prodname":"ucs", - "documenttype":"api", - "opensource":"true", - "operation_id":"ShowClusterList;ShowCluster;RegisterCluster;UpdateCluster;DeleteCluster;ShowClusterAccessInfo;RetryClusterActivation;UpdateClusterRules;ListManagedClusters;ListRegisteredClusterVersions;JoinGroup;LeaveGroup;RegisterClusterGroup;DeleteClusterGroup;ShowClusterGroup;UpdateClusterGroupAssociatedClusters;UpdateClusterGroup;UpdateClusterGroupAssociatedRules;ListClusterGroup;EnableFederation;DisableFederation;ShowFederationProgress;CreateFederationCert;CreateFederationConnection;DownloadFederationKubeconfig;CreateRule;ListRule;DeleteRule;UpdateRule" - } - ], - "title":"Creating a Federation Connection and Downloading kubeconfig", - "githuburl":"" - }, - { - "uri":"CreateFederationConnection.html", - "node_id":"createfederationconnection.xml", - "product_code":"ucs", - "code":"35", - "des":"This API is used to create a VPC endpoint for connecting to the federation API server after federation is enabled for a fleet.POST /v1/clustergroups/{clustergroupid}/conn", - "doc_type":"api", - "kw":"Creating a Federation Connection,Fleets,API Reference", - "search_title":"", - "metedata":[ - { - "prodname":"ucs", - "documenttype":"api", - "opensource":"true", - "operation_id":"ShowClusterList;ShowCluster;RegisterCluster;UpdateCluster;DeleteCluster;ShowClusterAccessInfo;RetryClusterActivation;UpdateClusterRules;ListManagedClusters;ListRegisteredClusterVersions;JoinGroup;LeaveGroup;RegisterClusterGroup;DeleteClusterGroup;ShowClusterGroup;UpdateClusterGroupAssociatedClusters;UpdateClusterGroup;UpdateClusterGroupAssociatedRules;ListClusterGroup;EnableFederation;DisableFederation;ShowFederationProgress;CreateFederationCert;CreateFederationConnection;DownloadFederationKubeconfig;CreateRule;ListRule;DeleteRule;UpdateRule" - } - ], - "title":"Creating a Federation Connection", - "githuburl":"" - }, - { - "uri":"DownloadFederationKubeconfig.html", - "node_id":"downloadfederationkubeconfig.xml", - "product_code":"ucs", - "code":"36", - "des":"This API is used to download the kubeconfig after the cluster federation is enabled for a fleet and the federation connection is created.POST /v1/clustergroups/{clustergr", - "doc_type":"api", - "kw":"Downloading Federation kubeconfig,Fleets,API Reference", - "search_title":"", - "metedata":[ - { - "prodname":"ucs", - "documenttype":"api", - "opensource":"true", - "operation_id":"ShowClusterList;ShowCluster;RegisterCluster;UpdateCluster;DeleteCluster;ShowClusterAccessInfo;RetryClusterActivation;UpdateClusterRules;ListManagedClusters;ListRegisteredClusterVersions;JoinGroup;LeaveGroup;RegisterClusterGroup;DeleteClusterGroup;ShowClusterGroup;UpdateClusterGroupAssociatedClusters;UpdateClusterGroup;UpdateClusterGroupAssociatedRules;ListClusterGroup;EnableFederation;DisableFederation;ShowFederationProgress;CreateFederationCert;CreateFederationConnection;DownloadFederationKubeconfig;CreateRule;ListRule;DeleteRule;UpdateRule" - } - ], - "title":"Downloading Federation kubeconfig", - "githuburl":"" - }, - { - "uri":"en-us_topic_0000002551843195.html", - "node_id":"en-us_topic_0000002551843195.xml", - "product_code":"ucs", - "code":"37", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "doc_type":"api", - "kw":"Outdated APIs", - "search_title":"", - "metedata":[ - { - "prodname":"ucs", - "documenttype":"api", - "opensource":"true", - "operation_id":"ShowClusterList;ShowCluster;RegisterCluster;UpdateCluster;DeleteCluster;ShowClusterAccessInfo;RetryClusterActivation;UpdateClusterRules;ListManagedClusters;ListRegisteredClusterVersions;JoinGroup;LeaveGroup;RegisterClusterGroup;DeleteClusterGroup;ShowClusterGroup;UpdateClusterGroupAssociatedClusters;UpdateClusterGroup;UpdateClusterGroupAssociatedRules;ListClusterGroup;EnableFederation;DisableFederation;ShowFederationProgress;CreateFederationCert;CreateFederationConnection;DownloadFederationKubeconfig;CreateRule;ListRule;DeleteRule;UpdateRule" - } - ], - "title":"Outdated APIs", - "githuburl":"" - }, - { - "uri":"en-us_topic_0000002551763211.html", - "node_id":"en-us_topic_0000002551763211.xml", - "product_code":"ucs", - "code":"38", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "doc_type":"api", - "kw":"UCS Cluster", - "search_title":"", - "metedata":[ - { - "prodname":"ucs", - "documenttype":"api", - "opensource":"true", - "operation_id":"ShowClusterList;ShowCluster;RegisterCluster;UpdateCluster;DeleteCluster;ShowClusterAccessInfo;RetryClusterActivation;UpdateClusterRules;ListManagedClusters;ListRegisteredClusterVersions;JoinGroup;LeaveGroup;RegisterClusterGroup;DeleteClusterGroup;ShowClusterGroup;UpdateClusterGroupAssociatedClusters;UpdateClusterGroup;UpdateClusterGroupAssociatedRules;ListClusterGroup;EnableFederation;DisableFederation;ShowFederationProgress;CreateFederationCert;CreateFederationConnection;DownloadFederationKubeconfig;CreateRule;ListRule;DeleteRule;UpdateRule" - } - ], - "title":"UCS Cluster", - "githuburl":"" - }, - { - "uri":"UpdateClusterRules.html", - "node_id":"updateclusterrules.xml", - "product_code":"ucs", - "code":"39", - "des":"This API is used to associate a cluster with permission policies.PUT /v1/clusters/{clusterid}/associatedrulesNoneAssociating a cluster with permission policiesNoneSee Err", - "doc_type":"api", - "kw":"Associating a Cluster with Permission Policies,UCS Cluster,API Reference", - "search_title":"", - "metedata":[ - { - "prodname":"ucs", - "documenttype":"api", - "opensource":"true", - "operation_id":"ShowClusterList;ShowCluster;RegisterCluster;UpdateCluster;DeleteCluster;ShowClusterAccessInfo;RetryClusterActivation;UpdateClusterRules;ListManagedClusters;ListRegisteredClusterVersions;JoinGroup;LeaveGroup;RegisterClusterGroup;DeleteClusterGroup;ShowClusterGroup;UpdateClusterGroupAssociatedClusters;UpdateClusterGroup;UpdateClusterGroupAssociatedRules;ListClusterGroup;EnableFederation;DisableFederation;ShowFederationProgress;CreateFederationCert;CreateFederationConnection;DownloadFederationKubeconfig;CreateRule;ListRule;DeleteRule;UpdateRule" - } - ], - "title":"Associating a Cluster with Permission Policies", - "githuburl":"" - }, - { - "uri":"en-us_topic_0000002520563224.html", - "node_id":"en-us_topic_0000002520563224.xml", - "product_code":"ucs", - "code":"40", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "doc_type":"api", - "kw":"Fleet", - "search_title":"", - "metedata":[ - { - "prodname":"ucs", - "documenttype":"api", - "opensource":"true", - "operation_id":"ShowClusterList;ShowCluster;RegisterCluster;UpdateCluster;DeleteCluster;ShowClusterAccessInfo;RetryClusterActivation;UpdateClusterRules;ListManagedClusters;ListRegisteredClusterVersions;JoinGroup;LeaveGroup;RegisterClusterGroup;DeleteClusterGroup;ShowClusterGroup;UpdateClusterGroupAssociatedClusters;UpdateClusterGroup;UpdateClusterGroupAssociatedRules;ListClusterGroup;EnableFederation;DisableFederation;ShowFederationProgress;CreateFederationCert;CreateFederationConnection;DownloadFederationKubeconfig;CreateRule;ListRule;DeleteRule;UpdateRule" - } - ], - "title":"Fleet", - "githuburl":"" - }, - { - "uri":"UpdateClusterGroupAssociatedRules.html", - "node_id":"updateclustergroupassociatedrules.xml", - "product_code":"ucs", - "code":"41", - "des":"This API is used to update the permission policies associated with a fleet.PUT /v1/clustergroups/{clustergroupid}/associatedrulesNoneUpdating the permission policies asso", - "doc_type":"api", - "kw":"Updating Permission Policies Associated with a Fleet,Fleet,API Reference", - "search_title":"", - "metedata":[ - { - "prodname":"ucs", - "documenttype":"api", - "opensource":"true", - "operation_id":"ShowClusterList;ShowCluster;RegisterCluster;UpdateCluster;DeleteCluster;ShowClusterAccessInfo;RetryClusterActivation;UpdateClusterRules;ListManagedClusters;ListRegisteredClusterVersions;JoinGroup;LeaveGroup;RegisterClusterGroup;DeleteClusterGroup;ShowClusterGroup;UpdateClusterGroupAssociatedClusters;UpdateClusterGroup;UpdateClusterGroupAssociatedRules;ListClusterGroup;EnableFederation;DisableFederation;ShowFederationProgress;CreateFederationCert;CreateFederationConnection;DownloadFederationKubeconfig;CreateRule;ListRule;DeleteRule;UpdateRule" - } - ], - "title":"Updating Permission Policies Associated with a Fleet", - "githuburl":"" - }, - { - "uri":"topic_300000002.html", - "node_id":"topic_300000002.xml", - "product_code":"ucs", - "code":"42", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "doc_type":"api", - "kw":"Permissions", - "search_title":"", - "metedata":[ - { - "prodname":"ucs", - "documenttype":"api", - "opensource":"true", - "operation_id":"ShowClusterList;ShowCluster;RegisterCluster;UpdateCluster;DeleteCluster;ShowClusterAccessInfo;RetryClusterActivation;UpdateClusterRules;ListManagedClusters;ListRegisteredClusterVersions;JoinGroup;LeaveGroup;RegisterClusterGroup;DeleteClusterGroup;ShowClusterGroup;UpdateClusterGroupAssociatedClusters;UpdateClusterGroup;UpdateClusterGroupAssociatedRules;ListClusterGroup;EnableFederation;DisableFederation;ShowFederationProgress;CreateFederationCert;CreateFederationConnection;DownloadFederationKubeconfig;CreateRule;ListRule;DeleteRule;UpdateRule" - } - ], - "title":"Permissions", - "githuburl":"" - }, - { - "uri":"CreateRule.html", - "node_id":"createrule.xml", - "product_code":"ucs", - "code":"43", - "des":"This API is used to create a permission policy.POST /v1/permissions/rulesStatus code: 201Creating a permission policyStatus code: 201The UID of the new permission policy ", - "doc_type":"api", - "kw":"Creating a Permission Policy,Permissions,API Reference", - "search_title":"", - "metedata":[ - { - "prodname":"ucs", - "documenttype":"api", - "opensource":"true", - "operation_id":"ShowClusterList;ShowCluster;RegisterCluster;UpdateCluster;DeleteCluster;ShowClusterAccessInfo;RetryClusterActivation;UpdateClusterRules;ListManagedClusters;ListRegisteredClusterVersions;JoinGroup;LeaveGroup;RegisterClusterGroup;DeleteClusterGroup;ShowClusterGroup;UpdateClusterGroupAssociatedClusters;UpdateClusterGroup;UpdateClusterGroupAssociatedRules;ListClusterGroup;EnableFederation;DisableFederation;ShowFederationProgress;CreateFederationCert;CreateFederationConnection;DownloadFederationKubeconfig;CreateRule;ListRule;DeleteRule;UpdateRule" - } - ], - "title":"Creating a Permission Policy", - "githuburl":"" - }, - { - "uri":"ListRule.html", - "node_id":"listrule.xml", - "product_code":"ucs", - "code":"44", - "des":"This API is used to obtain the permission policy list.GET /v1/permissions/rulesStatus code: 200NoneStatus code: 200Permission policy listSee Error Codes.", - "doc_type":"api", - "kw":"Obtaining the Permission Policy List,Permissions,API Reference", - "search_title":"", - "metedata":[ - { - "prodname":"ucs", - "documenttype":"api", - "opensource":"true", - "operation_id":"ShowClusterList;ShowCluster;RegisterCluster;UpdateCluster;DeleteCluster;ShowClusterAccessInfo;RetryClusterActivation;UpdateClusterRules;ListManagedClusters;ListRegisteredClusterVersions;JoinGroup;LeaveGroup;RegisterClusterGroup;DeleteClusterGroup;ShowClusterGroup;UpdateClusterGroupAssociatedClusters;UpdateClusterGroup;UpdateClusterGroupAssociatedRules;ListClusterGroup;EnableFederation;DisableFederation;ShowFederationProgress;CreateFederationCert;CreateFederationConnection;DownloadFederationKubeconfig;CreateRule;ListRule;DeleteRule;UpdateRule" - } - ], - "title":"Obtaining the Permission Policy List", - "githuburl":"" - }, - { - "uri":"DeleteRule.html", - "node_id":"deleterule.xml", - "product_code":"ucs", - "code":"45", - "des":"This API is used to delete a permission policy.DELETE /v1/permissions/rules/{ruleid}NoneNoneNoneSee Error Codes.", - "doc_type":"api", - "kw":"Deleting a Permission Policy,Permissions,API Reference", - "search_title":"", - "metedata":[ - { - "prodname":"ucs", - "documenttype":"api", - "opensource":"true", - "operation_id":"ShowClusterList;ShowCluster;RegisterCluster;UpdateCluster;DeleteCluster;ShowClusterAccessInfo;RetryClusterActivation;UpdateClusterRules;ListManagedClusters;ListRegisteredClusterVersions;JoinGroup;LeaveGroup;RegisterClusterGroup;DeleteClusterGroup;ShowClusterGroup;UpdateClusterGroupAssociatedClusters;UpdateClusterGroup;UpdateClusterGroupAssociatedRules;ListClusterGroup;EnableFederation;DisableFederation;ShowFederationProgress;CreateFederationCert;CreateFederationConnection;DownloadFederationKubeconfig;CreateRule;ListRule;DeleteRule;UpdateRule" - } - ], - "title":"Deleting a Permission Policy", - "githuburl":"" - }, - { - "uri":"UpdateRule.html", - "node_id":"updaterule.xml", - "product_code":"ucs", - "code":"46", - "des":"This API is used to update a permission policy.PUT /v1/permissions/rules/{ruleid}NoneUpdating a permission policyNoneSee Error Codes.", - "doc_type":"api", - "kw":"Updating a Permission Policy,Permissions,API Reference", - "search_title":"", - "metedata":[ - { - "prodname":"ucs", - "documenttype":"api", - "opensource":"true", - "operation_id":"ShowClusterList;ShowCluster;RegisterCluster;UpdateCluster;DeleteCluster;ShowClusterAccessInfo;RetryClusterActivation;UpdateClusterRules;ListManagedClusters;ListRegisteredClusterVersions;JoinGroup;LeaveGroup;RegisterClusterGroup;DeleteClusterGroup;ShowClusterGroup;UpdateClusterGroupAssociatedClusters;UpdateClusterGroup;UpdateClusterGroupAssociatedRules;ListClusterGroup;EnableFederation;DisableFederation;ShowFederationProgress;CreateFederationCert;CreateFederationConnection;DownloadFederationKubeconfig;CreateRule;ListRule;DeleteRule;UpdateRule" - } - ], - "title":"Updating a Permission Policy", - "githuburl":"" - }, - { - "uri":"ucs_api_0015.html", - "node_id":"ucs_api_0015.xml", - "product_code":"ucs", - "code":"47", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "doc_type":"api", - "kw":"Appendix", - "search_title":"", - "metedata":[ - { - "documenttype":"api", - "prodname":"ucs" - } - ], - "title":"Appendix", - "githuburl":"" - }, - { - "uri":"ucs_api_0016.html", - "node_id":"ucs_api_0016.xml", - "product_code":"ucs", - "code":"48", - "des":"Normal valuesReturned ValueDescription200 OKThe results of GET and PUT operations are returned as expected.201 CreatedThe results of the POST operation are returned as ex", - "doc_type":"api", - "kw":"Status Codes,Appendix,API Reference", - "search_title":"", - "metedata":[ - { - "documenttype":"api", - "prodname":"ucs" - } - ], - "title":"Status Codes", - "githuburl":"" - }, - { - "uri":"ErrorCode.html", - "node_id":"errorcode.xml", - "product_code":"ucs", - "code":"49", - "des":"If an exception occurs during the execution of an operation request and the request is not processed, an error message is returned. The error message contains the error c", - "doc_type":"api", - "kw":"Error Codes,Appendix,API Reference", - "search_title":"", - "metedata":[ - { - "documenttype":"api", - "prodname":"ucs" - } - ], - "title":"Error Codes", - "githuburl":"" - }, - { - "uri":"ucs_api_0018.html", - "node_id":"ucs_api_0018.xml", - "product_code":"ucs", - "code":"50", - "des":"A project ID is required for some URLs when an API is called. Therefore, you need to obtain a project ID in advance. Two methods are available:Call an API.Use the console", - "doc_type":"api", - "kw":"Obtaining a Project ID,Appendix,API Reference", - "search_title":"", - "metedata":[ - { - "documenttype":"api", - "prodname":"ucs" - } - ], - "title":"Obtaining a Project ID", - "githuburl":"" - }, - { - "uri":"ucs_api_0019.html", - "node_id":"ucs_api_0019.xml", - "product_code":"ucs", - "code":"51", - "des":"An account ID is required for some URLs when an API is called. To obtain the account ID, perform the following steps:Register an account and log in to the management cons", - "doc_type":"api", - "kw":"Obtaining an Account ID,Appendix,API Reference", - "search_title":"", - "metedata":[ - { - "documenttype":"api", - "prodname":"ucs" - } - ], - "title":"Obtaining an Account ID", - "githuburl":"" - }, - { - "uri":"ucs_api_0022.html", - "node_id":"ucs_api_0022.xml", - "product_code":"ucs", - "code":"52", - "des":"AF: AfghanistanAL: AlbaniaDZ: AlgeriaAD: AndorraAO: AngolaAG: Antigua and BarbudaAR: ArgentinaAM: ArmeniaAU: AustraliaAT: AustriaAZ: AzerbaijanBS: BahamasBH: BahrainBD: B", - "doc_type":"api", - "kw":"Country Codes,Appendix,API Reference", - "search_title":"", - "metedata":[ - { - "documenttype":"api", - "prodname":"ucs" - } - ], - "title":"Country Codes", - "githuburl":"" - }, - { - "uri":"ucs_api_0024.html", - "node_id":"ucs_api_0024.xml", - "product_code":"ucs", - "code":"53", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "doc_type":"api", - "kw":"Cluster Categories and Types,Appendix,API Reference", - "search_title":"", - "metedata":[ - { - "documenttype":"api", - "prodname":"ucs" - } - ], - "title":"Cluster Categories and Types", - "githuburl":"" - } -] \ No newline at end of file diff --git a/docs/ucs/api-ref/CLASS.TXT.json b/docs/ucs/api-ref/CLASS.TXT.json deleted file mode 100644 index d5c456237..000000000 --- a/docs/ucs/api-ref/CLASS.TXT.json +++ /dev/null @@ -1,479 +0,0 @@ -[ - { - "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"ucs", - "title":"Before You Start", - "uri":"ucs_api_0001.html", - "doc_type":"api", - "p_code":"", - "code":"1" - }, - { - "desc":"Ubiquitous Cloud Native Service (UCS) is the first distributed cloud native product in the industry. It provides a consistent experience in cloud native application deplo", - "product_code":"ucs", - "title":"Overview", - "uri":"ucs_api_0002.html", - "doc_type":"api", - "p_code":"1", - "code":"2" - }, - { - "desc":"UCS supports Representational State Transfer (REST) APIs, allowing you to call APIs using HTTPS. For details about API calling, see Calling APIs.", - "product_code":"ucs", - "title":"API Calling", - "uri":"ucs_api_0003.html", - "doc_type":"api", - "p_code":"1", - "code":"3" - }, - { - "desc":"An endpoint is the request address for calling an API. Endpoints vary depending on services and regions. The endpoint of UCS consists of the service name, region ID, and ", - "product_code":"ucs", - "title":"Endpoints", - "uri":"ucs_api_0004.html", - "doc_type":"api", - "p_code":"1", - "code":"4" - }, - { - "desc":"UCS imposes quotas on the number and capacity of resources that a user can access. By default, you can create a maximum of 50 fleets, 50 clusters, and 50 permission polic", - "product_code":"ucs", - "title":"Constraints", - "uri":"ucs_api_0005.html", - "doc_type":"api", - "p_code":"1", - "code":"5" - }, - { - "desc":"DomainA domain is created upon successful signing up. The domain has full access permissions for all of its cloud services and resources. It can be used to reset user pas", - "product_code":"ucs", - "title":"Concepts", - "uri":"ucs_api_0006.html", - "doc_type":"api", - "p_code":"1", - "code":"6" - }, - { - "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"ucs", - "title":"Calling APIs", - "uri":"ucs_api_0007.html", - "doc_type":"api", - "p_code":"", - "code":"7" - }, - { - "desc":"This section describes the structure of a REST API request, and uses the IAM API for obtaining a user tokenobtaining a user token as an example to demonstrate how to call", - "product_code":"ucs", - "title":"Making an API Request", - "uri":"ucs_api_0008.html", - "doc_type":"api", - "p_code":"7", - "code":"8" - }, - { - "desc":"Requests for calling an API can be authenticated using an AK/SK pair.An AK/SK is used to verify the identity of a request sender. In AK/SK authentication, a signature nee", - "product_code":"ucs", - "title":"Authentication", - "uri":"ucs_api_0009.html", - "doc_type":"api", - "p_code":"7", - "code":"9" - }, - { - "desc":"After sending a request, you will receive a response, including a status code, response header, and response body.A status code is a group of digits, ranging from 1xx to ", - "product_code":"ucs", - "title":"Response", - "uri":"ucs_api_0010.html", - "doc_type":"api", - "p_code":"7", - "code":"10" - }, - { - "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"ucs", - "title":"API", - "uri":"ucs_api_0011.html", - "doc_type":"api", - "p_code":"", - "code":"11" - }, - { - "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"ucs", - "title":"UCS Clusters", - "uri":"topic_300000000.html", - "doc_type":"api", - "p_code":"11", - "code":"12" - }, - { - "desc":"This API is used to obtain the cluster list.GET /v1/clustersStatus code: 200NoneStatus code: 200Information about all clusters is obtained.See Error Codes.", - "product_code":"ucs", - "title":"Obtaining the Cluster List", - "uri":"ShowClusterList.html", - "doc_type":"api", - "p_code":"12", - "code":"13" - }, - { - "desc":"This API is used to obtain a cluster. The cluster ID must comply with the Kubernetes UUID format rules, and you must have the required permissions on the cluster. Otherwi", - "product_code":"ucs", - "title":"Obtaining a Cluster", - "uri":"ShowCluster.html", - "doc_type":"api", - "p_code":"12", - "code":"14" - }, - { - "desc":"This API is used to register a cluster. Third-party clusters and CCE clusters can be registered.POST /v1/clustersStatus code: 201Registering a CCE cluster{\n \"metadata\" :", - "product_code":"ucs", - "title":"Registering a Cluster", - "uri":"RegisterCluster.html", - "doc_type":"api", - "p_code":"12", - "code":"15" - }, - { - "desc":"This API is used to update a cluster. Currently, only the country/city of attached clusters and on-premises clusters, and the number of worker nodes in a multi-cloud clus", - "product_code":"ucs", - "title":"Updating a Cluster", - "uri":"UpdateCluster.html", - "doc_type":"api", - "p_code":"12", - "code":"16" - }, - { - "desc":"This API is used to unregister a cluster. The cluster ID must comply with the Kubernetes UUID format rules, and you must have the required permissions on the correspondin", - "product_code":"ucs", - "title":"Unregistering a Cluster", - "uri":"DeleteCluster.html", - "doc_type":"api", - "p_code":"12", - "code":"17" - }, - { - "desc":"This API is used to obtain the cluster access information. The cluster ID must comply with the Kubernetes UUID format rules, and you must have the permission to query the", - "product_code":"ucs", - "title":"Obtaining Cluster Access Information", - "uri":"ShowClusterAccessInfo.html", - "doc_type":"api", - "p_code":"12", - "code":"18" - }, - { - "desc":"This API is used to activate a cluster. The cluster ID must comply with the Kubernetes UUID format rules, and you must have the required permission on the corresponding c", - "product_code":"ucs", - "title":"Activating a Cluster", - "uri":"RetryClusterActivation.html", - "doc_type":"api", - "p_code":"12", - "code":"19" - }, - { - "desc":"This API is used to obtain the CCE cluster list of the current tenant.GET /v1/managedclustersStatus code: 200NoneStatus code: 200CCE clusters that are not registered with", - "product_code":"ucs", - "title":"Obtaining the CCE Cluster List of a Tenant", - "uri":"ListManagedClusters.html", - "doc_type":"api", - "p_code":"12", - "code":"20" - }, - { - "desc":"This API is used to query the version list of clusters that can be connected to UCS.GET /v1/config/registeredclusterversionsStatus code: 200NoneStatus code: 200Version li", - "product_code":"ucs", - "title":"Querying the Version List of Clusters That Can Be Connected to UCS", - "uri":"ListRegisteredClusterVersions.html", - "doc_type":"api", - "p_code":"12", - "code":"21" - }, - { - "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"ucs", - "title":"Fleets", - "uri":"topic_300000001.html", - "doc_type":"api", - "p_code":"11", - "code":"22" - }, - { - "desc":"This API is used to add a cluster to a fleet.POST /v1/clusters/{clusterid}/joinNoneAdding a cluster to a fleetStatus code: 200The cluster has been added to the fleet.See ", - "product_code":"ucs", - "title":"Adding a Cluster to a Fleet", - "uri":"JoinGroup.html", - "doc_type":"api", - "p_code":"22", - "code":"23" - }, - { - "desc":"This API is used to remove a cluster from a fleet.POST /v1/clusters/{clusterid}/unjoinNoneNoneNoneSee Error Codes.", - "product_code":"ucs", - "title":"Removing a Cluster from a Fleet", - "uri":"LeaveGroup.html", - "doc_type":"api", - "p_code":"22", - "code":"24" - }, - { - "desc":"This API is used to create a fleet. You can select clusters during fleet creation.POST /v1/clustergroupsStatus code: 201Creating a fleet and (optional) adding clusters to", - "product_code":"ucs", - "title":"Creating a Fleet", - "uri":"RegisterClusterGroup.html", - "doc_type":"api", - "p_code":"22", - "code":"25" - }, - { - "desc":"This API is used to delete a fleet. A fleet can only be deleted when there are no clusters in it. To delete a fleet, remove the clusters from the fleet first. The cluster", - "product_code":"ucs", - "title":"Deleting a Fleet", - "uri":"DeleteClusterGroup.html", - "doc_type":"api", - "p_code":"22", - "code":"26" - }, - { - "desc":"This API is used to obtain a fleet.GET /v1/clustergroups/{clustergroupid}Status code: 200NoneStatus code: 200Fleet objectSee Error Codes.", - "product_code":"ucs", - "title":"Obtaining a Fleet", - "uri":"ShowClusterGroup.html", - "doc_type":"api", - "p_code":"22", - "code":"27" - }, - { - "desc":"This API is used to add clusters to a fleet. One or more clusters can be added at the same time. This API cannot be used to remove all or some clusters from a fleet.PUT /", - "product_code":"ucs", - "title":"Adding Clusters to a Fleet", - "uri":"UpdateClusterGroupAssociatedClusters.html", - "doc_type":"api", - "p_code":"22", - "code":"28" - }, - { - "desc":"This API is used to update the description of a fleet. You must have the permissions to update the fleet.PUT /v1/clustergroups/{clustergroupid}/descriptionNoneUpdating fl", - "product_code":"ucs", - "title":"Updating Fleet Description", - "uri":"UpdateClusterGroup.html", - "doc_type":"api", - "p_code":"22", - "code":"29" - }, - { - "desc":"This API is used to obtain the fleet list.GET /v1/clustergroupsStatus code: 200NoneStatus code: 200The fleet list has been obtained.See Error Codes.", - "product_code":"ucs", - "title":"Obtaining the Fleet List", - "uri":"ListClusterGroup.html", - "doc_type":"api", - "p_code":"22", - "code":"30" - }, - { - "desc":"This API is used to enable cluster federation.POST /v1/clustergroups/{clustergroupid}/federationsStatus code: 201container fleet has in enable federation progress.Status ", - "product_code":"ucs", - "title":"Enabling Cluster Federation", - "uri":"EnableFederation.html", - "doc_type":"api", - "p_code":"22", - "code":"31" - }, - { - "desc":"This API is used to disable cluster federation for a fleet.DELETE /v1/clustergroups/{clustergroupid}/federationsNoneNoneStatus code: 200Cluster federation has been disabl", - "product_code":"ucs", - "title":"Disabling Cluster Federation", - "uri":"DisableFederation.html", - "doc_type":"api", - "p_code":"22", - "code":"32" - }, - { - "desc":"This API is used to query the federation enabling progress.GET /v1/clustergroups/{clustergroupid}/federations/progressStatus code: 200NoneStatus code: 200Job for enabling", - "product_code":"ucs", - "title":"Querying Federation Enabling Progress", - "uri":"ShowFederationProgress.html", - "doc_type":"api", - "p_code":"22", - "code":"33" - }, - { - "desc":"This API is used to create a VPC endpoint for connecting to the federation API server and downloading kubeconfig of the federation API server after federation is enabled ", - "product_code":"ucs", - "title":"Creating a Federation Connection and Downloading kubeconfig", - "uri":"CreateFederationCert.html", - "doc_type":"api", - "p_code":"22", - "code":"34" - }, - { - "desc":"This API is used to create a VPC endpoint for connecting to the federation API server after federation is enabled for a fleet.POST /v1/clustergroups/{clustergroupid}/conn", - "product_code":"ucs", - "title":"Creating a Federation Connection", - "uri":"CreateFederationConnection.html", - "doc_type":"api", - "p_code":"22", - "code":"35" - }, - { - "desc":"This API is used to download the kubeconfig after the cluster federation is enabled for a fleet and the federation connection is created.POST /v1/clustergroups/{clustergr", - "product_code":"ucs", - "title":"Downloading Federation kubeconfig", - "uri":"DownloadFederationKubeconfig.html", - "doc_type":"api", - "p_code":"22", - "code":"36" - }, - { - "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"ucs", - "title":"Outdated APIs", - "uri":"en-us_topic_0000002551843195.html", - "doc_type":"api", - "p_code":"", - "code":"37" - }, - { - "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"ucs", - "title":"UCS Cluster", - "uri":"en-us_topic_0000002551763211.html", - "doc_type":"api", - "p_code":"37", - "code":"38" - }, - { - "desc":"This API is used to associate a cluster with permission policies.PUT /v1/clusters/{clusterid}/associatedrulesNoneAssociating a cluster with permission policiesNoneSee Err", - "product_code":"ucs", - "title":"Associating a Cluster with Permission Policies", - "uri":"UpdateClusterRules.html", - "doc_type":"api", - "p_code":"38", - "code":"39" - }, - { - "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"ucs", - "title":"Fleet", - "uri":"en-us_topic_0000002520563224.html", - "doc_type":"api", - "p_code":"37", - "code":"40" - }, - { - "desc":"This API is used to update the permission policies associated with a fleet.PUT /v1/clustergroups/{clustergroupid}/associatedrulesNoneUpdating the permission policies asso", - "product_code":"ucs", - "title":"Updating Permission Policies Associated with a Fleet", - "uri":"UpdateClusterGroupAssociatedRules.html", - "doc_type":"api", - "p_code":"40", - "code":"41" - }, - { - "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"ucs", - "title":"Permissions", - "uri":"topic_300000002.html", - "doc_type":"api", - "p_code":"37", - "code":"42" - }, - { - "desc":"This API is used to create a permission policy.POST /v1/permissions/rulesStatus code: 201Creating a permission policyStatus code: 201The UID of the new permission policy ", - "product_code":"ucs", - "title":"Creating a Permission Policy", - "uri":"CreateRule.html", - "doc_type":"api", - "p_code":"42", - "code":"43" - }, - { - "desc":"This API is used to obtain the permission policy list.GET /v1/permissions/rulesStatus code: 200NoneStatus code: 200Permission policy listSee Error Codes.", - "product_code":"ucs", - "title":"Obtaining the Permission Policy List", - "uri":"ListRule.html", - "doc_type":"api", - "p_code":"42", - "code":"44" - }, - { - "desc":"This API is used to delete a permission policy.DELETE /v1/permissions/rules/{ruleid}NoneNoneNoneSee Error Codes.", - "product_code":"ucs", - "title":"Deleting a Permission Policy", - "uri":"DeleteRule.html", - "doc_type":"api", - "p_code":"42", - "code":"45" - }, - { - "desc":"This API is used to update a permission policy.PUT /v1/permissions/rules/{ruleid}NoneUpdating a permission policyNoneSee Error Codes.", - "product_code":"ucs", - "title":"Updating a Permission Policy", - "uri":"UpdateRule.html", - "doc_type":"api", - "p_code":"42", - "code":"46" - }, - { - "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"ucs", - "title":"Appendix", - "uri":"ucs_api_0015.html", - "doc_type":"api", - "p_code":"", - "code":"47" - }, - { - "desc":"Normal valuesReturned ValueDescription200 OKThe results of GET and PUT operations are returned as expected.201 CreatedThe results of the POST operation are returned as ex", - "product_code":"ucs", - "title":"Status Codes", - "uri":"ucs_api_0016.html", - "doc_type":"api", - "p_code":"47", - "code":"48" - }, - { - "desc":"If an exception occurs during the execution of an operation request and the request is not processed, an error message is returned. The error message contains the error c", - "product_code":"ucs", - "title":"Error Codes", - "uri":"ErrorCode.html", - "doc_type":"api", - "p_code":"47", - "code":"49" - }, - { - "desc":"A project ID is required for some URLs when an API is called. Therefore, you need to obtain a project ID in advance. Two methods are available:Call an API.Use the console", - "product_code":"ucs", - "title":"Obtaining a Project ID", - "uri":"ucs_api_0018.html", - "doc_type":"api", - "p_code":"47", - "code":"50" - }, - { - "desc":"An account ID is required for some URLs when an API is called. To obtain the account ID, perform the following steps:Register an account and log in to the management cons", - "product_code":"ucs", - "title":"Obtaining an Account ID", - "uri":"ucs_api_0019.html", - "doc_type":"api", - "p_code":"47", - "code":"51" - }, - { - "desc":"AF: AfghanistanAL: AlbaniaDZ: AlgeriaAD: AndorraAO: AngolaAG: Antigua and BarbudaAR: ArgentinaAM: ArmeniaAU: AustraliaAT: AustriaAZ: AzerbaijanBS: BahamasBH: BahrainBD: B", - "product_code":"ucs", - "title":"Country Codes", - "uri":"ucs_api_0022.html", - "doc_type":"api", - "p_code":"47", - "code":"52" - }, - { - "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"ucs", - "title":"Cluster Categories and Types", - "uri":"ucs_api_0024.html", - "doc_type":"api", - "p_code":"47", - "code":"53" - } -] \ No newline at end of file diff --git a/docs/ucs/api-ref/CreateFederationCert.html b/docs/ucs/api-ref/CreateFederationCert.html deleted file mode 100644 index 24e3ceace..000000000 --- a/docs/ucs/api-ref/CreateFederationCert.html +++ /dev/null @@ -1,404 +0,0 @@ - - -

Creating a Federation Connection and Downloading kubeconfig

-

Function

This API is used to create a VPC endpoint for connecting to the federation API server and downloading kubeconfig of the federation API server after federation is enabled for a fleet.

-
-

URI

POST /v1/clustergroups/{clustergroupid}/cert

- -
- - - - - - - - - - - -
Table 1 Path parameter

Parameter

-

Mandatory

-

Type

-

Description

-

clustergroupid

-

Yes

-

String

-

Fleet ID

-
-
-
-

Request Parameters

-
- - - - - - - - - - - - - - - - -
Table 2 Parameters in the request header

Parameter

-

Mandatory

-

Type

-

Description

-

X-Auth-Token

-

Yes

-

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.

-

Content-Type

-

Yes

-

String

-

Message body type (format). Only application/json is supported.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 3 Parameters in the request body

Parameter

-

Mandatory

-

Type

-

Description

-

projectID

-

Yes

-

String

-

Project ID

-

vpcID

-

Yes

-

String

-

VPC ID, which must belong to the project specified by projectID.

-

subnetID

-

Yes

-

String

-

Subnet ID, which must belong to the VPC specified by vpcID.

-

duration

-

Yes

-

Integer

-

Validity period of the certificate in kubeconfig, in days.

-

Minimum value: 1

-

Maximum value: 1825

-
-
-
-

Response Parameters

Status code: 201

- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 4 Parameters in the response body

Parameter

-

Type

-

Description

-

kind

-

String

-

API type. The value is fixed at Config and cannot be changed.

-

apiVersion

-

String

-

API version. The value is fixed at v1 and cannot be changed.

-

clusters

-

Array of NamedCluster objects

-

Cluster list

-

users

-

Array of NamedAuthInfo objects

-

Certificate information and client key information of specified users

-

contexts

-

Array of NamedContext objects

-

Context list

-

current-context

-

String

-

Current context

-
-
- -
- - - - - - - - - - - - - -
Table 5 NamedCluster

Parameter

-

Type

-

Description

-

name

-

String

-

Cluster name

-

cluster

-

ClusterCert object

-

Cluster information

-
-
- -
- - - - - - - - - - - - - - - - - -
Table 6 ClusterCert

Parameter

-

Type

-

Description

-

server

-

String

-

Server address

-

certificate-authority-data

-

String

-

Certificate authorization data

-

insecure-skip-tls-verify

-

String

-

Whether to skip server certificate verification

-
-
- -
- - - - - - - - - - - - - -
Table 7 NamedAuthInfo

Parameter

-

Type

-

Description

-

name

-

String

-

Username

-

user

-

AuthInfo object

-

Certificate information and client key information of a specified user

-
-
- -
- - - - - - - - - - - - - - - - - -
Table 8 AuthInfo

Parameter

-

Type

-

Description

-

client-certificate-data

-

String

-

Client certificate

-

client-key-data

-

String

-

PEM encoding data from the TLS client key file

-

token

-

String

-

Authentication token

-
-
- -
- - - - - - - - - - - - - -
Table 9 NamedContext

Parameter

-

Type

-

Description

-

name

-

String

-

Context name

-

context

-

Context object

-

Context information

-
-
- -
- - - - - - - - - - - - - -
Table 10 Context

Parameter

-

Type

-

Description

-

cluster

-

String

-

Cluster context

-

user

-

String

-

User context

-
-
-
-

Example Requests

Creating a federation connection and downloading kubeconfig

-
{
-  "projectID" : "08d44be1ef00d22e2f6fc0061f54a2f1",
-  "vpcID" : "11c9fe72-5a90-4295-bcfe-774726fb9066",
-  "subnetID" : "0de91d89-1e06-4e24-b371-35d5d3d3779b",
-  "duration" : 30
-}
-

Example Responses

-

Status code: 201

-

kubeconfig file

-
{
-  "kind" : "Config",
-  "apiVersion" : "v1",
-  "clusters" : [ {
-    "name" : "cluster-demo",
-    "cluster" : {
-      "server" : "https://ip:port",
-      "certificate-authority-data" : ""
-    }
-  } ],
-  "users" : [ {
-    "name" : "user",
-    "user" : {
-      "client-certificate-data" : "",
-      "client-key-data" : "",
-      "token" : ""
-    }
-  } ],
-  "contexts" : [ {
-    "name" : "demo",
-    "context" : {
-      "cluster" : "cluster-demo",
-      "user" : "user"
-    }
-  } ],
-  "current-context" : "demo"
-}
-
-

Status Codes

-
- - - - - - - -

Status Code

-

Description

-

201

-

kubeconfig file

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: Fleets
-
-
- diff --git a/docs/ucs/api-ref/CreateFederationConnection.html b/docs/ucs/api-ref/CreateFederationConnection.html deleted file mode 100644 index 9c5fa22b2..000000000 --- a/docs/ucs/api-ref/CreateFederationConnection.html +++ /dev/null @@ -1,179 +0,0 @@ - - -

Creating a Federation Connection

-

Function

This API is used to create a VPC endpoint for connecting to the federation API server after federation is enabled for a fleet.

-
-

URI

POST /v1/clustergroups/{clustergroupid}/connection

- -
- - - - - - - - - - - -
Table 1 Path parameter

Parameter

-

Mandatory

-

Type

-

Description

-

clustergroupid

-

Yes

-

String

-

Fleet ID

-
-
-
-

Request Parameters

-
- - - - - - - - - - - - - - - - -
Table 2 Parameters in the request header

Parameter

-

Mandatory

-

Type

-

Description

-

X-Auth-Token

-

Yes

-

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.

-

Content-Type

-

Yes

-

String

-

Message body type (format). Only application/json is supported.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - -
Table 3 Parameters in the request body

Parameter

-

Mandatory

-

Type

-

Description

-

projectID

-

Yes

-

String

-

Project ID

-

vpcID

-

Yes

-

String

-

VPC ID, which must belong to the project specified by projectID.

-

subnetID

-

Yes

-

String

-

Network ID of the subnet. The subnet must be in the VPC specified by vpcID.

-
-
-
-

Response Parameters

Status code: 201

- -
- - - - - - - - - - - - - - - - - -
Table 4 Parameters in the response body

Parameter

-

Type

-

Description

-

id

-

String

-

VPC endpoint ID

-

ip

-

String

-

IP address of the VPC endpoint

-

dnsNames

-

Array of strings

-

Domain names of VPC endpoint services

-
-
-
-

Example Requests

Creating a federation connection

-
{
-  "projectID" : "08d44be1ef00d22e2f6fc0061f54a2f1",
-  "vpcID" : "11c9fe72-5a90-4295-bcfe-774726fb9066",
-  "subnetID" : "0de91d89-1e06-4e24-b371-35d5d3d3779b"
-}
-
-

Example Responses

Status code: 201

-

The federation API server has been connected using a VPC endpoint.

-
{
-  "id" : "a02c4097-ff39-4d76-b9e3-743b7f400d01"
-  "ip" : "192.168.1.116"
-  "dnsNames" : "test-ucs-fleet.fleet.ucs.eu-de.com"
-}
-
-

Status Codes

-
- - - - - - - -

Status Code

-

Description

-

201

-

The federation API server has been connected using a VPC endpoint.

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: Fleets
-
-
- diff --git a/docs/ucs/api-ref/CreateRule.html b/docs/ucs/api-ref/CreateRule.html deleted file mode 100644 index 1615f944b..000000000 --- a/docs/ucs/api-ref/CreateRule.html +++ /dev/null @@ -1,256 +0,0 @@ - - -

Creating a Permission Policy

-

Function

This API is used to create a permission policy.

-
-

URI

POST /v1/permissions/rules

-
-

Request Parameters

-
- - - - - - - - - - - - - - - - -
Table 1 Parameters in the request header

Parameter

-

Mandatory

-

Type

-

Description

-

X-Auth-Token

-

Yes

-

String

-

Identity authentication information

-

Minimum length: 1

-

Maximum length: 16384

-

Content-Type

-

Yes

-

String

-

Request body type or format

-
-
- -
- - - - - - - - - - - - - - - - -
Table 2 Parameters in the request body

Parameter

-

Mandatory

-

Type

-

Description

-

metadata

-

Yes

-

CreateRuleObjectMeta object

-

Basic information about the permission policy. Metadata is a collection of attributes.

-

spec

-

Yes

-

RuleSpec object

-

Details about the permission policy. UCS creates or updates the permission policy by spec.

-
-
- -
- - - - - - - - - - - -
Table 3 CreateRuleObjectMeta

Parameter

-

Mandatory

-

Type

-

Description

-

name

-

Yes

-

String

-

Permission policy name

-

Minimum length: 1

-

Maximum: 63

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 4 RuleSpec

Parameter

-

Mandatory

-

Type

-

Description

-

iamuserids

-

No

-

Array of strings

-

Information of IAM users associated with a permission policy

-

type

-

No

-

String

-

Permission policy type. The value can be readonly, develop, admin, or custom.

-

contents

-

No

-

Array of Content objects

-

Permission policy content

-

description

-

No

-

String

-

Permission policy description

-

Minimum length: 0

-

Maximum length: 255

-
-
- -
- - - - - - - - - - - - - - - - -
Table 5 Content

Parameter

-

Mandatory

-

Type

-

Description

-

verbs

-

No

-

Array of strings

-

Action list

-

resources

-

No

-

Array of strings

-

Resource list

-
-
-
-

Response Parameters

Status code: 201

- -
- - - - - - - - - -
Table 6 Parameter in the response body

Parameter

-

Type

-

Description

-

uid

-

String

-

Permission policy UID

-
-
-
-

Example Requests

Creating a permission policy

-
{
-  "metadata" : {
-    "name" : "xxxxx"
-  },
-  "spec" : {
-    "type" : "admin",
-    "iamUserIDs" : [ "xxxxx" ]
-  }
-}
-
-

Example Responses

Status code: 201

-

The UID of the new permission policy has been returned.

-
{
-  "uid" : "xxxx-xxxx-xxxx-xxxx"
-}
-
-

Status Codes

-
- - - - - - - - - - - - - -

Status Code

-

Description

-

201

-

The UID of the new permission policy has been returned.

-

400

-

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

-

500

-

Internal server error.

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: Permissions
-
-
- diff --git a/docs/ucs/api-ref/DeleteCluster.html b/docs/ucs/api-ref/DeleteCluster.html deleted file mode 100644 index 5d70016f4..000000000 --- a/docs/ucs/api-ref/DeleteCluster.html +++ /dev/null @@ -1,190 +0,0 @@ - - -

Unregistering a Cluster

-

Function

This API is used to unregister a cluster. The cluster ID must comply with the Kubernetes UUID format rules, and you must have the required permissions on the corresponding cluster. Otherwise, the authentication fails.

-
-

URI

DELETE /v1/clusters/{clusterid}

- -
- - - - - - - - - - - -
Table 1 Path parameter

Parameter

-

Mandatory

-

Type

-

Description

-

clusterid

-

Yes

-

String

-

Cluster ID

-
-
-
-

Request Parameters

-
- - - - - - - - - - - - - - - - -
Table 2 Parameters in the request header

Parameter

-

Mandatory

-

Type

-

Description

-

X-Auth-Token

-

Yes

-

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.

-

Content-Type

-

Yes

-

String

-

Message body type (format). Only application/json is supported.

-
-
-
-

Response Parameters

Status code: 200

- -
- - - - - - - - - -
Table 3 Parameter in the response body

Parameter

-

Type

-

Description

-

-

-

String

-

The cluster has been unregistered.

-
-
-

Status code: 400

- -
- - - - - - - - - -
Table 4 Parameter in the response body

Parameter

-

Type

-

Description

-

-

-

String

-

-

-
-
-

Status code: 404

- -
- - - - - - - - - -
Table 5 Parameter in the response body

Parameter

-

Type

-

Description

-

-

-

String

-

-

-
-
-

Status code: 500

- -
- - - - - - - - - -
Table 6 Parameter in the response body

Parameter

-

Type

-

Description

-

-

-

String

-

-

-
-
-
-

Example Requests

None

-
-

Example Responses

Status code: 200

-

The cluster has been unregistered.

-
{ }
-
-

Status Codes

-
- - - - - - - - - - - - - - - - -

Status Code

-

Description

-

200

-

The cluster has been unregistered.

-

400

-

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

-

404

-

Resources not found.

-

500

-

Internal server error.

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: UCS Clusters
-
-
- diff --git a/docs/ucs/api-ref/DeleteClusterGroup.html b/docs/ucs/api-ref/DeleteClusterGroup.html deleted file mode 100644 index 49bd1ec18..000000000 --- a/docs/ucs/api-ref/DeleteClusterGroup.html +++ /dev/null @@ -1,116 +0,0 @@ - - -

Deleting a Fleet

-

Function

This API is used to delete a fleet. A fleet can only be deleted when there are no clusters in it. To delete a fleet, remove the clusters from the fleet first. The cluster IDs must comply with the Kubernetes UUID format rules, and you must have operation permissions on the clusters. Otherwise, the authentication fails.

-
-

URI

DELETE /v1/clustergroups/{clustergroupid}

- -
- - - - - - - - - - - -
Table 1 Path parameter

Parameter

-

Mandatory

-

Type

-

Description

-

clustergroupid

-

Yes

-

String

-

Fleet ID

-
-
-
-

Request Parameters

-
- - - - - - - - - - - - - - - - -
Table 2 Parameters in the request header

Parameter

-

Mandatory

-

Type

-

Description

-

X-Auth-Token

-

Yes

-

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.

-

Content-Type

-

Yes

-

String

-

Message body type (format). Only application/json is supported.

-
-
-
-

Response Parameters

None

-
-

Example Requests

None

-
-

Example Responses

Status code: 200

-

The fleet has been deleted.

-
{ }
-
-

Status Codes

-
- - - - - - - - - - - - - - - - - - - -

Status Code

-

Description

-

200

-

The fleet has been deleted.

-

400

-

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

-

403

-

The server refused the request.

-

404

-

Resources not found.

-

500

-

Internal server error.

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: Fleets
-
-
- diff --git a/docs/ucs/api-ref/DeleteRule.html b/docs/ucs/api-ref/DeleteRule.html deleted file mode 100644 index 2f6fa2ec1..000000000 --- a/docs/ucs/api-ref/DeleteRule.html +++ /dev/null @@ -1,106 +0,0 @@ - - -

Deleting a Permission Policy

-

Function

This API is used to delete a permission policy.

-
-

URI

DELETE /v1/permissions/rules/{ruleid}

- -
- - - - - - - - - - - -
Table 1 Path parameter

Parameter

-

Mandatory

-

Type

-

Description

-

ruleid

-

Yes

-

String

-

Permission policy ID

-
-
-
-

Request Parameters

-
- - - - - - - - - - - - - - - - -
Table 2 Parameters in the request header

Parameter

-

Mandatory

-

Type

-

Description

-

X-Auth-Token

-

Yes

-

String

-

Identity authentication information

-

Minimum length: 1

-

Maximum length: 16384

-

Content-Type

-

Yes

-

String

-

Request body type or format

-
-
-
-

Response Parameters

None

-
-

Example Requests

None

-
-

Example Responses

None

-
-

Status Codes

-
- - - - - - - - - - - - - -

Status Code

-

Description

-

200

-

The permission policy has been deleted.

-

400

-

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

-

500

-

Internal server error.

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: Permissions
-
-
- diff --git a/docs/ucs/api-ref/DisableFederation.html b/docs/ucs/api-ref/DisableFederation.html deleted file mode 100644 index 281add07d..000000000 --- a/docs/ucs/api-ref/DisableFederation.html +++ /dev/null @@ -1,111 +0,0 @@ - - -

Disabling Cluster Federation

-

Function

This API is used to disable cluster federation for a fleet.

-
-

URI

DELETE /v1/clustergroups/{clustergroupid}/federations

- -
- - - - - - - - - - - -
Table 1 Path parameter

Parameter

-

Mandatory

-

Type

-

Description

-

clustergroupid

-

Yes

-

String

-

Fleet ID

-
-
-
-

Request Parameters

-
- - - - - - - - - - - - - - - - -
Table 2 Parameters in the request header

Parameter

-

Mandatory

-

Type

-

Description

-

X-Auth-Token

-

Yes

-

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.

-

Content-Type

-

Yes

-

String

-

Message body type (format). Only application/json is supported.

-
-
-
-

Response Parameters

None

-
-

Example Requests

None

-
-

Example Responses

Status code: 200

-

Cluster federation has been disabled.

-
{ }
-
-

Status Codes

-
- - - - - - - - - - - - - - - - -

Status Code

-

Description

-

200

-

Cluster federation has been disabled.

-

400

-

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

-

404

-

Resources not found.

-

500

-

Internal server error.

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: Fleets
-
-
- diff --git a/docs/ucs/api-ref/DownloadFederationKubeconfig.html b/docs/ucs/api-ref/DownloadFederationKubeconfig.html deleted file mode 100644 index 68df11b14..000000000 --- a/docs/ucs/api-ref/DownloadFederationKubeconfig.html +++ /dev/null @@ -1,374 +0,0 @@ - - -

Downloading Federation kubeconfig

-

Function

This API is used to download the kubeconfig after the cluster federation is enabled for a fleet and the federation connection is created.

-
-

URI

POST /v1/clustergroups/{clustergroupid}/kubeconfig

- -
- - - - - - - - - - - -
Table 1 Path parameter

Parameter

-

Mandatory

-

Type

-

Description

-

clustergroupid

-

Yes

-

String

-

Fleet ID

-
-
-
-

Request Parameters

-
- - - - - - - - - - - - - - - - -
Table 2 Parameters in the request header

Parameter

-

Mandatory

-

Type

-

Description

-

X-Auth-Token

-

Yes

-

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.

-

Content-Type

-

Yes

-

String

-

Message body type (format). Only application/json is supported.

-
-
- -
- - - - - - - - - - - -
Table 3 Parameter in the request body

Parameter

-

Mandatory

-

Type

-

Description

-

duration

-

Yes

-

Integer

-

Validity period of the certificate in kubeconfig

-

Minimum value: 1

-

Maximum value: 1825

-
-
-
-

Response Parameters

Status code: 201

- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 4 Parameters in the response body

Parameter

-

Type

-

Description

-

kind

-

String

-

API type. The value is fixed at Config and cannot be changed.

-

apiVersion

-

String

-

API version. The value is fixed at v1 and cannot be changed.

-

clusters

-

Array of NamedCluster objects

-

Cluster list

-

users

-

Array of NamedAuthInfo objects

-

Certificate information and client key information of specified users

-

contexts

-

Array of NamedContext objects

-

Context list

-

current-context

-

String

-

Current context

-
-
- -
- - - - - - - - - - - - - -
Table 5 NamedCluster

Parameter

-

Type

-

Description

-

name

-

String

-

Cluster name

-

cluster

-

ClusterCert object

-

Cluster information

-
-
- -
- - - - - - - - - - - - - - - - - -
Table 6 ClusterCert

Parameter

-

Type

-

Description

-

server

-

String

-

Server address

-

certificate-authority-data

-

String

-

Certificate authorization data

-

insecure-skip-tls-verify

-

String

-

Whether to skip server certificate verification

-
-
- -
- - - - - - - - - - - - - -
Table 7 NamedAuthInfo

Parameter

-

Type

-

Description

-

name

-

String

-

Username

-

user

-

AuthInfo object

-

Certificate information and client key information of a specified user

-
-
- -
- - - - - - - - - - - - - - - - - -
Table 8 AuthInfo

Parameter

-

Type

-

Description

-

client-certificate-data

-

String

-

Client certificate

-

client-key-data

-

String

-

PEM encoding data from the TLS client key file

-

token

-

String

-

Authentication token

-
-
- -
- - - - - - - - - - - - - -
Table 9 NamedContext

Parameter

-

Type

-

Description

-

name

-

String

-

Context name

-

context

-

Context object

-

Context information

-
-
- -
- - - - - - - - - - - - - -
Table 10 Context

Parameter

-

Type

-

Description

-

cluster

-

String

-

Cluster context

-

user

-

String

-

User context

-
-
-
-

Example Requests

Downloading federation kubeconfig

-
{
-  "duration" : 30
-}
-
-

Example Responses

Status code: 201

-

kubeconfig file

-
{
-  "kind" : "Config",
-  "apiVersion" : "v1",
-  "clusters" : [ {
-    "name" : "cluster-demo",
-    "cluster" : {
-      "server" : "https://ip:port",
-      "certificate-authority-data" : ""
-    }
-  } ],
-  "users" : [ {
-    "name" : "user",
-    "user" : {
-      "client-certificate-data" : "",
-      "client-key-data" : "",
-      "token" : ""
-    }
-  } ],
-  "contexts" : [ {
-    "name" : "demo",
-    "context" : {
-      "cluster" : "cluster-demo",
-      "user" : "user"
-    }
-  } ],
-  "current-context" : "demo"
-}
-
-

Status Codes

-
- - - - - - - -

Status Code

-

Description

-

201

-

kubeconfig file

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: Fleets
-
-
- diff --git a/docs/ucs/api-ref/EnableFederation.html b/docs/ucs/api-ref/EnableFederation.html deleted file mode 100644 index 36cd7f5cc..000000000 --- a/docs/ucs/api-ref/EnableFederation.html +++ /dev/null @@ -1,195 +0,0 @@ - - -

Enabling Cluster Federation

-

Function

This API is used to enable cluster federation.

-
-

URI

POST /v1/clustergroups/{clustergroupid}/federations

- -
- - - - - - - - - - - -
Table 1 Path parameter

Parameter

-

Mandatory

-

Type

-

Description

-

clustergroupid

-

Yes

-

String

-

Fleet ID

-
-
- -
- - - - - - - - - - - -
Table 2 Query parameter

Parameter

-

Mandatory

-

Type

-

Description

-

retryjoinall

-

No

-

Boolean

-

Whether to retry adding the cluster to the federation.

-
-
-
-

Request Parameters

-
- - - - - - - - - - - - - - - - -
Table 3 Parameters in the request header

Parameter

-

Mandatory

-

Type

-

Description

-

X-Auth-Token

-

Yes

-

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.

-

Content-Type

-

Yes

-

String

-

Message body type (format). Only application/json is supported.

-
-
-
-

Response Parameters

Status code: 201

-

container fleet has in enable federation progress.

-

Status code: 400

- -
- - - - - - - - - -
Table 4 Response body parameters

Parameter

-

Type

-

Description

-

-

-

String

-

-

-
-
-

Status code: 404

- -
- - - - - - - - - -
Table 5 Response body parameters

Parameter

-

Type

-

Description

-

-

-

String

-

-

-
-
-

Status code: 500

- -
- - - - - - - - - -
Table 6 Response body parameters

Parameter

-

Type

-

Description

-

-

-

String

-

-

-
-
-
-

Example Requests

None

-
-

Example Responses

Status code: 201

-

Cluster federation has been enabled.

-
{ }
-
-

Status Codes

-
- - - - - - - - - - - - - - - - -

Status Code

-

Description

-

201

-

Cluster federation has been enabled.

-

400

-

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

-

404

-

Resources not found.

-

500

-

Internal server error.

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: Fleets
-
-
- diff --git a/docs/ucs/api-ref/ErrorCode.html b/docs/ucs/api-ref/ErrorCode.html deleted file mode 100644 index 923fe3c18..000000000 --- a/docs/ucs/api-ref/ErrorCode.html +++ /dev/null @@ -1,1438 +0,0 @@ - - -

Error Codes

-

If an exception occurs during the execution of an operation request and the request is not processed, an error message is returned. The error message contains the error code and description. Table 1 lists the common error codes and error messages. You can rectify the errors following the description.

- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 1 Error code description

Error Code

-

Status Code

-

Error Message

-

Description

-

UCS.00000001

-

400

-

Failed to obtain the user information.

-

Failed to obtain the user information.

-

UCS.00000003

-

400

-

Failed to obtain the federation information.

-

Failed to obtain the federation information.

-

UCS.00000004

-

403

-

Request forbidden.

-

Forbidden request.

-

UCS.00000005

-

500

-

Database operation failed.

-

Failed to operate the database.

-

UCS.00000006

-

500

-

Server internal error.

-

Internal server error.

-

UCS.00000007

-

500

-

Data transform error.

-

Data conversion failed.

-

UCS.00000008

-

500

-

Error add event.

-

Failed to add the event.

-

UCS.00000009

-

500

-

Data unmarshal error.

-

Failed to deserialize data.

-

UCS.00000010

-

500

-

Data marshal error.

-

Failed to serialize data.

-

UCS.00000011

-

400

-

Bad query parameter value.

-

Invalid request parameter.

-

UCS.00000012

-

400

-

Invalid request body.

-

Invalid request body.

-

UCS.00000013

-

404

-

No requested resources found.

-

The requested resource cannot be found.

-

UCS.00000014

-

500

-

Failed to encrypt data.

-

Data encryption failed.

-

UCS.00000015

-

500

-

Failed to decrypt data.

-

Data decryption failed.

-

UCS.00000016

-

400

-

Invalid header value.

-

Invalid request header.

-

UCS.00000017

-

400

-

Insufficient quota

-

Insufficient quota.

-

UCS.00000018

-

401

-

Authorization failed.

-

Authorization failed.

-

UCS.00010001

-

500

-

Failed to get iam connection.

-

IAM connection failed.

-

UCS.00010002

-

403

-

Sub-user has no authority to create agency.

-

The IAM user does not have the permission for creating an agency.

-

UCS.00010003

-

400

-

Failed to create agency.

-

Failed to create an agency.

-

UCS.00010004

-

500

-

Failed to get role id for te_admin.

-

Failed to obtain the te_admin role.

-

UCS.00010005

-

500

-

Failed to get admin token from iam.

-

Failed to obtain the admin token.

-

UCS.00010006

-

500

-

Failed to get agency list from iam.

-

Failed to obtain the agency list.

-

UCS.00010007

-

500

-

Failed to get agency grants from iam.

-

Failed to obtain the agency grants.

-

UCS.00010008

-

500

-

Failed to update agency role.

-

Failed to update the agency role.

-

UCS.00010009

-

400

-

Failed to get project token by agency

-

Failed to obtain the project token through the agency.

-

UCS.00010010

-

400

-

Failed to get op_svc account domain token

-

Failed to obtain the token of the op account.

-

UCS.00010011

-

400

-

Failed to get project id by project name.

-

Failed to obtain the project ID.

-

UCS.00010012

-

400

-

IAM agency quota insufficient, please expand agency quota

-

IAM agency quota exceeded.

-

UCS.00010013

-

400

-

fail to get iam pdp authorize result

-

Failed to obtain the PDP authentication result.

-

UCS.00010014

-

403

-

iam pdp authentication denied

-

PDP authentication rejected.

-

UCS.00010015

-

403

-

iam rbac authentication denied

-

RBAC authentication rejected.

-

UCS.00020001

-

500

-

Failed to get aeskey.

-

Failed to obtain the aeskey.

-

UCS.00020002

-

500

-

Failed to get certs.

-

Failed to obtain the certificate.

-

UCS.00020003

-

500

-

Failed to create certs.

-

Failed to create the certificate.

-

UCS.00020003

-

500

-

Failed to delete certs.

-

Failed to delete the certificate.

-

UCS.00030001

-

404

-

Cluster Not Found.

-

No clusters found.

-

UCS.00030002

-

400

-

Failed to obtain the cluster information.

-

Failed to obtain the cluster information.

-

UCS.00030003

-

400

-

Failed to get resourceJob info with cluster status

-

Failed to obtain the resource job.

-

UCS.00040001

-

400

-

Failed to obtain the mesh information.

-

Failed to obtain the mesh information.

-

UCS.00090001

-

500

-

Failed to create DNSRecord

-

Failed to create the record set.

-

UCS.00100001

-

400

-

Failed to publish message to smn.

-

Failed to publish messages to SMN.

-

UCS.00100002

-

400

-

smn topic error.

-

Invalid SMN topic.

-

UCS.00100003

-

400

-

smn subscription error.

-

SMN subscription error.

-

UCS.00110001

-

400

-

SDR failed to get billing raw data

-

Failed to obtain billing data.

-

UCS.00110002

-

400

-

Formatting raw billing data to SDR format error

-

Failed to format billing data.

-

UCS.00120001

-

400

-

CBC failed to update resources status

-

Failed to update the CBC resource status.

-

UCS.00130001

-

400

-

Get UCS Agency info error

-

Failed to obtain the UCS agency.

-

UCS.00140001

-

400

-

Create ClusterRole failed

-

Failed to create a ClusterRole.

-

UCS.00140002

-

400

-

Delete ClusterRole failed

-

Failed to delete a ClusterRole.

-

UCS.00140003

-

400

-

Update ClusterRole failed

-

Failed to update a ClusterRole.

-

UCS.00140004

-

400

-

Get ClusterRole failed

-

Failed to obtain the ClusterRole information.

-

UCS.00140005

-

400

-

Create ClusterRoleBinding failed

-

Failed to create a ClusterRoleBinding.

-

UCS.00140006

-

400

-

Delete ClusterRoleBinding failed

-

Failed to delete a ClusterRoleBinding.

-

UCS.00140007

-

400

-

Update ClusterRoleBinding failed

-

Failed to update a ClusterRoleBinding.

-

UCS.00140008

-

400

-

Get ClusterRoleBinding failed

-

Failed to obtain the ClusterRoleBinding information.

-

UCS.00140009

-

400

-

Create Role failed

-

Failed to create a role.

-

UCS.00140010

-

400

-

Delete Role failed

-

Failed to delete a role.

-

UCS.00140011

-

400

-

Update Role failed

-

Failed to update a role.

-

UCS.00140012

-

400

-

Get Role failed

-

Failed to obtain the role information.

-

UCS.00140013

-

400

-

Create RoleBinding failed

-

Failed to create a RoleBinding.

-

UCS.00140014

-

400

-

Delete RoleBinding failed

-

Failed to delete a RoleBinding.

-

UCS.00140015

-

400

-

Update RoleBinding failed

-

Failed to update a RoleBinding.

-

UCS.00140016

-

400

-

Get RoleBinding failed

-

Failed to obtain the RoleBinding information.

-

UCS.00150001

-

400

-

Cluster policy validate failed.

-

Cluster policy verification failed.

-

UCS.00150002

-

400

-

ClusterGroup policy validate failed.

-

Cluster group policy verification failed.

-

UCS.00150003

-

400

-

Cluster has enable policy.

-

The policy has been enabled for the cluster.

-

UCS.00150004

-

400

-

ClusterGroup has enable policy.

-

The policy has been enabled for the cluster group.

-

UCS.00150005

-

400

-

Cluster not enable policy.

-

The policy is not enabled for the cluster.

-

UCS.00150006

-

400

-

ClusterGroup not enable policy.

-

The policy is not enabled for the cluster group.

-

UCS.00150007

-

500

-

Get policy job failed.

-

Failed to obtain the policy task.

-

UCS.01000001

-

400

-

Failed to obtain the user information.

-

Failed to obtain the user information.

-

UCS.01000002

-

429

-

The throttling threshold has been reached.

-

Throttling threshold reached.

-

UCS.01000003

-

401

-

Authorization failed.

-

Authorization failed.

-

UCS.01000004

-

403

-

Request forbidden.

-

Forbidden request.

-

UCS.01000005

-

500

-

Database operation failed.

-

Failed to operate the database.

-

UCS.01000006

-

500

-

Server internal error.

-

Internal server error.

-

UCS.01000007

-

500

-

Data transform error.

-

Data conversion failed.

-

UCS.01000008

-

500

-

Error add event.

-

Failed to add the event.

-

UCS.01000009

-

500

-

Data unmarshal error.

-

Failed to deserialize data.

-

UCS.01000010

-

500

-

Data marshal error.

-

Failed to serialize data.

-

UCS.01000011

-

400

-

Bad query parameter value.

-

Invalid request parameter.

-

UCS.01000012

-

400

-

Invalid request body.

-

Invalid request body.

-

UCS.01000013

-

404

-

No requested resources found.

-

The requested resource cannot be found.

-

UCS.01000014

-

500

-

Failed to encrypt data.

-

Data encryption failed.

-

UCS.01000015

-

500

-

Failed to decrypt data.

-

Data decryption failed.

-

UCS.01000016

-

400

-

Invalid header value.

-

Invalid request header.

-

UCS.01000017

-

400

-

Insufficient quota

-

Insufficient quota.

-

UCS.01000018

-

400

-

Quota info validate failed

-

Quota parameter verification failed.

-

UCS.01000019

-

500

-

Quota update failed

-

Quota update failed.

-

UCS.01010001

-

500

-

Failed to get iam connection.

-

IAM connection failed.

-

UCS.01010002

-

500

-

Failed to get project token by agency

-

Failed to obtain the project token through the agency.

-

UCS.01010003

-

403

-

No access permission. Please contact the administrator.

-

No permissions.

-

UCS.01010004

-

400

-

get deployment region's projectID error

-

Failed to obtain the project ID.

-

UCS.01010005

-

400

-

get IAM agency's token error

-

Failed to obtain the agency token.

-

UCS.01010006

-

400

-

fail to get iam pdp authorize result

-

Failed to obtain the PDP authentication result.

-

UCS.01010007

-

403

-

iam pdp authentication denied

-

PDP authentication rejected.

-

UCS.01010008

-

403

-

iam rbac authentication denied

-

RBAC authentication rejected.

-

UCS.01020001

-

500

-

Failed to get aeskey.

-

Failed to obtain the aeskey.

-

UCS.01020002

-

500

-

Failed to get certs.

-

Failed to obtain the certificate.

-

UCS.01020003

-

500

-

Failed to create certs.

-

Failed to create the certificate.

-

UCS.01020004

-

500

-

Failed to delete certs.

-

Failed to delete the certificate.

-

UCS.01030001

-

404

-

Cluster Not Found.

-

No clusters found.

-

UCS.01030002

-

400

-

Failed to obtain the cluster information.

-

Failed to obtain the cluster information.

-

UCS.01030003

-

409

-

The same cluster already exists.

-

The cluster name already exists.

-

UCS.01030004

-

400

-

Cluster status is unavailable, please fix cluster first.

-

The cluster is unavailable.

-

UCS.01030005

-

403

-

No authorization for cluster

-

Failed to authorize the cluster.

-

UCS.01030006

-

400

-

Create resource job for cluster error

-

Failed to create a resource job in the cluster.

-

UCS.01030007

-

400

-

Create on-demand order for cluster error

-

Failed to create the pay-per-use order.

-

UCS.01030008

-

400

-

Cluster kubeconfig format error.

-

Incorrect kubeconfig format of the cluster.

-

UCS.01030009

-

400

-

This cluster does not support unregister

-

The cluster does not support unregistration.

-

UCS.01030010

-

400

-

Failed to obtain cce cluster information.

-

Failed to obtain the CCE cluster information.

-

UCS.01030011

-

400

-

Cluster category not supported

-

The cluster type is not supported.

-

UCS.01030012

-

400

-

Register cce cluster error

-

Failed to register the CCE cluster.

-

UCS.01030013

-

400

-

Register attached cluster error

-

Failed to register the attached cluster.

-

UCS.01030014

-

400

-

Register on-premise cluster error

-

Failed to register the on-premises cluster.

-

UCS.01030015

-

100

-

Register multi cloud cluster error

-

Failed to register the multi-cloud cluster.

-

UCS.01030016

-

400

-

Cluster has been frozen

-

The cluster has been frozen.

-

UCS.01050001

-

400

-

RecordSet create failed.

-

Failed to create the record set.

-

UCS.01080001

-

400

-

Failed to obtain the federation information.

-

Failed to obtain the federation information.

-

UCS.01080002

-

400

-

Cluster group has federalized.

-

Federation has been enabled for the fleet.

-

UCS.01080003

-

500

-

Cluster group federation failed.

-

Federation operation failed.

-

UCS.01080004

-

400

-

Cluster group federation validate failed.

-

Failed to enable federation verification.

-

UCS.01080005

-

400

-

Retry join all clusters to federation failed.

-

Failed to federate all clusters again.

-

UCS.01080006

-

400

-

Cluster group has not been federalized.

-

Federation is not enabled for the fleet.

-

UCS.01080007

-

400

-

Retry join cluster to federation failed.

-

Failed to add the cluster to the federation again.

-

UCS.01090001

-

400

-

Failed to obtain the mesh information.

-

Failed to obtain the mesh information.

-

UCS.01100001

-

403

-

No authorization for cluster group

-

The fleet is not authorized.

-

UCS.01100002

-

400

-

associate cluster with clustergroup error

-

Failed to add the cluster to the fleet.

-

UCS.01100003

-

400

-

associate cluster with rule error

-

Failed to associate the permission policy with the fleet.

-

UCS.01100004

-

409

-

The same clustergroup already exists.

-

The fleet name already exists.

-

UCS.01100005

-

404

-

ClusterGroup Not Found.

-

The fleet does not exist.

-

UCS.01100006

-

400

-

Cluster number in fleet exceed limit.

-

Too many clusters in the fleet.

-

UCS.01100007

-

400

-

Update associated clusters validate failed

-

Failed to verify the update of the associated cluster.

-

UCS.01110001

-

400

-

resource notification to SMN error

-

Failed to send notifications to SMN.

-

UCS.01120001

-

400

-

Create ClusterRole failed

-

Failed to create a ClusterRole.

-

UCS.01120002

-

400

-

Delete ClusterRole failed

-

Failed to delete a ClusterRole.

-

UCS.01120003

-

400

-

Update ClusterRole failed

-

Failed to update a ClusterRole.

-

UCS.01120004

-

400

-

Get ClusterRole failed

-

Failed to obtain the ClusterRole information.

-

UCS.01120005

-

400

-

Create ClusterRoleBinding failed

-

Failed to create a ClusterRoleBinding.

-

UCS.01120006

-

400

-

Delete ClusterRoleBinding failed

-

Failed to delete a ClusterRoleBinding.

-

UCS.01120007

-

400

-

Update ClusterRoleBinding failed

-

Failed to update a ClusterRoleBinding.

-

UCS.01120008

-

400

-

Get ClusterRoleBinding failed

-

Failed to obtain the ClusterRoleBinding information.

-

UCS.01120009

-

400

-

Create Role failed

-

Failed to create a role.

-

UCS.01120010

-

400

-

Delete Role failed

-

Failed to delete a role.

-

UCS.01120011

-

400

-

Update Role failed

-

Failed to update a role.

-

UCS.01120012

-

400

-

Get Role failed

-

Failed to obtain the role information.

-

UCS.01120013

-

400

-

Create RoleBinding failed

-

Failed to create a RoleBinding.

-

UCS.01120014

-

400

-

Delete RoleBinding failed

-

Failed to delete a RoleBinding.

-

UCS.01120015

-

400

-

Update RoleBinding failed

-

Failed to update a RoleBinding.

-

UCS.01120016

-

400

-

Get RoleBinding failed

-

Failed to obtain the RoleBinding information.

-

UCS.01130001

-

400

-

policy management create reconcile job failed

-

Failed to create a coordination job in policy management.

-

UCS.01130002

-

400

-

policy management create disable job failed

-

Failed to create a disabling job in policy management.

-

UCS.01130003

-

400

-

cluster policy validate failed.

-

Cluster policy verification failed.

-

UCS.01130004

-

400

-

clusterGroup policy validate failed.

-

Cluster group policy verification failed.

-

UCS.01130005

-

400

-

cluster policy management is in installing or closing status

-

Cluster policy management is being installed or has been disabled.

-

UCS.01130006

-

400

-

cluster group policy management is in installing or closing status

-

Cluster group policy management is being installed or has been disabled.

-
-
-
-
-
-
Parent topic: Appendix
-
-
- diff --git a/docs/ucs/api-ref/JoinGroup.html b/docs/ucs/api-ref/JoinGroup.html deleted file mode 100644 index 922f86769..000000000 --- a/docs/ucs/api-ref/JoinGroup.html +++ /dev/null @@ -1,137 +0,0 @@ - - -

Adding a Cluster to a Fleet

-

Function

This API is used to add a cluster to a fleet.

-
-

URI

POST /v1/clusters/{clusterid}/join

- -
- - - - - - - - - - - -
Table 1 Path parameter

Parameter

-

Mandatory

-

Type

-

Description

-

clusterid

-

Yes

-

String

-

Cluster ID

-
-
-
-

Request Parameters

-
- - - - - - - - - - - - - - - - -
Table 2 Parameters in the request header

Parameter

-

Mandatory

-

Type

-

Description

-

X-Auth-Token

-

Yes

-

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.

-

Content-Type

-

Yes

-

String

-

Message body type (format). Only application/json is supported.

-
-
- -
- - - - - - - - - - - -
Table 3 Parameter in the request body

Parameter

-

Mandatory

-

Type

-

Description

-

clusterGroupID

-

No

-

String

-

ID of the fleet that the cluster will be added to

-
-
-
-

Response Parameters

None

-
-

Example Requests

Adding a cluster to a fleet

-
{
-  "clustergroupID" : "49077339-f1cd-11ec-a2be-0255ac1001c2"
-}
-
-

Example Responses

Status code: 200

-

The cluster has been added to the fleet.

-
{ }
-
-

Status Codes

-
- - - - - - - - - - - - - - - - -

Status Code

-

Description

-

200

-

The cluster has been added to the fleet.

-

400

-

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

-

403

-

The server refused the request.

-

500

-

Internal server error.

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: Fleets
-
-
- diff --git a/docs/ucs/api-ref/LeaveGroup.html b/docs/ucs/api-ref/LeaveGroup.html deleted file mode 100644 index c096f1a4f..000000000 --- a/docs/ucs/api-ref/LeaveGroup.html +++ /dev/null @@ -1,114 +0,0 @@ - - -

Removing a Cluster from a Fleet

-

Function

This API is used to remove a cluster from a fleet.

-
-

URI

POST /v1/clusters/{clusterid}/unjoin

- -
- - - - - - - - - - - -
Table 1 Path parameter

Parameter

-

Mandatory

-

Type

-

Description

-

clusterid

-

Yes

-

String

-

Cluster ID

-
-
-
-

Request Parameters

-
- - - - - - - - - - - - - - - - -
Table 2 Parameters in the request header

Parameter

-

Mandatory

-

Type

-

Description

-

X-Auth-Token

-

Yes

-

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.

-

Content-Type

-

Yes

-

String

-

Message body type (format). Only application/json is supported.

-
-
-
-

Response Parameters

None

-
-

Example Requests

None

-
-

Example Responses

None

-
-

Status Codes

-
- - - - - - - - - - - - - - - - - - - -

Status Code

-

Description

-

200

-

The cluster has been removed from the fleet.

-

400

-

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

-

403

-

The server refused the request.

-

404

-

Resources not found.

-

500

-

Internal server error.

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: Fleets
-
-
- diff --git a/docs/ucs/api-ref/ListClusterGroup.html b/docs/ucs/api-ref/ListClusterGroup.html deleted file mode 100644 index 0e2f77804..000000000 --- a/docs/ucs/api-ref/ListClusterGroup.html +++ /dev/null @@ -1,427 +0,0 @@ - - -

Obtaining the Fleet List

-

Function

This API is used to obtain the fleet list.

-
-

URI

GET /v1/clustergroups

- -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
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.

-

order

-

No

-

String

-

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

-
-
-
-

Request Parameter

-
- - - - - - - - - - - -
Table 2 Parameter in the request header

Parameter

-

Mandatory

-

Type

-

Description

-

X-Auth-Token

-

Yes

-

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 Parameters in the response body

Parameter

-

Type

-

Description

-

items

-

Array of ClusterGroup objects

-

Fleet list

-

total

-

Integer

-

Total number of records on all pages

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - -
Table 4 ClusterGroup

Parameter

-

Type

-

Description

-

kind

-

String

-

API type. The value is fixed at ClusterGroup 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 fleet. Metadata is a collection of attributes.

-

spec

-

ClusterGroupSpec object

-

Details about the fleet. UCS creates or updates the fleet based on spec.

-

status

-

ClusterGroupStatus object

-

Fleet status

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - -
Table 5 ObjectMeta

Parameter

-

Type

-

Description

-

uid

-

String

-

Cluster ID

-

name

-

String

-

Cluster name

-

labels

-

Map<String,String>

-

Labels

-

creationTimestamp

-

String

-

Creation time. It is the UTC time in the RFC 3339 format.

-

updateTimestamp

-

String

-

Update timestamp

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 6 ClusterGroupSpec

Parameter

-

Type

-

Description

-

ruleNamespaces

-

Array of strings

-

List of namespaces associated with a permission policy

-

federationId

-

String

-

ID of the federation enabled for the fleet

-

description

-

String

-

Description

-

dnsSuffix

-

Array of strings

-

DNS suffix of the federation corresponding to the fleet. This parameter is visible after federation is enabled.

-

federationExpirationTimestamp

-

String

-

Federation expiration timestamp

-

policyId

-

String

-

Policy management ID

-

federationVersion

-

String

-

Version of the federation enabled for the fleet

-
-
- -
- - - - - - - - - -
Table 7 ClusterGroupStatus

Parameter

-

Type

-

Description

-

conditions

-

Array of ClusterGroupCondition objects

-

Federation or permission policy information for the fleet

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - -
Table 8 ClusterGroupCondition

Parameter

-

Type

-

Description

-

type

-

String

-

Type. Options:

-

  • Federation: Federation is enabled for the fleet.

    -

  • Policy: The permission policy is enabled for the fleet.

    -
-

status

-

String

-

Status of the federation or permission policy enabled for a fleet

-

reason

-

String

-

Cause of a status

-

message

-

String

-

Status information

-

lastTransitionTime

-

String

-

Status update time

-
-
-
-

Example Requests

None

-
-

Example Responses

Status code: 200

-

The fleet list has been obtained.

-
{
-  "items" : [ {
-    "kind" : "ClusterGroup",
-    "apiVersion" : "v1",
-    "metadata" : {
-      "name" : "cluster-test",
-      "uid" : "bffbb35b-7949-11ee-886c-0255ac100037",
-      "creationTimestamp" : "2023-11-02 06:33:35.558128 +0000 UTC",
-      "updateTimestamp" : "2023-11-14 06:20:20.446476 +0000 UTC"
-    },
-    "spec" : {
-      "federationId" : "e2f27cc6-82b5-11ee-84e3-0255ac100032",
-      "federationVersion" : "v1.7.0-t1109",
-      "dnsSuffix" : [ "www.oidc.com" ]
-    },
-    "status" : {
-      "conditions" : [ {
-        "type" : "Federation",
-        "status" : "Unavailable",
-        "reason" : "FederationUnavailable",
-        "message" : "component volcano-scheduler is unhealthy",
-        "lastTransitionTime" : "0001-01-01T00:00:00Z"
-      } ]
-    }
-  }, {
-    "kind" : "ClusterGroup",
-    "apiVersion" : "v1",
-    "metadata" : {
-      "name" : "cluster-dev",
-      "uid" : "4557ad49-22bf-11ee-b0c9-0255ac10004b",
-      "creationTimestamp" : "2023-07-15 03:25:39.253589 +0000 UTC",
-      "updateTimestamp" : "2023-10-19 11:52:14.509405 +0000 UTC"
-    },
-    "spec" : { },
-    "status" : { }
-  }, {
-    "kind" : "ClusterGroup",
-    "apiVersion" : "v1",
-    "metadata" : {
-      "name" : "test0131",
-      "uid" : "108f5981-a105-11ed-a23e-0255ac100032",
-      "creationTimestamp" : "2023-01-31 01:17:44.309185 +0000 UTC",
-      "updateTimestamp" : "2023-06-29 01:02:28.78095 +0000 UTC"
-    },
-    "spec" : { },
-    "status" : { }
-  } ],
-  "total" : 3
-}
-
-

Status Codes

-
- - - - - - - - - - - - - - - - -

Status Code

-

Description

-

200

-

The fleet list has been obtained.

-

400

-

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

-

403

-

The server refused the request.

-

500

-

Internal server error.

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: Fleets
-
-
- diff --git a/docs/ucs/api-ref/ListManagedClusters.html b/docs/ucs/api-ref/ListManagedClusters.html deleted file mode 100644 index 3f339b623..000000000 --- a/docs/ucs/api-ref/ListManagedClusters.html +++ /dev/null @@ -1,977 +0,0 @@ - - -

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

- -
- - - - - - - - - - - -
Table 1 Query parameter

Parameter

-

Mandatory

-

Type

-

Description

-

unimported

-

No

-

Boolean

-

Whether to register a cluster with UCS

-
-
-
-

Request Parameters

-
- - - - - - - - - - - -
Table 2 Parameter in the request header

Parameter

-

Mandatory

-

Type

-

Description

-

X-Auth-Token

-

Yes

-

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 Parameter in the response body

Parameter

-

Type

-

Description

-

[Array]

-

Array of Cluster objects

-

CCE clusters that are not registered with UCS are returned.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - -
Table 4 Cluster

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

-

Detailed description of the cluster. UCS creates or updates the cluster based on spec.

-

status

-

ClusterStatus object

-

Cluster status

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 5 ObjectMeta

Parameter

-

Type

-

Description

-

uid

-

String

-

Resource ID

-

name

-

String

-

Resource name

-

generateName

-

String

-

If no name is provided, the server uses the prefix to generate a unique name.

-

namespace

-

String

-

Namespace

-

labels

-

Map<String,String>

-

Labels

-

annotations

-

Map<String,String>

-

Annotations

-

creationTimestamp

-

String

-

Creation time

-

updateTimestamp

-

String

-

Update time

-

resourceVersion

-

String

-

Internal version of a resource

-

generation

-

String

-

Generation of the desired resource state

-

managedFields

-

Array of ManagedFieldsEntry objects

-

Fields managed by workflows

-

ownerReferences

-

Array of OwnerReference objects

-

Ownership, dependencies, and garbage collection mechanism of objects. It supports resource management by the controller.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 6 ManagedFieldsEntry

Parameter

-

Type

-

Description

-

manager

-

String

-

Manager name

-

operation

-

String

-

Operation type that causes this entry to be 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 OwnerReference

Parameter

-

Type

-

Description

-

apiVersion

-

String

-

API version of the referent

-

kind

-

String

-

Type of the referent

-

name

-

String

-

Name of the referent

-

uid

-

String

-

UID of the referent

-

controller

-

Boolean

-

If the value is true, this reference points to the controller that manages the resource.

-

blockOwnerDeletion

-

Boolean

-

If the value is true and the owner has a finalizer named foregroundDeletion, the owner cannot be deleted until this reference is removed.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 8 ClusterSpec

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:

-
  • grouped: clusters added to a fleet
  • discrete: clusters not in any fleet
-

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 (consistent with the country)

-

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

-
-
- -
- - - - - - - - - - - - - -
Table 9 RuleNamespace

Parameter

-

Type

-

Description

-

rules

-

Array of RuleInfo objects

-

Permission policy list

-

namespaces

-

Array of strings

-

Namespace list

-
-
- -
- - - - - - - - - - - - - -
Table 10 RuleInfo

Parameter

-

Type

-

Description

-

ruleID

-

String

-

Permission policy ID

-

ruleName

-

String

-

Permission policy name

-
-
- -
- - - - - - - - - - - - - -
Table 11 LocalSecretReference

Parameter

-

Type

-

Description

-

namespace

-

String

-

Namespace that the resource belongs to

-

name

-

String

-

Resource name

-
-
- -
- - - - - - - - - - - - - - - - - - - - - -
Table 12 Taint

Parameter

-

Type

-

Description

-

key

-

String

-

Key

-

value

-

String

-

Value

-

effect

-

String

-

Effect information

-

timeadded

-

String

-

Timestamp information

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 13 ClusterStatus

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

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 14 ConditionStatus

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

-
-
- -
- - - - - - - - - - - - - -
Table 15 NodeSummary

Parameter

-

Type

-

Description

-

totalNum

-

String

-

The number of all nodes in a cluster

-

readyNum

-

String

-

The number of ready nodes in a cluster

-
-
- -
- - - - - - - - - - - - - - - - - - - - - -
Table 16 ResourceSummary

Parameter

-

Type

-

Description

-

allocatable

-

map<string, object>

-

Allocatable resources

-

allocating

-

map<string, object>

-

Resources in allocation

-

allocated

-

map<string, object>

-

Allocated resources

-

capacity

-

map<string, object>

-

Total resources

-
-
- -
- - - - - - - - - - - - - - - - - -
Table 17 Endpoint

Parameter

-

Type

-

Description

-

url

-

String

-

URL

-

type

-

String

-

Port type

-

status

-

String

-

Port status

-
-
- -
- - - - - - - - - - - - - -
Table 18 APIEnablement

Parameter

-

Type

-

Description

-

groupVersion

-

String

-

Resource group and version

-

resources

-

Array of APIResource objects

-

Resource type and name

-
-
- -
- - - - - - - - - - - - - -
Table 19 APIResource

Parameter

-

Type

-

Description

-

name

-

String

-

Resource name

-

kind

-

String

-

Resource category

-
-
-
-

Example Requests

None

-
-

Example Responses

Status code: 200

-

CCE clusters that are not registered with UCS are 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://cloudmonitoralarm.cidc-rp-12.joint.cmecloud.cn",
-    "provider" : "cmccloud",
-    "type" : "cce",
-    "category" : "self",
-    "region" : "cidc-rp-12",
-    "country" : "CN",
-    "city" : "150900",
-    "projectID" : "b6315dd3d0ff4be5b31a963256794989",
-    "projectName" : "cidc-rp-12",
-    "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 are not registered with UCS are returned.

-

400

-

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

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: UCS Clusters
-
-
- diff --git a/docs/ucs/api-ref/ListRegisteredClusterVersions.html b/docs/ucs/api-ref/ListRegisteredClusterVersions.html deleted file mode 100644 index f5778c47a..000000000 --- a/docs/ucs/api-ref/ListRegisteredClusterVersions.html +++ /dev/null @@ -1,85 +0,0 @@ - - -

Querying the Version List of Clusters That Can Be Connected to UCS

-

Function

This API is used to query the version list of clusters that can be connected to UCS.

-
-

URI

GET /v1/config/registeredclusterversions

-
-

Request Parameter

-
- - - - - - - - - - - -
Table 1 Parameter in the request header

Parameter

-

Mandatory

-

Type

-

Description

-

X-Auth-Token

-

Yes

-

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 Parameter

Status code: 200

- -
- - - - - - - - - -
Table 2 Parameter in the response body

Parameter

-

Type

-

Description

-

versions

-

Array of strings

-

Cluster version list

-
-
-
-

Example Requests

None

-
-

Example Responses

Status code: 200

-

Version list of clusters that can be connected to UCS

-
{
-  "versions" : [ "v1.19", "v1.20", "v1.21", "v1.22", "v1.23", "v1.24", "v1.25" ]
-}
-
-

Status Codes

-
- - - - - - - -

Status Code

-

Description

-

200

-

Version list of clusters that can be connected to UCS

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: UCS Clusters
-
-
- diff --git a/docs/ucs/api-ref/ListRule.html b/docs/ucs/api-ref/ListRule.html deleted file mode 100644 index 7a1293647..000000000 --- a/docs/ucs/api-ref/ListRule.html +++ /dev/null @@ -1,325 +0,0 @@ - - -

Obtaining the Permission Policy List

-

Function

This API is used to obtain the permission policy list.

-
-

URI

GET /v1/permissions/rules

- -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
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.

-

order

-

No

-

String

-

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

-
-
-
-

Request Parameters

-
- - - - - - - - - - - -
Table 2 Parameters in the request header

Parameter

-

Mandatory

-

Type

-

Description

-

X-Auth-Token

-

Yes

-

String

-

Identity authentication information

-

Minimum length: 1

-

Maximum length: 16384

-
-
-
-

Response Parameters

Status code: 200

- -
- - - - - - - - - - - - - -
Table 3 Parameters in the response body

Parameter

-

Type

-

Description

-

items

-

Array of Rule objects

-

Permission policy list

-

total

-

Integer

-

Total number of records on all pages

-
-
- -
- - - - - - - - - - - - - - - - - - - - - -
Table 4 Rule

Parameter

-

Type

-

Description

-

kind

-

String

-

API type.

-

apiVersion

-

String

-

API version. The value is fixed at v1 and cannot be changed.

-

metadata

-

ObjectMeta object

-

Basic information.

-

spec

-

RuleSpec object

-

Details about the permission policy. UCS creates or updates the permission policy by spec.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - -
Table 5 ObjectMeta

Parameter

-

Type

-

Description

-

uid

-

String

-

Cluster ID

-

name

-

String

-

Cluster name

-

labels

-

Map<String,String>

-

Labels

-

creationTimestamp

-

String

-

Creation time. It is the UTC time in the RFC 3339 format.

-

updateTimestamp

-

String

-

Update timestamp

-
-
- -
- - - - - - - - - - - - - - - - - - - - - -
Table 6 RuleSpec

Parameter

-

Type

-

Description

-

iamuserids

-

Array of strings

-

Information of IAM users associated with a permission policy

-

type

-

String

-

Permission policy type. The value can be readonly, develop, admin, or custom.

-

contents

-

Array of Content objects

-

Permission policy content

-

description

-

String

-

Permission policy description

-

Minimum length: 0

-

Maximum length: 255

-
-
- -
- - - - - - - - - - - - - -
Table 7 Content

Parameter

-

Type

-

Description

-

verbs

-

Array of strings

-

Action list

-

resources

-

Array of strings

-

Resource list

-
-
-
-

Example Requests

None

-
-

Example Responses

Status code: 200

-

Permission policy list

-
{
-  "items" : [ {
-    "metadata" : {
-      "name" : "admin",
-      "uid" : "3dcdef78-65bb-11ee-bdf2-0255ac100033",
-      "creationTimestamp" : "2023-10-08 09:15:36.526016 +0000 UTC",
-      "updateTimestamp" : "2023-10-08 09:15:36.526016 +0000 UTC"
-    },
-    "spec" : {
-      "iamUserIDs" : [ "873395a21c8d4d8ba9e37d6d32debc41" ],
-      "type" : "admin",
-      "contents" : [ {
-        "verbs" : [ "*" ],
-        "resources" : [ "*" ]
-      } ]
-    }
-  } ],
-  "total" : 1
-}
-
-

Status Codes

-
- - - - - - - - - - - - - -

Status Code

-

Description

-

200

-

Permission policy list

-

400

-

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

-

500

-

Internal server error.

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: Permissions
-
-
- diff --git a/docs/ucs/api-ref/PARAMETERS.txt b/docs/ucs/api-ref/PARAMETERS.txt deleted file mode 100644 index 6da8d5f07..000000000 --- a/docs/ucs/api-ref/PARAMETERS.txt +++ /dev/null @@ -1,3 +0,0 @@ -version="" -language="en-us" -type="" \ No newline at end of file diff --git a/docs/ucs/api-ref/RegisterCluster.html b/docs/ucs/api-ref/RegisterCluster.html deleted file mode 100644 index 1f9521126..000000000 --- a/docs/ucs/api-ref/RegisterCluster.html +++ /dev/null @@ -1,373 +0,0 @@ - - -

Registering a Cluster

-

Function

This API is used to register a cluster. Third-party clusters and CCE clusters can be registered.

-
-

URI

POST /v1/clusters

-
-

Request Parameters

-
- - - - - - - - - - - - - - - - -
Table 1 Parameters in the request header

Parameter

-

Mandatory

-

Type

-

Description

-

X-Auth-Token

-

Yes

-

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.

-

Content-Type

-

Yes

-

String

-

Message body type (format). Only application/json is supported.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 2 Parameters in the request body

Parameter

-

Mandatory

-

Type

-

Description

-

kind

-

No

-

String

-

Resource type. For a registered cluster, set this parameter to Cluster.

-

This parameter is optional for a CCE cluster and mandatory for an attached cluster.

-

apiVersion

-

No

-

String

-

API version. The current version is v1.

-

This parameter is optional for a CCE cluster and mandatory for an attached cluster.

-

metadata

-

Yes

-

metadata object

-

Cluster metadata information

-

spec

-

Yes

-

spec object

-

Cluster specifications

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 3 metadata

Parameter

-

Mandatory

-

Type

-

Description

-

uid

-

No

-

String

-

Cluster ID. This parameter is used only when a CCE cluster is imported for registration. For other types of clusters, you do not need to set this parameter.

-

name

-

No

-

String

-

CCE cluster name or a custom cluster name (for other types of clusters).

-

labels

-

No

-

Map<String,String>

-

Label information. This parameter can be left blank. If this parameter is not left blank, the value must comply with the Kubernetes label specifications. A maximum of 100 labels are supported.

-

annotations

-

No

-

Map<String,String>

-

Cluster annotations. The kubeconfig field is mandatory for an attached cluster, and its value is the content of the kubeconfig file.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 4 spec

Parameter

-

Mandatory

-

Type

-

Description

-

clusterGroupID

-

No

-

String

-

Fleet ID.

-

category

-

Yes

-

String

-

Cluster category. The value must meet the requirements for provider and type. For details, see Cluster Categories and Types.

-

type

-

Yes

-

String

-

Cluster type. The value must meet the requirements for provider and category. For details, see Cluster Categories and Types.

-

provider

-

No

-

String

-

Provider. The value must meet the requirements for category and type. For details, see Cluster Categories and Types.

-

country

-

No

-

String

-

Country code

-

This parameter is optional for a CCE cluster and mandatory for an attached cluster.

-

city

-

No

-

String

-

City code (consistent with the country)

-

This parameter is optional for a CCE cluster and mandatory for an attached cluster.

-

region

-

No

-

String

-

Region information. This parameter is used only when a CCE cluster is imported for registration. You can obtain the value from the region field in the API for querying CCE clusters that have not been registered with UCS.

-

projectID

-

No

-

String

-

Project ID. This parameter is used only when a CCE cluster is imported for registration. You can obtain the value from the projectID field in the API for querying CCE clusters that have not been registered with UCS.

-

manageType

-

Yes

-

String

-

Cluster management type. Options:

-
  • grouped: clusters added to a fleet
  • discrete: clusters not in any fleet
-

network

-

No

-

NetworkConfig object

-

Network configuration of a multi-cloud cluster. You do not need to set this parameter for other types of clusters.

-
-
- -
- - - - - - - - - - - - - - - - -
Table 5 NetworkConfig

Parameter

-

Mandatory

-

Type

-

Description

-

podCIDR

-

No

-

String

-

Container CIDR block

-

serviceCIDR

-

No

-

String

-

Service CIDR block

-
-
-
-

Response Parameters

Status code: 201

- -
- - - - - - - - - -
Table 6 Parameter in the response body

Parameter

-

Type

-

Description

-

uid

-

String

-

Cluster ID

-
-
-
-

Example Requests

-
-

Example Responses

Status code: 201

-

The cluster has been registered, and the ID of the registered cluster is returned.

-
{
-  "uid" : "b0d1ecb5-7947-11ee-9467-0255ac1001bf"
-}
-
-

Status Codes

-
- - - - - - - - - - - - - - - - - - - - - - -

Status Code

-

Description

-

201

-

The cluster has been registered, and the ID of the registered cluster is returned.

-

400

-

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

-

403

-

The server refused the request.

-

404

-

Resources not found.

-

409

-

There was a request conflict.

-

500

-

Internal server error.

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: UCS Clusters
-
-
- diff --git a/docs/ucs/api-ref/RegisterClusterGroup.html b/docs/ucs/api-ref/RegisterClusterGroup.html deleted file mode 100644 index c212d063f..000000000 --- a/docs/ucs/api-ref/RegisterClusterGroup.html +++ /dev/null @@ -1,205 +0,0 @@ - - -

Creating a Fleet

-

Function

This API is used to create a fleet. You can select clusters during fleet creation.

-
-

URI

POST /v1/clustergroups

-
-

Request Parameters

-
- - - - - - - - - - - - - - - - -
Table 1 Parameters in the request header

Parameter

-

Mandatory

-

Type

-

Description

-

X-Auth-Token

-

Yes

-

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.

-

Content-Type

-

Yes

-

String

-

Message body type (format). Only application/json is supported.

-
-
- -
- - - - - - - - - - - - - - - - -
Table 2 Parameters in the request body

Parameter

-

Mandatory

-

Type

-

Description

-

metadata

-

Yes

-

RegisterClusterGroupObjectMeta object

-

Fleet metadata information

-

spec

-

No

-

RegisterClusterGroupSpec object

-

Attributes

-
-
- -
- - - - - - - - - - - -
Table 3 RegisterClusterGroupObjectMeta

Parameter

-

Mandatory

-

Type

-

Description

-

name

-

Yes

-

String

-

Fleet name

-
-
- -
- - - - - - - - - - - - - - - - -
Table 4 RegisterClusterGroupSpec

Parameter

-

Mandatory

-

Type

-

Description

-

clusterIds

-

No

-

Array of strings

-

IDs of associated clusters

-

description

-

No

-

String

-

Fleet description

-
-
-
-

Response Parameters

Status code: 201

- -
- - - - - - - - - -
Table 5 Parameter in the response body

Parameter

-

Type

-

Description

-

uid

-

String

-

Fleet UID

-
-
-
-

Example Requests

Creating a fleet and (optional) adding clusters to the fleet

-
{
-  "metadata" : {
-    "name" : "group02281605"
-  },
-  "spec" : {
-    "clusterIds" : [ "514c1a3c-8ec7-11ec-b384-0255ac100189", "d4804da3-8f03-11ec-b384-0255ac100189" ],
-    "description" : "aaaaaaaaa"
-  }
-}
-
-

Example Responses

Status code: 201

-

The UID of the fleet that has been created is returned.

-
{
-  "uid" : "6efb4a18-2fa4-11ee-ad1d-0255ac1001c4"
-}
-
-

Status Codes

-
- - - - - - - - - - - - - - - - -

Status Code

-

Description

-

201

-

The UID of the fleet that has been created is returned.

-

400

-

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

-

403

-

The server refused the request.

-

500

-

Internal server error.

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: Fleets
-
-
- diff --git a/docs/ucs/api-ref/RetryClusterActivation.html b/docs/ucs/api-ref/RetryClusterActivation.html deleted file mode 100644 index 205f123ac..000000000 --- a/docs/ucs/api-ref/RetryClusterActivation.html +++ /dev/null @@ -1,104 +0,0 @@ - - -

Activating a Cluster

-

Function

This API is used to activate a cluster. The cluster ID must comply with the Kubernetes UUID format rules, and you must have the required permission on the corresponding cluster. Otherwise, the authentication fails.

-
-

URI

PUT /v1/clusters/{clusterid}/activation

- -
- - - - - - - - - - - -
Table 1 Path parameter

Parameter

-

Mandatory

-

Type

-

Description

-

clusterid

-

Yes

-

String

-

Cluster ID

-
-
-
-

Request Parameters

-
- - - - - - - - - - - - - - - - -
Table 2 Parameters in the request header

Parameter

-

Mandatory

-

Type

-

Description

-

X-Auth-Token

-

Yes

-

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.

-

Content-Type

-

Yes

-

String

-

Message body type (format). Only application/json is supported.

-
-
-
-

Response Parameters

None

-
-

Example Requests

None

-
-

Example Responses

None

-
-

Status Codes

-
- - - - - - - - - - - - - -

Status Code

-

Description

-

200

-

The cluster has been activated for reconnection.

-

400

-

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

-

500

-

Internal server error.

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: UCS Clusters
-
-
- diff --git a/docs/ucs/api-ref/ShowCluster.html b/docs/ucs/api-ref/ShowCluster.html deleted file mode 100644 index 6ca98cda3..000000000 --- a/docs/ucs/api-ref/ShowCluster.html +++ /dev/null @@ -1,984 +0,0 @@ - - -

Obtaining a Cluster

-

Function

This API is used to obtain a cluster. The cluster ID must comply with the Kubernetes UUID format rules, and you must have the required permissions on the cluster. Otherwise, the authentication fails.

-
-

URI

GET /v1/clusters/{clusterid}

- -
- - - - - - - - - - - -
Table 1 Path parameter

Parameter

-

Mandatory

-

Type

-

Description

-

clusterid

-

Yes

-

String

-

Cluster ID

-
-
-
-

Request Parameters

-
- - - - - - - - - - - -
Table 2 Parameter in the request header

Parameter

-

Mandatory

-

Type

-

Description

-

X-Auth-Token

-

Yes

-

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 Parameters in the response body

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

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 4 ObjectMeta

Parameter

-

Type

-

Description

-

uid

-

String

-

Resource ID

-

name

-

String

-

Resource name

-

generateName

-

String

-

If no name is provided, the server uses the prefix to generate a unique name.

-

namespace

-

String

-

Namespace

-

labels

-

Map<String,String>

-

Labels

-

annotations

-

Map<String,String>

-

Annotations

-

creationTimestamp

-

String

-

Creation time

-

updateTimestamp

-

String

-

Update time

-

resourceVersion

-

String

-

Internal version of a resource

-

generation

-

String

-

Generation of the desired resource state

-

managedFields

-

Array of ManagedFieldsEntry objects

-

Fields managed by workflows

-

ownerReferences

-

Array of OwnerReference objects

-

Ownership, dependencies, and garbage collection mechanism of objects. It supports resource management by the controller.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 5 ManagedFieldsEntry

Parameter

-

Type

-

Description

-

manager

-

String

-

Manager name

-

operation

-

String

-

Operation type that causes this entry to be 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 6 OwnerReference

Parameter

-

Type

-

Description

-

apiVersion

-

String

-

API version of the referent

-

kind

-

String

-

Type of the referent

-

name

-

String

-

Name of the referent

-

uid

-

String

-

UID of the referent

-

controller

-

Boolean

-

If the value is true, this reference points to the controller that manages the resource.

-

blockOwnerDeletion

-

Boolean

-

If the value is true and the owner has a finalizer named foregroundDeletion, the owner cannot be deleted until this reference is removed.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 7 ClusterSpec

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:

-
  • grouped: clusters added to a fleet
  • discrete: clusters not in any fleet
-

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 (consistent with the country)

-

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

-
-
- -
- - - - - - - - - - - - - -
Table 8 RuleNamespace

Parameter

-

Type

-

Description

-

rules

-

Array of RuleInfo objects

-

Permission policy list

-

namespaces

-

Array of strings

-

Namespace list

-
-
- -
- - - - - - - - - - - - - -
Table 9 RuleInfo

Parameter

-

Type

-

Description

-

ruleID

-

String

-

Permission policy ID

-

ruleName

-

String

-

Permission policy name

-
-
- -
- - - - - - - - - - - - - -
Table 10 LocalSecretReference

Parameter

-

Type

-

Description

-

namespace

-

String

-

Namespace that the resource belongs to

-

name

-

String

-

Resource name

-
-
- -
- - - - - - - - - - - - - - - - - - - - - -
Table 11 Taint

Parameter

-

Type

-

Description

-

key

-

String

-

Key

-

value

-

String

-

Value

-

effect

-

String

-

Effect information

-

timeadded

-

String

-

Timestamp information

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 12 ClusterStatus

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

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 13 ConditionStatus

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

-
-
- -
- - - - - - - - - - - - - -
Table 14 NodeSummary

Parameter

-

Type

-

Description

-

totalNum

-

String

-

The number of all nodes in a cluster

-

readyNum

-

String

-

The number of ready nodes in a cluster

-
-
- -
- - - - - - - - - - - - - - - - - - - - - -
Table 15 ResourceSummary

Parameter

-

Type

-

Description

-

allocatable

-

map<string, object>

-

Allocatable resources

-

allocating

-

map<string, object>

-

Resources in allocation

-

allocated

-

map<string, object>

-

Allocated resources

-

capacity

-

map<string, object>

-

Total resources

-
-
- -
- - - - - - - - - - - - - - - - - -
Table 16 Endpoint

Parameter

-

Type

-

Description

-

internal

-

String

-

Internal network address.

-

external

-

String

-

External network address.

-

external_otc

-

String

-

Endpoint of the cluster to be accessed through API Gateway.

-
-
- -
- - - - - - - - - - - - - -
Table 17 APIEnablement

Parameter

-

Type

-

Description

-

groupVersion

-

String

-

Resource group and version

-

resources

-

Array of APIResource objects

-

Resource type and name

-
-
- -
- - - - - - - - - - - - - -
Table 18 APIResource

Parameter

-

Type

-

Description

-

name

-

String

-

Resource name

-

kind

-

String

-

Resource category

-
-
-
-

Example Requests

None

-
-

Example Responses

Status code: 200

-

Cluster information, such as its status and synchronization mode between the cluster and Karmada control plane

-
{
-  "kind" : "Cluster",
-  "apiVersion" : "v1",
-  "metadata" : {
-    "name" : "test-cluster",
-    "uid" : "b0d1ecb5-7947-11ee-9467-0255ac1001bf",
-    "creationTimestamp" : "2023-11-02T06:36:14Z",
-    "labels" : {
-      "FeatureGates" : "elbv3,SupportClientCertificateRevocation,xGPU"
-    },
-    "annotations" : {
-      "vpcId" : "11c9fe72-5a90-4295-bcfe-774726fb9066"
-    }
-  },
-  "spec" : {
-    "syncMode" : "",
-    "clusterGroupID" : "bffbb35b-7949-11ee-886c-0255ac100037",
-    "manageType" : "grouped",
-    "provider" : "cmccloud",
-    "type" : "cce",
-    "category" : "self",
-    "region" : "cidc-rp-12",
-    "country" : "CN",
-    "city" : "150900",
-    "projectID" : "b6315dd3d0ff4be5b31a963256794989",
-    "projectName" : "cidc-rp-12",
-    "IsDownloadedCert" : false,
-    "operatorNamespace" : "2cd7ebd02e4743eba4e6342c09e49344"
-  },
-  "status" : {
-    "kubernetesVersion" : "v1.25",
-    "conditions" : [ {
-      "type" : "Ready",
-      "status" : "True",
-      "lastTransitionTime" : "2023-11-27T11:05:09+08:00",
-      "reason" : "ClusterAvailable"
-    }, {
-      "type" : "Cluster",
-      "status" : "Available",
-      "lastTransitionTime" : "2023-11-27T11:05:09+08:00",
-      "reason" : "ClusterAvailable"
-    }, {
-      "type" : "Federation",
-      "status" : "Federalized",
-      "lastTransitionTime" : "2023-11-14T14:31:58.744215+08:00"
-    } ],
-    "endpoints" : [ {
-      "url" : "https://192.168.1.251:5443",
-      "type" : "Internal"
-    } ],
-    "phase" : "Available",
-    "arrearFreeze" : "false",
-    "policeFreeze" : "false"
-  }
-}
-
-

Status Codes

-
- - - - - - - - - - - - - - - - - - - -

Status Code

-

Description

-

200

-

Cluster information, such as its status and synchronization mode between the cluster and Karmada control plane

-

400

-

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

-

403

-

The server refused the request.

-

404

-

Resources not found.

-

500

-

Internal server error.

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: UCS Clusters
-
-
- diff --git a/docs/ucs/api-ref/ShowClusterAccessInfo.html b/docs/ucs/api-ref/ShowClusterAccessInfo.html deleted file mode 100644 index 441bffdfc..000000000 --- a/docs/ucs/api-ref/ShowClusterAccessInfo.html +++ /dev/null @@ -1,151 +0,0 @@ - - -

Obtaining Cluster Access Information

-

Function

This API is used to obtain the cluster access information. The cluster ID must comply with the Kubernetes UUID format rules, and you must have the permission to query the corresponding cluster. Otherwise, the authentication fails. The agent certificate can be downloaded only once. This API is only used to obtain the access information of third-party clusters. If a CCE cluster ID is transferred, 400 will be returned.

-
-

URI

GET /v1/clusters/{clusterid}/accessinfo

- -
- - - - - - - - - - - -
Table 1 Path parameter

Parameter

-

Mandatory

-

Type

-

Description

-

clusterid

-

Yes

-

String

-

Cluster ID

-
-
- -
- - - - - - - - - - - - - - - - -
Table 2 Query parameters

Parameter

-

Mandatory

-

Type

-

Description

-

vpcendpoint

-

No

-

String

-

IP address of the VPC endpoint. This parameter is mandatory for clusters accessed over the private network. The third-party network and the VPC network must be connected.

-

region

-

No

-

String

-

Access region. This parameter is mandatory for clusters accessed over the private network.

-
-
-
-

Request Parameters

-
- - - - - - - - - - - -
Table 3 Parameter in the request header

Parameter

-

Mandatory

-

Type

-

Description

-

X-Auth-Token

-

Yes

-

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 4 Parameter in the response body

Parameter

-

Type

-

Description

-

[Array]

-

Array of strings

-

The cluster access information is returned. If the API has been called, the message "Downloaded" is returned.

-
-
-
-

Example Requests

None

-
-

Example Responses

None

-
-

Status Codes

-
- - - - - - - - - - - - - - - - -

Status Code

-

Description

-

200

-

The cluster access information is returned. If the API has been called, the message "Downloaded" is returned.

-

400

-

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

-

403

-

The server refused the request.

-

500

-

Internal server error.

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: UCS Clusters
-
-
- diff --git a/docs/ucs/api-ref/ShowClusterGroup.html b/docs/ucs/api-ref/ShowClusterGroup.html deleted file mode 100644 index b7efcab24..000000000 --- a/docs/ucs/api-ref/ShowClusterGroup.html +++ /dev/null @@ -1,354 +0,0 @@ - - -

Obtaining a Fleet

-

Function

This API is used to obtain a fleet.

-
-

URI

GET /v1/clustergroups/{clustergroupid}

- -
- - - - - - - - - - - -
Table 1 Path parameter

Parameter

-

Mandatory

-

Type

-

Description

-

clustergroupid

-

Yes

-

String

-

Fleet ID

-
-
-
-

Request Parameter

-
- - - - - - - - - - - -
Table 2 Parameter in the request header

Parameter

-

Mandatory

-

Type

-

Description

-

X-Auth-Token

-

Yes

-

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 Parameters in the response body

Parameter

-

Type

-

Description

-

kind

-

String

-

API type. The value is fixed at ClusterGroup 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 fleet. Metadata is a collection of attributes.

-

spec

-

ClusterGroupSpec object

-

Details about the fleet. UCS creates or updates the fleet based on spec.

-

status

-

ClusterGroupStatus object

-

Fleet status

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - -
Table 4 ObjectMeta

Parameter

-

Type

-

Description

-

uid

-

String

-

Cluster ID

-

name

-

String

-

Cluster name

-

labels

-

Map<String,String>

-

Labels

-

creationTimestamp

-

String

-

Creation time. It is the UTC time in the RFC 3339 format.

-

updateTimestamp

-

String

-

Update timestamp

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 5 ClusterGroupSpec

Parameter

-

Type

-

Description

-

ruleNamespaces

-

Array of strings

-

List of namespaces associated with a permission policy

-

federationId

-

String

-

ID of the federation enabled for the fleet

-

description

-

String

-

Description

-

dnsSuffix

-

Array of strings

-

DNS suffix of the federation corresponding to the fleet. This parameter is visible after federation is enabled.

-

federationExpirationTimestamp

-

String

-

Federation expiration timestamp

-

policyId

-

String

-

Policy management ID

-

federationVersion

-

String

-

Version of the federation enabled for the fleet

-
-
- -
- - - - - - - - - -
Table 6 ClusterGroupStatus

Parameter

-

Type

-

Description

-

conditions

-

Array of ClusterGroupCondition objects

-

Federation or permission policy information for the fleet

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - -
Table 7 ClusterGroupCondition

Parameter

-

Type

-

Description

-

type

-

String

-

Type. Options:

-

  • Federation: Federation is enabled for the fleet.

    -

  • Policy: The permission policy is enabled for the fleet.

    -
-

status

-

String

-

Status of the federation or permission policy enabled for the fleet

-

reason

-

String

-

Cause of a status

-

message

-

String

-

Status information

-

lastTransitionTime

-

String

-

Status update time

-
-
-
-

Example Requests

None

-
-

Example Responses

Status code: 200

-

Fleet object

-
{
-  "kind" : "ClusterGroup",
-  "apiVersion" : "v1",
-  "metadata" : {
-    "name" : "cluster-test",
-    "uid" : "bffbb35b-7949-11ee-886c-0255ac100037",
-    "creationTimestamp" : "2023-11-02 06:33:35.558128 +0000 UTC",
-    "updateTimestamp" : "2023-11-14 06:20:20.446476 +0000 UTC"
-  },
-  "spec" : {
-    "federationId" : "e2f27cc6-82b5-11ee-84e3-0255ac100032",
-    "federationVersion" : "v1.7.0-t1109",
-    "dnsSuffix" : [ "www.oidc.com" ]
-  },
-  "status" : {
-    "conditions" : [ {
-      "type" : "Federation",
-      "status" : "Unavailable",
-      "reason" : "FederationUnavailable",
-      "message" : "component volcano-scheduler is unhealthy",
-      "lastTransitionTime" : "0001-01-01T00:00:00Z"
-    } ]
-  }
-}
-
-

Status Codes

-
- - - - - - - - - - - - - - - - - - - -

Status Code

-

Description

-

200

-

Fleet object

-

400

-

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

-

403

-

The server refused the request.

-

404

-

Resources not found.

-

500

-

Internal server error.

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: Fleets
-
-
- diff --git a/docs/ucs/api-ref/ShowClusterList.html b/docs/ucs/api-ref/ShowClusterList.html deleted file mode 100644 index 77e3224a0..000000000 --- a/docs/ucs/api-ref/ShowClusterList.html +++ /dev/null @@ -1,1081 +0,0 @@ - - -

Obtaining the Cluster List

-

Function

This API is used to obtain the cluster list.

-
-

URI

GET /v1/clusters

- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 1 Query parameters

Parameter

-

Mandatory

-

Type

-

Description

-

category

-

No

-

String

-

Used to obtain clusters of a specific category.

-

enablestatus

-

No

-

Boolean

-

Whether to obtain the resource information of a cluster. If this parameter is not specified or set to true, the cluster resource summary information is returned. If this parameter is set to false, the cluster status is not returned. The default value is true.

-

clustergroupid

-

No

-

String

-

Fleet ID. If this parameter is not specified, all clusters are returned. If this parameter is specified, clusters that belong to the fleet are returned.

-

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.

-

order

-

No

-

String

-

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

-

managetype

-

No

-

String

-

Cluster type for listing the clusters. The value can be all, grouped, or discrete. If this parameter is not specified, the default value is all.

-
  • grouped: clusters added to a fleet
  • discrete: clusters not in any fleet
  • all: all clusters
-

clusterids

-

No

-

String

-

Cluster ID. If there are multiple IDs, separate them using commas (,).

-
-
-
-

Request Parameters

-
- - - - - - - - - - - -
Table 2 Parameter in the request header

Parameter

-

Mandatory

-

Type

-

Description

-

X-Auth-Token

-

Yes

-

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 Parameters in the response body

Parameter

-

Type

-

Description

-

items

-

Array of Cluster objects

-

List of cluster members

-

total

-

Integer

-

Total number of clusters

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - -
Table 4 Cluster

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

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 5 ObjectMeta

Parameter

-

Type

-

Description

-

uid

-

String

-

Resource ID

-

name

-

String

-

Resource name

-

generateName

-

String

-

If no name is provided, the server uses the prefix to generate a unique name.

-

namespace

-

String

-

Namespace

-

labels

-

Map<String,String>

-

Labels

-

annotations

-

Map<String,String>

-

Annotations

-

creationTimestamp

-

String

-

Creation time

-

updateTimestamp

-

String

-

Update time

-

resourceVersion

-

String

-

Internal version of a resource

-

generation

-

String

-

Generation of the desired resource state

-

managedFields

-

Array of ManagedFieldsEntry objects

-

Fields managed by workflows

-

ownerReferences

-

Array of OwnerReference objects

-

Ownership, dependencies, and garbage collection mechanism of objects. It supports resource management by the controller.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 6 ManagedFieldsEntry

Parameter

-

Type

-

Description

-

manager

-

String

-

Manager name

-

operation

-

String

-

Operation type that causes this entry to be 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 OwnerReference

Parameter

-

Type

-

Description

-

apiVersion

-

String

-

API version of the referent

-

kind

-

String

-

Type of the referent

-

name

-

String

-

Name of the referent

-

uid

-

String

-

UID of the referent

-

controller

-

Boolean

-

If the value is true, this reference points to the controller that manages the resource.

-

blockOwnerDeletion

-

Boolean

-

If the value is true and the owner has a finalizer named foregroundDeletion, the owner cannot be deleted until this reference is removed.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 8 ClusterSpec

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:

-
  • grouped: clusters added to a fleet
  • discrete: clusters not in any fleet
-

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 (consistent with the country)

-

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

-
-
- -
- - - - - - - - - - - - - -
Table 9 RuleNamespace

Parameter

-

Type

-

Description

-

rules

-

Array of RuleInfo objects

-

Permission policy list

-

namespaces

-

Array of strings

-

Namespace list

-
-
- -
- - - - - - - - - - - - - -
Table 10 RuleInfo

Parameter

-

Type

-

Description

-

ruleID

-

String

-

Permission policy ID

-

ruleName

-

String

-

Permission policy name

-
-
- -
- - - - - - - - - - - - - -
Table 11 LocalSecretReference

Parameter

-

Type

-

Description

-

namespace

-

String

-

Namespace that the resource belongs to

-

name

-

String

-

Resource name

-
-
- -
- - - - - - - - - - - - - - - - - - - - - -
Table 12 Taint

Parameter

-

Type

-

Description

-

key

-

String

-

Key

-

value

-

String

-

Value

-

effect

-

String

-

Effect information

-

timeadded

-

String

-

Timestamp information

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 13 ClusterStatus

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

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 14 ConditionStatus

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

-
-
- -
- - - - - - - - - - - - - -
Table 15 NodeSummary

Parameter

-

Type

-

Description

-

totalNum

-

String

-

The number of all nodes in a cluster

-

readyNum

-

String

-

The number of ready nodes in a cluster

-
-
- -
- - - - - - - - - - - - - - - - - - - - - -
Table 16 ResourceSummary

Parameter

-

Type

-

Description

-

allocatable

-

map<string, object>

-

Allocatable resources

-

allocating

-

map<string, object>

-

Resources in allocation

-

allocated

-

map<string, object>

-

Allocated resources

-

capacity

-

map<string, object>

-

Total resources

-
-
- -
- - - - - - - - - - - - - - - - - -
Table 17 Endpoint

Parameter

-

Type

-

Description

-

internal

-

String

-

Internal network address.

-

external

-

String

-

External network address.

-

external_otc

-

String

-

Endpoint of the cluster to be accessed through API Gateway.

-
-
- -
- - - - - - - - - - - - - -
Table 18 APIEnablement

Parameter

-

Type

-

Description

-

groupVersion

-

String

-

Resource group and version

-

resources

-

Array of APIResource objects

-

Resource type and name

-
-
- -
- - - - - - - - - - - - - -
Table 19 APIResource

Parameter

-

Type

-

Description

-

name

-

String

-

Resource name

-

kind

-

String

-

Resource category

-
-
-
-

Example Requests

None

-
-

Example Responses

Status code: 200

-

Information about all clusters is obtained.

-
{
-  "items" : [ {
-    "kind" : "Cluster",
-    "apiVersion" : "v1",
-    "metadata" : {
-      "name" : "test-cluster",
-      "uid" : "b0d1ecb5-7947-11ee-9467-0255ac1001bf",
-      "creationTimestamp" : "2023-11-02T06:36:14Z",
-      "labels" : {
-        "FeatureGates" : "elbv3,SupportClientCertificateRevocation,xGPU"
-      },
-      "annotations" : {
-        "vpcId" : "11c9fe72-5a90-4295-bcfe-774726fb9066"
-      }
-    },
-    "spec" : {
-      "syncMode" : "",
-      "clusterGroupID" : "bffbb35b-7949-11ee-886c-0255ac100037",
-      "manageType" : "grouped",
-      "provider" : "cmccloud",
-      "type" : "cce",
-      "category" : "self",
-      "region" : "cidc-rp-12",
-      "country" : "CN",
-      "city" : "150900",
-      "projectID" : "b6315dd3d0ff4be5b31a963256794989",
-      "projectName" : "cidc-rp-12",
-      "IsDownloadedCert" : false,
-      "operatorNamespace" : "2cd7ebd02e4743eba4e6342c09e49344"
-    },
-    "status" : {
-      "kubernetesVersion" : "v1.25",
-      "conditions" : [ {
-        "type" : "Ready",
-        "status" : "True",
-        "lastTransitionTime" : "2023-11-27T11:05:09+08:00",
-        "reason" : "ClusterAvailable"
-      }, {
-        "type" : "Cluster",
-        "status" : "Available",
-        "lastTransitionTime" : "2023-11-27T11:05:09+08:00",
-        "reason" : "ClusterAvailable"
-      }, {
-        "type" : "Federation",
-        "status" : "Federalized",
-        "lastTransitionTime" : "2023-11-14T14:31:58.744215+08:00"
-      } ],
-      "endpoints" : [ {
-        "url" : "https://192.168.1.251:5443",
-        "type" : "Internal"
-      } ],
-      "phase" : "Available",
-      "arrearFreeze" : "false",
-      "policeFreeze" : "false"
-    }
-  } ],
-  "total" : 1
-}
-
-

Status Codes

-
- - - - - - - - - - - - - - - - -

Status Code

-

Description

-

200

-

Information about all clusters is obtained.

-

400

-

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

-

403

-

The server refused the request.

-

500

-

Internal server error.

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: UCS Clusters
-
-
- diff --git a/docs/ucs/api-ref/ShowFederationProgress.html b/docs/ucs/api-ref/ShowFederationProgress.html deleted file mode 100644 index f6b5d0ae6..000000000 --- a/docs/ucs/api-ref/ShowFederationProgress.html +++ /dev/null @@ -1,593 +0,0 @@ - - -

Querying Federation Enabling Progress

-

Function

This API is used to query the federation enabling progress.

-
-

URI

GET /v1/clustergroups/{clustergroupid}/federations/progress

- -
- - - - - - - - - - - -
Table 1 Path parameter

Parameter

-

Mandatory

-

Type

-

Description

-

clustergroupid

-

Yes

-

String

-

Fleet ID

-
-
-
-

Request Parameters

-
- - - - - - - - - - - -
Table 2 Parameter in the request header

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 Parameters in the response body

Parameter

-

Type

-

Description

-

kind

-

String

-

API type

-

apiVersion

-

String

-

API version. The value is fixed at v1 and cannot be changed.

-

metadata

-

ObjectMeta object

-

ObjectMeta is a metadata structure that must be contained in all persistent resources in Kubernetes.

-

spec

-

JobSpec object

-

Details about the job. UCS creates or updates the job based on spec.

-

status

-

JobStatus object

-

Job status

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 4 JobSpec

Parameter

-

Type

-

Description

-

type

-

String

-

Job type

-

federationuid

-

String

-

Federation UID

-

resourceid

-

String

-

Resource ID

-

resourcename

-

String

-

Resource name

-

extendparam

-

String

-

Extended parameter

-

subjobs

-

Array of Job objects

-

Subjobs

-
-
- -
- - - - - - - - - - - - - - - - - - - - - -
Table 5 Job

Parameter

-

Type

-

Description

-

kind

-

String

-

API type

-

apiVersion

-

String

-

API version. The value is fixed at v1 and cannot be changed.

-

spec

-

JobSpec object

-

Details about the job. UCS creates or updates the job based on spec.

-

status

-

JobStatus object

-

Job status

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 6 ObjectMeta

Parameter

-

Type

-

Description

-

uid

-

String

-

Resource ID

-

name

-

String

-

Resource name

-

generateName

-

String

-

If no name is provided, the server uses the prefix to generate a unique name.

-

namespace

-

String

-

Namespace

-

labels

-

Map<String,String>

-

Labels

-

annotations

-

Map<String,String>

-

Annotations

-

creationTimestamp

-

String

-

Creation time

-

updateTimestamp

-

String

-

Update time

-

resourceVersion

-

String

-

Internal version of a resource

-

generation

-

String

-

Generation of the desired resource state

-

managedFields

-

Array of ManagedFieldsEntry objects

-

Fields managed by workflows

-

ownerReferences

-

Array of OwnerReference objects

-

Ownership, dependencies, and garbage collection mechanism of objects. It supports resource management by the controller.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 7 ManagedFieldsEntry

Parameter

-

Type

-

Description

-

manager

-

String

-

Manager name

-

operation

-

String

-

Operation type that causes this entry to be 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 8 OwnerReference

Parameter

-

Type

-

Description

-

apiVersion

-

String

-

API version of the referent

-

kind

-

String

-

Type of the referent

-

name

-

String

-

Name of the referent

-

uid

-

String

-

UID of the referent

-

controller

-

Boolean

-

If the value is true, this reference points to the controller that manages the resource.

-

blockOwnerDeletion

-

Boolean

-

If the value is true and the owner has a finalizer named foregroundDeletion, the owner cannot be deleted until this reference is removed.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - -
Table 9 JobStatus

Parameter

-

Type

-

Description

-

phase

-

String

-

Job phase

-

reason

-

String

-

Job reason

-

completiontime

-

String

-

Job completion time

-

starttime

-

String

-

Job start time

-
-
-
-

Example Requests

None

-
-

Example Responses

Status code: 200

-

Job for enabling cluster federation returned.

-
{
-  "kind" : "Job",
-  "apiVersion" : "v3",
-  "metadata" : {
-    "uid" : "70b5a14f-2fa4-11ee-bf07-0255ac1000b9",
-    "creationTimestamp" : "2023-07-31 13:16:20.715779 +0000 UTC",
-    "updateTimestamp" : "2023-07-31 13:17:24.497868 +0000 UTC",
-    "annotations" : {
-      "currentTimestamp" : "2023-07-31 13:17:24.933313136 +0000 UTC"
-    }
-  },
-  "spec" : {
-    "type" : "CreateFederationContainer",
-    "federationUID" : "70acf480-2fa4-11ee-ad1d-0255ac1001c4",
-    "resourceID" : "70acf480-2fa4-11ee-ad1d-0255ac1001c4",
-    "resourceName" : "70acf480-2fa4-11ee-ad1d-0255ac1001c4",
-    "subJobs" : [ {
-      "kind" : "Job",
-      "apiVersion" : "v3",
-      "metadata" : {
-        "uid" : "70b66b9a-2fa4-11ee-bf07-0255ac1000b9",
-        "creationTimestamp" : "2023-07-31 13:16:20.740512 +0000 UTC",
-        "updateTimestamp" : "2023-07-31 13:16:22.100528 +0000 UTC",
-        "annotations" : {
-          "currentTimestamp" : "2023-07-31 13:17:24.934274579 +0000 UTC"
-        }
-      },
-      "spec" : {
-        "type" : "InstallFederationChart",
-        "federationUID" : "70acf480-2fa4-11ee-ad1d-0255ac1001c4"
-      },
-      "status" : {
-        "phase" : "Success",
-        "completionTime" : "2023-07-31 13:16:22.100528 +0000 UTC",
-        "startTime" : "2023-07-31 13:16:22.100528 +0000 UTC"
-      }
-    }, {
-      "kind" : "Job",
-      "apiVersion" : "v3",
-      "metadata" : {
-        "uid" : "70b66b68-2fa4-11ee-bf07-0255ac1000b9",
-        "creationTimestamp" : "2023-07-31 13:16:20.736232 +0000 UTC",
-        "updateTimestamp" : "2023-07-31 13:17:24.490359 +0000 UTC",
-        "annotations" : {
-          "currentTimestamp" : "2023-07-31 13:17:24.934277116 +0000 UTC"
-        }
-      },
-      "spec" : {
-        "type" : "CreateNetworkResource",
-        "federationUID" : "70acf480-2fa4-11ee-ad1d-0255ac1001c4",
-        "extendParam" : {
-          "JobExtendParamKeyElbID" : "69694819-67dc-44ac-ab6e-9b18087c5c4c"
-        }
-      },
-      "status" : {
-        "phase" : "Success",
-        "completionTime" : "2023-07-31 13:17:24.490359 +0000 UTC",
-        "startTime" : "2023-07-31 13:16:20.744891 +0000 UTC"
-      }
-    }, {
-      "kind" : "Job",
-      "apiVersion" : "v3",
-      "metadata" : {
-        "uid" : "70b66afa-2fa4-11ee-bf07-0255ac1000b9",
-        "creationTimestamp" : "2023-07-31 13:16:20.731295 +0000 UTC",
-        "updateTimestamp" : "2023-07-31 13:16:22.100452 +0000 UTC",
-        "annotations" : {
-          "currentTimestamp" : "2023-07-31 13:17:24.934288685 +0000 UTC"
-        }
-      },
-      "spec" : {
-        "type" : "CreateCert",
-        "federationUID" : "70acf480-2fa4-11ee-ad1d-0255ac1001c4"
-      },
-      "status" : {
-        "phase" : "Success",
-        "completionTime" : "2023-07-31 13:16:22.100452 +0000 UTC",
-        "startTime" : "2023-07-31 13:16:22.100452 +0000 UTC"
-      }
-    }, {
-      "kind" : "Job",
-      "apiVersion" : "v3",
-      "metadata" : {
-        "uid" : "70b66ad0-2fa4-11ee-bf07-0255ac1000b9",
-        "creationTimestamp" : "2023-07-31 13:16:20.726434 +0000 UTC",
-        "updateTimestamp" : "2023-07-31 13:16:22.093902 +0000 UTC",
-        "annotations" : {
-          "currentTimestamp" : "2023-07-31 13:17:24.934291673 +0000 UTC"
-        }
-      },
-      "spec" : {
-        "type" : "CreateNode",
-        "federationUID" : "70acf480-2fa4-11ee-ad1d-0255ac1001c4"
-      },
-      "status" : {
-        "phase" : "Success",
-        "completionTime" : "2023-07-31 13:16:22.093902 +0000 UTC",
-        "startTime" : "2023-07-31 13:16:20.745187 +0000 UTC"
-      }
-    } ]
-  },
-  "status" : {
-    "phase" : "Success",
-    "completionTime" : "2023-07-31 13:17:24.497868 +0000 UTC",
-    "startTime" : "2023-07-31 13:16:20.721007 +0000 UTC"
-  }
-}
-
-

Status Codes

-
- - - - - - - - - - - - - - - - -

Status Code

-

Description

-

200

-

Job for enabling cluster federation returned.

-

400

-

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

-

404

-

Resources not found.

-

500

-

Internal server error.

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: Fleets
-
-
- diff --git a/docs/ucs/api-ref/UpdateCluster.html b/docs/ucs/api-ref/UpdateCluster.html deleted file mode 100644 index c132f6227..000000000 --- a/docs/ucs/api-ref/UpdateCluster.html +++ /dev/null @@ -1,440 +0,0 @@ - - -

Updating a Cluster

-

Function

This API is used to update a cluster. Currently, only the country/city of attached clusters and on-premises clusters, and the number of worker nodes in a multi-cloud cluster can be updated.

-
-

URI

PUT /v1/clusters/{clusterid}

- -
- - - - - - - - - - - -
Table 1 Path parameter

Parameter

-

Mandatory

-

Type

-

Description

-

clusterid

-

Yes

-

String

-

Cluster ID

-
-
-
-

Request Parameters

-
- - - - - - - - - - - - - - - - -
Table 2 Parameters in the request header

Parameter

-

Mandatory

-

Type

-

Description

-

X-Auth-Token

-

Yes

-

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.

-

Content-Type

-

Yes

-

String

-

Message body type (format). Only application/json is supported.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 3 Parameters in the request body

Parameter

-

Mandatory

-

Type

-

Description

-

kind

-

Yes

-

String

-

API type. The value is fixed at Cluster and cannot be changed.

-

apiVersion

-

Yes

-

String

-

API version. The value is fixed at v1 and cannot be changed.

-

metadata

-

No

-

ObjectMeta object

-

Basic information about the cluster. Metadata is a collection of attributes.

-

spec

-

No

-

UpdateClusterSpec object

-

Details about the cluster. UCS creates or updates the cluster based on spec.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 4 ObjectMeta

Parameter

-

Mandatory

-

Type

-

Description

-

uid

-

No

-

String

-

Cluster ID

-

name

-

No

-

String

-

Cluster name

-

labels

-

No

-

Map<String,String>

-

Labels

-

creationTimestamp

-

No

-

String

-

Creation time. It is the UTC time in the RFC 3339 format.

-

updateTimestamp

-

No

-

String

-

Update timestamp

-
-
- -
- - - - - - - - - - - - - - - - - - - - - -
Table 5 UpdateClusterSpec

Parameter

-

Mandatory

-

Type

-

Description

-

country

-

No

-

String

-

Country where the cluster is located

-

city

-

No

-

String

-

City where the cluster is located (consistent with the country)

-

workerConfig

-

No

-

WorkerConfig object

-

Worker node configuration. This parameter is only available for multi-cloud clusters.

-
-
- -
- - - - - - - - - - - - - - - - -
Table 6 WorkerConfig

Parameter

-

Mandatory

-

Type

-

Description

-

replicas

-

No

-

Integer

-

The number of nodes

-

strategy

-

No

-

NodeUpgradeStrategy object

-

Node update policy

-
-
- -
- - - - - - - - - - - - - - - - -
Table 7 NodeUpgradeStrategy

Parameter

-

Mandatory

-

Type

-

Description

-

type

-

No

-

String

-

Policy type

-

rollingUpdate

-

No

-

RollingUpdateNodeUpgradeStrategy object

-

Rolling update

-
-
- -
- - - - - - - - - - - - - - - - - - - - - -
Table 8 RollingUpdateNodeUpgradeStrategy

Parameter

-

Mandatory

-

Type

-

Description

-

maxUnavailable

-

No

-

Object

-

Maximum number of nodes that can be unavailable during an update

-

maxSurge

-

No

-

Object

-

Maximum number of nodes that can be created over the desired number of nodes

-

deletePolicy

-

No

-

String

-

Deletion policy. The options are Random, Oldest, and Newest.

-
-
-
-

Response Parameters

Status code: 200

-

Cluster information updated.

-

Status code: 400

- -
- - - - - - - - - -
Table 9 Parameter in the response body

Parameter

-

Type

-

Description

-

-

-

String

-

-

-
-
-

Status code: 403

- -
- - - - - - - - - -
Table 10 Parameter in the response body

Parameter

-

Type

-

Description

-

-

-

String

-

-

-
-
-

Status code: 500

- -
- - - - - - - - - -
Table 11 Parameter in the response body

Parameter

-

Type

-

Description

-

-

-

String

-

-

-
-
-
-

Example Requests

Updating a cluster

-
{
-  "kind" : "Cluster",
-  "apiVersion" : "v1",
-  "metadata" : {
-    "annotations" : {
-      "kubeconfig" : "{\"kind\":\"Config\",\"apiVersion\":\"v1\",\"preferences\":{},\"clusters\":[{\"name\":\"internalCluster\",\"cluster\":{\"server\":\"https://100.94.13.93:5443\",\"insecure-skip-tls-verify\":true}}],\"users\":[{\"name\":\"user\",\"user\":{\"client-certificate-data\":\"\",\"client-key-data\":\"\"}}],\"contexts\":[{\"name\":\"internal\",\"context\":{\"cluster\":\"internalCluster\",\"user\":\"user\"}}],\"current-context\":\"internal\"}"
-    }
-  },
-  "spec" : {
-    "country" : "AL",
-    "city" : "AL"
-  }
-}
-
-

Example Responses

Status code: 200

-

The cluster has been updated.

-
{ }
-
-

Status Codes

-
- - - - - - - - - - - - - - - - -

Status Code

-

Description

-

200

-

The cluster has been updated.

-

400

-

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

-

403

-

The server refused the request.

-

500

-

Internal server error.

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: UCS Clusters
-
-
- diff --git a/docs/ucs/api-ref/UpdateClusterGroup.html b/docs/ucs/api-ref/UpdateClusterGroup.html deleted file mode 100644 index e3d331eda..000000000 --- a/docs/ucs/api-ref/UpdateClusterGroup.html +++ /dev/null @@ -1,140 +0,0 @@ - - -

Updating Fleet Description

-

Function

This API is used to update the description of a fleet. You must have the permissions to update the fleet.

-
-

URI

PUT /v1/clustergroups/{clustergroupid}/description

- -
- - - - - - - - - - - -
Table 1 Path parameter

Parameter

-

Mandatory

-

Type

-

Description

-

clustergroupid

-

Yes

-

String

-

Fleet ID

-
-
-
-

Request Parameters

-
- - - - - - - - - - - - - - - - -
Table 2 Parameters in the request header

Parameter

-

Mandatory

-

Type

-

Description

-

X-Auth-Token

-

Yes

-

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.

-

Content-Type

-

Yes

-

String

-

Message body type (format). Only application/json is supported.

-
-
- -
- - - - - - - - - - - -
Table 3 Parameter in the request body

Parameter

-

Mandatory

-

Type

-

Description

-

description

-

Yes

-

String

-

Fleet description

-
-
-
-

Response Parameters

None

-
-

Example Requests

Updating fleet description

-
{
-  "description" : "aaaaaaaaa"
-}
-
-

Example Responses

None

-
-

Status Codes

-
- - - - - - - - - - - - - - - - - - - -

Status Code

-

Description

-

200

-

Updated.

-

400

-

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

-

403

-

The server refused the request.

-

404

-

Resources not found.

-

500

-

Internal server error.

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: Fleets
-
-
- diff --git a/docs/ucs/api-ref/UpdateClusterGroupAssociatedClusters.html b/docs/ucs/api-ref/UpdateClusterGroupAssociatedClusters.html deleted file mode 100644 index cc8f632d2..000000000 --- a/docs/ucs/api-ref/UpdateClusterGroupAssociatedClusters.html +++ /dev/null @@ -1,130 +0,0 @@ - - -

Adding Clusters to a Fleet

-

Function

This API is used to add clusters to a fleet. One or more clusters can be added at the same time. This API cannot be used to remove all or some clusters from a fleet.

-
-

URI

PUT /v1/clustergroups/{clustergroupid}/associatedclusters

- -
- - - - - - - - - - - -
Table 1 Path parameter

Parameter

-

Mandatory

-

Type

-

Description

-

clustergroupid

-

Yes

-

String

-

Fleet ID

-
-
-
-

Request Parameters

-
- - - - - - - - - - - - - - - - -
Table 2 Parameters in the request header

Parameter

-

Mandatory

-

Type

-

Description

-

X-Auth-Token

-

Yes

-

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.

-

Content-Type

-

Yes

-

String

-

Message body type (format). Only application/json is supported.

-
-
- -
- - - - - - - - - - - -
Table 3 Parameter in the request body

Parameter

-

Mandatory

-

Type

-

Description

-

clusterIds

-

No

-

Array of strings

-

Cluster IDs for updating information about clusters associated with a fleet

-
-
-
-

Response Parameters

None

-
-

Example Requests

Updating clusters in a fleet

-
{
-  "clusterids" : [ "xxxx-xxxx-xxxx" ]
-}
-
-

Example Responses

None

-
-

Status Codes

-
- - - - - - - - - - - - - -

Status Code

-

Description

-

200

-

Clusters have been added to the fleet.

-

400

-

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

-

500

-

Internal server error.

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: Fleets
-
-
- diff --git a/docs/ucs/api-ref/UpdateClusterGroupAssociatedRules.html b/docs/ucs/api-ref/UpdateClusterGroupAssociatedRules.html deleted file mode 100644 index b0a7e94b2..000000000 --- a/docs/ucs/api-ref/UpdateClusterGroupAssociatedRules.html +++ /dev/null @@ -1,172 +0,0 @@ - - -

Updating Permission Policies Associated with a Fleet

-

Function

This API is used to update the permission policies associated with a fleet.

-
-

URI

PUT /v1/clustergroups/{clustergroupid}/associatedrules

- -
- - - - - - - - - - - -
Table 1 Path parameter

Parameter

-

Mandatory

-

Type

-

Description

-

clustergroupid

-

Yes

-

String

-

Fleet ID

-
-
-
-

Request Parameters

-
- - - - - - - - - - - - - - - - -
Table 2 Parameters in the request header

Parameter

-

Mandatory

-

Type

-

Description

-

X-Auth-Token

-

Yes

-

String

-

Token authentication information

-

Minimum length: 1

-

Maximum length: 16384

-

Content-Type

-

Yes

-

String

-

Request body type or format

-
-
- -
- - - - - - - - - - - -
Table 3 Parameter in the request body

Parameter

-

Mandatory

-

Type

-

Description

-

ruleIDNamespaces

-

No

-

Array of RuleIDNamespaces objects

-

Permission policy ID and namespaces related to the permission policy

-
-
- -
- - - - - - - - - - - - - - - - -
Table 4 RuleIDNamespaces

Parameter

-

Mandatory

-

Type

-

Description

-

ruleIDs

-

No

-

Array of strings

-

Permission policy IDs

-

namespaces

-

No

-

Array of strings

-

Namespaces related to permission policies

-
-
-
-

Response Parameters

None

-
-

Example Requests

Updating the permission policies associated with a fleet

-
{
-  "ruleIDNamespaces" : [ {
-    "ruleIDs" : [ "f6434332-60d6-11ed-a847-0255ac10003f" ],
-    "namespaces" : [ "default", "kube-system" ]
-  } ]
-}
-
-

Example Responses

None

-
-

Status Codes

-
- - - - - - - - - - - - - - - - -

Status Code

-

Description

-

200

-

The fleet has been associated with permission policies.

-

400

-

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

-

403

-

The server refused the request.

-

500

-

Internal server error.

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: Fleet
-
-
- diff --git a/docs/ucs/api-ref/UpdateClusterRules.html b/docs/ucs/api-ref/UpdateClusterRules.html deleted file mode 100644 index 7923a3871..000000000 --- a/docs/ucs/api-ref/UpdateClusterRules.html +++ /dev/null @@ -1,170 +0,0 @@ - - -

Associating a Cluster with Permission Policies

-

Function

This API is used to associate a cluster with permission policies.

-
-

URI

PUT /v1/clusters/{clusterid}/associatedrules

- -
- - - - - - - - - - - -
Table 1 Path parameter

Parameter

-

Mandatory

-

Type

-

Description

-

clusterid

-

Yes

-

String

-

Cluster ID

-
-
-
-

Request Parameters

-
- - - - - - - - - - - - - - - - -
Table 2 Parameters in the request header

Parameter

-

Mandatory

-

Type

-

Description

-

X-Auth-Token

-

Yes

-

String

-

Identity authentication information

-

Content-Type

-

Yes

-

String

-

Request body type or format

-
-
- -
- - - - - - - - - - - -
Table 3 Parameter in the request body

Parameter

-

Mandatory

-

Type

-

Description

-

ruleIDNamespaces

-

No

-

Array of RuleIDNamespaces objects

-

Permission policy ID and namespaces related to the permission policy

-
-
- -
- - - - - - - - - - - - - - - - -
Table 4 RuleIDNamespaces

Parameter

-

Mandatory

-

Type

-

Description

-

ruleIDs

-

No

-

Array of strings

-

Permission policy IDs

-

namespaces

-

No

-

Array of strings

-

Namespaces related to permission policies

-
-
-
-

Response Parameters

None

-
-

Example Requests

Associating a cluster with permission policies

-
{
-  "ruleIDNamespaces" : [ {
-    "ruleIDs" : [ "f6434332-60d6-11ed-a847-0255ac10003f" ],
-    "namespaces" : [ "default", "xxxxx" ]
-  } ]
-}
-
-

Example Responses

None

-
-

Status Codes

-
- - - - - - - - - - - - - - - - -

Status Code

-

Description

-

200

-

The cluster has been associated with permission policies.

-

400

-

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

-

403

-

The server refused the request.

-

500

-

Internal server error.

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: UCS Cluster
-
-
- diff --git a/docs/ucs/api-ref/UpdateRule.html b/docs/ucs/api-ref/UpdateRule.html deleted file mode 100644 index 2a8d315c0..000000000 --- a/docs/ucs/api-ref/UpdateRule.html +++ /dev/null @@ -1,220 +0,0 @@ - - -

Updating a Permission Policy

-

Function

This API is used to update a permission policy.

-
-

URI

PUT /v1/permissions/rules/{ruleid}

- -
- - - - - - - - - - - -
Table 1 Path parameter

Parameter

-

Mandatory

-

Type

-

Description

-

ruleid

-

Yes

-

String

-

Permission policy ID

-
-
-
-

Request Parameters

-
- - - - - - - - - - - - - - - - -
Table 2 Parameters in the request header

Parameter

-

Mandatory

-

Type

-

Description

-

X-Auth-Token

-

Yes

-

String

-

Identity authentication information

-

Minimum length: 1

-

Maximum length: 16384

-

Content-Type

-

Yes

-

String

-

Request body type or format

-
-
- -
- - - - - - - - - - - -
Table 3 Parameter in the request body

Parameter

-

Mandatory

-

Type

-

Description

-

spec

-

No

-

RuleSpec object

-

Details about the permission policy. UCS creates or updates the permission policy by spec.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 4 RuleSpec

Parameter

-

Mandatory

-

Type

-

Description

-

iamuserids

-

No

-

Array of strings

-

Information of IAM users associated with a permission policy

-

type

-

No

-

String

-

Permission policy type. The value can be readonly, develop, admin, or custom.

-

contents

-

No

-

Array of Content objects

-

Permission policy content

-

description

-

No

-

String

-

Permission policy description

-

Minimum length: 0

-

Maximum length: 255

-
-
- -
- - - - - - - - - - - - - - - - -
Table 5 Content

Parameter

-

Mandatory

-

Type

-

Description

-

verbs

-

No

-

Array of strings

-

Action list

-

resources

-

No

-

Array of strings

-

Resource list

-
-
-
-

Response Parameters

None

-
-

Example Requests

Updating a permission policy

-
{
-  "spec" : {
-    "iamUserIDs" : [ "978ff70ec1494a5680f6218faa3567d9", "5acdb44b47ba4bd79783ad40e5346783" ],
-    "type" : "custom",
-    "description" : "this is description"
-  }
-}
-
-

Example Responses

None

-
-

Status Codes

-
- - - - - - - - - - - - - -

Status Code

-

Description

-

200

-

The permission policy has been updated.

-

400

-

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

-

500

-

Internal server error.

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: Permissions
-
-
- diff --git a/docs/ucs/api-ref/en-us_image_0000002267758860.png b/docs/ucs/api-ref/en-us_image_0000002267758860.png deleted file mode 100644 index 4a421d8a1..000000000 Binary files a/docs/ucs/api-ref/en-us_image_0000002267758860.png and /dev/null differ diff --git a/docs/ucs/api-ref/en-us_image_0000002267861934.png b/docs/ucs/api-ref/en-us_image_0000002267861934.png deleted file mode 100644 index 508f4c13a..000000000 Binary files a/docs/ucs/api-ref/en-us_image_0000002267861934.png and /dev/null differ diff --git a/docs/ucs/api-ref/en-us_image_0000002302431861.png b/docs/ucs/api-ref/en-us_image_0000002302431861.png deleted file mode 100644 index ff862c91f..000000000 Binary files a/docs/ucs/api-ref/en-us_image_0000002302431861.png and /dev/null differ diff --git a/docs/ucs/api-ref/en-us_image_0000002302431869.png b/docs/ucs/api-ref/en-us_image_0000002302431869.png deleted file mode 100644 index 829989a93..000000000 Binary files a/docs/ucs/api-ref/en-us_image_0000002302431869.png and /dev/null differ diff --git a/docs/ucs/api-ref/en-us_image_0000002302431877.png b/docs/ucs/api-ref/en-us_image_0000002302431877.png deleted file mode 100644 index 94736e3a3..000000000 Binary files a/docs/ucs/api-ref/en-us_image_0000002302431877.png and /dev/null differ diff --git a/docs/ucs/api-ref/en-us_image_0000002302518741.png b/docs/ucs/api-ref/en-us_image_0000002302518741.png deleted file mode 100644 index 0adf514b3..000000000 Binary files a/docs/ucs/api-ref/en-us_image_0000002302518741.png and /dev/null differ diff --git a/docs/ucs/api-ref/en-us_image_0000002302518757.png b/docs/ucs/api-ref/en-us_image_0000002302518757.png deleted file mode 100644 index ec3abb85c..000000000 Binary files a/docs/ucs/api-ref/en-us_image_0000002302518757.png and /dev/null differ diff --git a/docs/ucs/api-ref/en-us_topic_0000002520563224.html b/docs/ucs/api-ref/en-us_topic_0000002520563224.html deleted file mode 100644 index fa9050cd6..000000000 --- a/docs/ucs/api-ref/en-us_topic_0000002520563224.html +++ /dev/null @@ -1,19 +0,0 @@ - - - -

Fleet

- -

-
- -
- - -
-
Parent topic: Outdated APIs
-
-
- diff --git a/docs/ucs/api-ref/en-us_topic_0000002551763211.html b/docs/ucs/api-ref/en-us_topic_0000002551763211.html deleted file mode 100644 index e1008c818..000000000 --- a/docs/ucs/api-ref/en-us_topic_0000002551763211.html +++ /dev/null @@ -1,19 +0,0 @@ - - - -

UCS Cluster

- -

-
- -
- - -
-
Parent topic: Outdated APIs
-
-
- diff --git a/docs/ucs/api-ref/en-us_topic_0000002551843195.html b/docs/ucs/api-ref/en-us_topic_0000002551843195.html deleted file mode 100644 index b571c400b..000000000 --- a/docs/ucs/api-ref/en-us_topic_0000002551843195.html +++ /dev/null @@ -1,19 +0,0 @@ - - - -

Outdated APIs

- -

-
- -
- -
- diff --git a/docs/ucs/api-ref/public_sys-resources/caution_3.0-en-us.png b/docs/ucs/api-ref/public_sys-resources/caution_3.0-en-us.png deleted file mode 100644 index 60f607621..000000000 Binary files a/docs/ucs/api-ref/public_sys-resources/caution_3.0-en-us.png and /dev/null differ diff --git a/docs/ucs/api-ref/public_sys-resources/danger_3.0-en-us.png b/docs/ucs/api-ref/public_sys-resources/danger_3.0-en-us.png deleted file mode 100644 index 47a9c7235..000000000 Binary files a/docs/ucs/api-ref/public_sys-resources/danger_3.0-en-us.png and /dev/null differ diff --git a/docs/ucs/api-ref/public_sys-resources/delta.gif b/docs/ucs/api-ref/public_sys-resources/delta.gif deleted file mode 100644 index 0d1b1f674..000000000 Binary files a/docs/ucs/api-ref/public_sys-resources/delta.gif and /dev/null differ diff --git a/docs/ucs/api-ref/public_sys-resources/deltaend.gif b/docs/ucs/api-ref/public_sys-resources/deltaend.gif deleted file mode 100644 index cc7da0fc8..000000000 Binary files a/docs/ucs/api-ref/public_sys-resources/deltaend.gif and /dev/null differ diff --git a/docs/ucs/api-ref/public_sys-resources/icon-arrowdn.gif b/docs/ucs/api-ref/public_sys-resources/icon-arrowdn.gif deleted file mode 100644 index 379428032..000000000 Binary files a/docs/ucs/api-ref/public_sys-resources/icon-arrowdn.gif and /dev/null differ diff --git a/docs/ucs/api-ref/public_sys-resources/icon-arrowrt.gif b/docs/ucs/api-ref/public_sys-resources/icon-arrowrt.gif deleted file mode 100644 index 6aaaa11c2..000000000 Binary files a/docs/ucs/api-ref/public_sys-resources/icon-arrowrt.gif and /dev/null differ diff --git a/docs/ucs/api-ref/public_sys-resources/icon-caution.gif b/docs/ucs/api-ref/public_sys-resources/icon-caution.gif deleted file mode 100644 index 079c79b26..000000000 Binary files a/docs/ucs/api-ref/public_sys-resources/icon-caution.gif and /dev/null differ diff --git a/docs/ucs/api-ref/public_sys-resources/icon-danger.gif b/docs/ucs/api-ref/public_sys-resources/icon-danger.gif deleted file mode 100644 index 079c79b26..000000000 Binary files a/docs/ucs/api-ref/public_sys-resources/icon-danger.gif and /dev/null differ diff --git a/docs/ucs/api-ref/public_sys-resources/icon-huawei.gif b/docs/ucs/api-ref/public_sys-resources/icon-huawei.gif deleted file mode 100644 index a31d60f89..000000000 Binary files a/docs/ucs/api-ref/public_sys-resources/icon-huawei.gif and /dev/null differ diff --git a/docs/ucs/api-ref/public_sys-resources/icon-note.gif b/docs/ucs/api-ref/public_sys-resources/icon-note.gif deleted file mode 100644 index 31be2b039..000000000 Binary files a/docs/ucs/api-ref/public_sys-resources/icon-note.gif and /dev/null differ diff --git a/docs/ucs/api-ref/public_sys-resources/icon-notice.gif b/docs/ucs/api-ref/public_sys-resources/icon-notice.gif deleted file mode 100644 index 409070650..000000000 Binary files a/docs/ucs/api-ref/public_sys-resources/icon-notice.gif and /dev/null differ diff --git a/docs/ucs/api-ref/public_sys-resources/icon-tip.gif b/docs/ucs/api-ref/public_sys-resources/icon-tip.gif deleted file mode 100644 index c47bae05c..000000000 Binary files a/docs/ucs/api-ref/public_sys-resources/icon-tip.gif and /dev/null differ diff --git a/docs/ucs/api-ref/public_sys-resources/icon-warning.gif b/docs/ucs/api-ref/public_sys-resources/icon-warning.gif deleted file mode 100644 index 079c79b26..000000000 Binary files a/docs/ucs/api-ref/public_sys-resources/icon-warning.gif and /dev/null differ diff --git a/docs/ucs/api-ref/public_sys-resources/note_3.0-en-us.png b/docs/ucs/api-ref/public_sys-resources/note_3.0-en-us.png deleted file mode 100644 index 57a0e1f53..000000000 Binary files a/docs/ucs/api-ref/public_sys-resources/note_3.0-en-us.png and /dev/null differ diff --git a/docs/ucs/api-ref/public_sys-resources/notice_3.0-en-us.png b/docs/ucs/api-ref/public_sys-resources/notice_3.0-en-us.png deleted file mode 100644 index fa4b64990..000000000 Binary files a/docs/ucs/api-ref/public_sys-resources/notice_3.0-en-us.png and /dev/null differ diff --git a/docs/ucs/api-ref/public_sys-resources/warning_3.0-en-us.png b/docs/ucs/api-ref/public_sys-resources/warning_3.0-en-us.png deleted file mode 100644 index def5c3565..000000000 Binary files a/docs/ucs/api-ref/public_sys-resources/warning_3.0-en-us.png and /dev/null differ diff --git a/docs/ucs/api-ref/topic_300000000.html b/docs/ucs/api-ref/topic_300000000.html deleted file mode 100644 index 453801fac..000000000 --- a/docs/ucs/api-ref/topic_300000000.html +++ /dev/null @@ -1,31 +0,0 @@ - - -

UCS Clusters

-
-
- - -
-
Parent topic: API
-
-
- diff --git a/docs/ucs/api-ref/topic_300000001.html b/docs/ucs/api-ref/topic_300000001.html deleted file mode 100644 index 5571d4077..000000000 --- a/docs/ucs/api-ref/topic_300000001.html +++ /dev/null @@ -1,42 +0,0 @@ - - -

Fleets

-

-
-
- - -
-
Parent topic: API
-
-
- diff --git a/docs/ucs/api-ref/topic_300000002.html b/docs/ucs/api-ref/topic_300000002.html deleted file mode 100644 index 9b710983d..000000000 --- a/docs/ucs/api-ref/topic_300000002.html +++ /dev/null @@ -1,22 +0,0 @@ - - -

Permissions

-

-
-
- - -
-
Parent topic: Outdated APIs
-
-
- diff --git a/docs/ucs/api-ref/ucs_api_0001.html b/docs/ucs/api-ref/ucs_api_0001.html deleted file mode 100644 index 2a2ae5b0a..000000000 --- a/docs/ucs/api-ref/ucs_api_0001.html +++ /dev/null @@ -1,19 +0,0 @@ - - -

Before You Start

-
-
- -
- diff --git a/docs/ucs/api-ref/ucs_api_0002.html b/docs/ucs/api-ref/ucs_api_0002.html deleted file mode 100644 index f99a24252..000000000 --- a/docs/ucs/api-ref/ucs_api_0002.html +++ /dev/null @@ -1,12 +0,0 @@ - - -

Overview

-

Ubiquitous Cloud Native Service (UCS) is the first distributed cloud native product in the industry. It provides a consistent experience in cloud native application deployment, management, and ecosystem. Cloud native applications can run across regions and clouds with intelligent traffic distribution.

-

This document describes how to use application programming interfaces (APIs) to perform operations on UCS, such as creating or deleting fleets, registering or deleting clusters, and creating, updating, or deleting permission policies.

-
-
-
-
Parent topic: Before You Start
-
-
- diff --git a/docs/ucs/api-ref/ucs_api_0003.html b/docs/ucs/api-ref/ucs_api_0003.html deleted file mode 100644 index 0a257a852..000000000 --- a/docs/ucs/api-ref/ucs_api_0003.html +++ /dev/null @@ -1,11 +0,0 @@ - - -

API Calling

-

UCS supports Representational State Transfer (REST) APIs, allowing you to call APIs using HTTPS. For details about API calling, see Calling APIs.

-
-
-
-
Parent topic: Before You Start
-
-
- diff --git a/docs/ucs/api-ref/ucs_api_0004.html b/docs/ucs/api-ref/ucs_api_0004.html deleted file mode 100644 index 7e06dd949..000000000 --- a/docs/ucs/api-ref/ucs_api_0004.html +++ /dev/null @@ -1,11 +0,0 @@ - - -

Endpoints

-

An endpoint is the request address for calling an API. Endpoints vary depending on services and regions. The endpoint of UCS consists of the service name, region ID, and external domain name. The format is as follows: ucs.region0_id.external_global_domain_name.

-
-
-
-
Parent topic: Before You Start
-
-
- diff --git a/docs/ucs/api-ref/ucs_api_0005.html b/docs/ucs/api-ref/ucs_api_0005.html deleted file mode 100644 index 051ce5487..000000000 --- a/docs/ucs/api-ref/ucs_api_0005.html +++ /dev/null @@ -1,11 +0,0 @@ - - -

Constraints

-
-
-
-
-
Parent topic: Before You Start
-
-
- diff --git a/docs/ucs/api-ref/ucs_api_0006.html b/docs/ucs/api-ref/ucs_api_0006.html deleted file mode 100644 index 3a5b72c4b..000000000 --- a/docs/ucs/api-ref/ucs_api_0006.html +++ /dev/null @@ -1,21 +0,0 @@ - - -

Concepts

-
-
-
-
-
Parent topic: Before You Start
-
-
- diff --git a/docs/ucs/api-ref/ucs_api_0007.html b/docs/ucs/api-ref/ucs_api_0007.html deleted file mode 100644 index fe08504da..000000000 --- a/docs/ucs/api-ref/ucs_api_0007.html +++ /dev/null @@ -1,15 +0,0 @@ - - -

Calling APIs

-
-
- -
- diff --git a/docs/ucs/api-ref/ucs_api_0008.html b/docs/ucs/api-ref/ucs_api_0008.html deleted file mode 100644 index 2d509ef2f..000000000 --- a/docs/ucs/api-ref/ucs_api_0008.html +++ /dev/null @@ -1,177 +0,0 @@ - - -

Making an API Request

-

This section describes the structure of a REST API request, and uses the IAM API for obtaining a user tokenobtaining a user token as an example to demonstrate how to call an API. The obtained token can then be used to authenticate the calling of other APIs.

-

Request URI

A request URI is in the following format:

-

{URI-scheme}://{Endpoint}/{resource-path}?{query-string}

-

Although a request URI is included in the request header, most programming languages or frameworks require the request URI to be transmitted separately.

- -
- - - - - - - - - - - - - - - - -
Table 1 URI parameters

Parameter

-

Description

-

URI-scheme

-

Protocol used to transmit requests. All APIs use HTTPS.

-

Endpoint

-

Domain name or IP address of the server bearing the REST service. The endpoint varies between services in different regions. It can be obtained from Regions and Endpoints"Regions and Endpoints".

-

resource-path

-

Access path of an API for performing a specified operation. Obtain the path from the URI of an API. For example, the resource-path of the API used to obtain a user token is /v3/auth/tokens.

-

query-string

-

Query parameter, which is optional. Ensure that a question mark (?) is included before each query parameter that is in the format of Parameter name=Parameter value. For example, ?limit=10 indicates that a maximum of 10 data records will be displayed.

-
-
-

To simplify the URI display in this document, each API is provided only with a resource-path and a request method. The URI-scheme of all APIs is HTTPS, and the endpoints of all APIs in the same region are identical.

-
-
-

Request Methods

The HTTP protocol defines the following request methods that can be used to send a request to the server. -
- - - - - - - - - - - - - - - - - - - - - - -
Table 2 HTTP methods

Method

-

Description

-

GET

-

Requests the server to return specified resources.

-

PUT

-

Requests the server to update specified resources.

-

POST

-

Requests the server to add resources or perform special operations.

-

DELETE

-

Requests the server to delete specified resources, for example, an object.

-

HEAD

-

Requests the server to return the response header.

-

PATCH

-

Requests the server to update partial content of a specified resource.

-

If the resource does not exist, a new resource will be created.

-
-
-
-

For example, in the case of the API used to obtain a user tokenobtain a user token, the request method is POST. The request is as follows:

-
1
POST https://{{endpoint}}/v3/auth/tokens
-
-
-
-

Request Header

You can also add additional header fields to a request, such as the fields required by a specified URI or HTTP method. For example, to request for the authentication information, add Content-Type, which specifies the request body type.

-
Table 3 lists common request header fields. -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 3 Common request header fields

Parameter

-

Description

-

Mandatory

-

Example Value

-

Host

-

Specifies the server domain name and port number of the resources being requested. The value can be obtained from the URL of the service API. The value is in the format of Hostname:Port number. If the port number is not specified, the default port is used. The default port number for https is 443.

-

No

-

This field is mandatory for AK/SK authentication.

-

code.test.com

-

or

-

code.test.com:443

-

Content-Type

-

Specifies the type (or format) of the message body. The default value application/json is recommended. Other values of this field will be provided for specific APIs if any.

-

Yes

-

application/json

-

Content-Length

-

Specifies the length of the request body. The unit is byte.

-

No

-

3495

-

X-Project-Id

-

Specifies the project ID. Obtain the project ID by following the instructions in Obtaining a Project ID.

-

No

-

e9993fc787d94b6c886cbaa340f9c0f4

-

X-Auth-Token

-

Specifies the user token.

-

It is a response to the API for obtaining a user token. (This is the only API that does not require authentication.)

-

After the request is processed, the value of X-Subject-Token in the response header is the token value.

-

No

-

This field is mandatory for token authentication.

-

The following is part of an example token:

-

MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ

-
-
-
-

In addition to supporting authentication using tokens, APIs support authentication using AK/SK, which uses SDKs to sign a request. During the signature, the Authorization (signature authentication) and X-Sdk-Date (time when a request is sent) headers are automatically added in the request.

-

For more details, see "Authentication Using AK/SK" in Authentication.

-
-

The API used to obtain a user tokenobtain a user token does not require authentication. Only the Content-Type field needs to be added to requests for calling the API. An example of such requests is as follows:

-
1
-2
POST https://{{endpoint}}/v3/auth/tokens
-Content-Type: application/json
-
-
-
-

(Optional) Request Body

This part is optional. The body of a request is often sent in a structured format (for example, JSON or XML) as specified in the Content-Type header field. The request body transfers content except the request header.

-

The request body varies between APIs. Some APIs do not require the request body, such as the APIs requested using the GET and DELETE methods.

-

In the case of the API used to obtain a user tokenobtain a user token, the request parameters and parameter description can be obtained from the API request. The following provides an example request with a body included. Replace username, domainname (domain), ******** (login password), and xxxxxxxxxxxxxxxxxx (project name) with the actual values. Obtain the project name from Regions and Endpoints"Regions and Endpoints".

-

If all data required for the API request is available, you can send the request to call the API through curl, Postman, or coding. In the response to the API used to obtain a user token, x-subject-token is the desired user token. This token can then be used to authenticate the calling of other APIs.

-
-
-
-
-
Parent topic: Calling APIs
-
-
- diff --git a/docs/ucs/api-ref/ucs_api_0009.html b/docs/ucs/api-ref/ucs_api_0009.html deleted file mode 100644 index 0f20c85b3..000000000 --- a/docs/ucs/api-ref/ucs_api_0009.html +++ /dev/null @@ -1,116 +0,0 @@ - - -

Authentication

-

Requests for calling an API can be authenticated using an AK/SK pair.

-

AK/SK Authentication

An AK/SK is used to verify the identity of a request sender. In AK/SK authentication, a signature needs to be obtained and then added to requests.

-

AK: access key ID, which is a unique identifier used together with an SK to sign requests cryptographically.

-

SK: secret access key, which is used together with an AK to sign requests cryptographically. It identifies a request sender and prevents the request from being modified.

-
-

The following demo shows how to sign a request and use an HTTP client to send an HTTPS request.

-

Download the demo at https://github.com/api-gate-way/SdkDemo.

-

If you do not need the demo project, visit the following URL to download the API Gateway signing SDK:

-

Request an API Gateway signing SDK from the enterprise administrator.

-

Decompress the downloaded package to obtain a JAR file. Add the decompressed JAR file to the dependency path, as shown below.

-
Figure 1 Adding the API Gateway signing SDK
-
  1. Generate an AK/SK. (If you already have an AK/SK file, skip this step and find it. Generally, the file name is credentials.csv.)

    1. Log in to the console.
    2. Click the username and select My Credentials from the drop-down list.
    1. In the navigation tree on the left, click Access Keys.
    2. Click Create Access Key. The Create Access Key dialog box is displayed.
    3. Click OK to download the AK/SK.

      Keep the AK/SK secure.

      -
      -
    -

  2. Download and decompress the demo code.
  3. Import the demo project into Eclipse.

    Figure 2 Selecting an existing project
    -
    Figure 3 Selecting the decompressed demo code
    -
    Figure 4 Example structure
    -

  4. Sign the request.

    The request signing method is integrated in the JAR files imported in 3. The request needs to be signed before it is sent. The signature will then be added as part of the HTTP header to the request.

    -

    The demo code is classified into three classes:

    -
    • AccessService: an abstract class that merges the GET, POST, PUT, and DELETE methods into the access method
    • Demo: an execution entry used to simulate the sending of GET, POST, PUT, and DELETE requests
    • AccessServiceImpl: access method implementation, which contains the code required for communication with API Gateway
    -
    1. Edit the main method in the Demo.java file and replace the bold text with actual values.

      If you use other methods such as POST, PUT, and DELETE, see the corresponding comment.

      -

      Specify region, serviceName, AK/SK, and URL with actual values. In this demo, the URLs for accessing VPC resources are used.

      -

      To obtain the project ID in the URLs, see Obtaining a Project ID.

      -

      To obtain the endpoint, see "Regions and Endpoints".

      -
       1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
-10
-11
-12
-13
-14
-15
-16
-17
-18
-19
-20
-21
-22
-23
-24
-25
-26
-27
-28
-29
-30
-31
-32
-33
-34
-35
-36
-37
-38
      //TODO: Replace region with the name of the region in which the service to be accessed is located. 
-private static final String region = "";
-
-//TODO: Replace vpc with the name of the service you want to access. For example, ecs, vpc, iam, and elb.
-private static final String serviceName = "";
-
-public static void main(String[] args) throws UnsupportedEncodingException
-{
-//TODO: Replace the AK and SK with those obtained on the My Credentials page.
-String ak = "ZIRRKMTWP******1WKNKB";
-String sk = "Us0mdMNHk******YrRCnW0ecfzl";
-
-//TODO: To specify a project ID (multi-project scenarios), add the X-Project-Id header.
-//TODO: To access a global service, such as IAM, DNS, CDN, and TMS, add the X-Domain-Id header to specify an account ID.
-//TODO: To add a header, find "Add special headers" in the AccessServiceImple.java file.
-
-//TODO: Test the API
-String url = "https://{Endpoint}/v1/{project_id}/vpcs";
-get(ak, sk, url);
-
-//TODO: When creating a VPC, replace {project_id} in postUrl with the actual value.
-//String postUrl = "https://serviceEndpoint/v1/{project_id}/cloudservers";
-//String postbody ="{\"vpc\": {\"name\": \"vpc\",\"cidr\": \"192.168.0.0/16\"}}";
-//post(ak, sk, postUrl, postbody);
-
-//TODO: When querying a VPC, replace {project_id} in url with the actual value.
-//String url = "https://serviceEndpoint/v1/{project_id}/vpcs/{vpc_id}";
-//get(ak, sk, url);
-
-//TODO: When updating a VPC, replace {project_id} and {vpc_id} in putUrl with the actual values.
-//String putUrl = "https://serviceEndpoint/v1/{project_id}/vpcs/{vpc_id}";
-//String putbody ="{\"vpc\":{\"name\": \"vpc1\",\"cidr\": \"192.168.0.0/16\"}}";
-//put(ak, sk, putUrl, putbody);
-
-//TODO: When deleting a VPC, replace {project_id} and {vpc_id} in deleteUrl with the actual values.
-//String deleteUrl = "https://serviceEndpoint/v1/{project_id}/vpcs/{vpc_id}";
-//delete(ak, sk, deleteUrl);
-}
-
      -
      -
    2. Compile and run the code to call an API.

      In the Package Explorer area on the left, right-click Demo.java and choose Run AS > Java Application from the shortcut menu to run the demo code.

      -

      You can view the API calling logs on the console.

      -
    -

-
-
-
-
-
Parent topic: Calling APIs
-
-
- diff --git a/docs/ucs/api-ref/ucs_api_0010.html b/docs/ucs/api-ref/ucs_api_0010.html deleted file mode 100644 index b0f8e31f5..000000000 --- a/docs/ucs/api-ref/ucs_api_0010.html +++ /dev/null @@ -1,59 +0,0 @@ - - -

Response

-

Status Code

After sending a request, you will receive a response, including a status code, response header, and response body.

-

A status code is a group of digits, ranging from 1xx to 5xx. It indicates the status of a request. For more information, see Status Codes.

-

For example, if status code 201 is returned for calling the API used to obtain a user token, the request is successful.

-
-

Response Header

Similar to a request, a response also has a header, for example, Content-Type.

-

Figure 1 shows the response header fields for the API used to obtain a user token. The X-Subject-Token header field is the desired user token. This token can then be used to authenticate the calling of other APIs.

-

For security purposes, you are advised to set the token in ciphertext in configuration files or environment variables and decrypt it when using it.

-
-
Figure 1 Header fields of the response to the request for obtaining a user token
-
-

(Optional) Response Body

The body of a response is often returned in structured format (for example, JSON or XML) as specified in the Content-Type header field. The response body transfers content except the response header.

-
-

The following shows part of the response body for the API used to obtain a user token.

-
 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
-10
-11
-12
{
-    "token": {
-        "expires_at": "2019-02-13T06:52:13.855000Z",
-        "methods": [
-            "password"
-        ],
-        "catalog": [
-            {
-                "endpoints": [
-                    {
-                        "region_id": "az-01",
-......
-
-
-

If an error occurs during API calling, an error code and a message will be displayed. The following shows an error response body.

-
1
-2
-3
-4
{
-    "error_msg": "The request message format is invalid.",
-    "error_code": "IMG.0001"
-}
-
-
-

In the response body, error_code is an error code, and error_msg provides information about the error.

-
-
-
-
Parent topic: Calling APIs
-
-
- diff --git a/docs/ucs/api-ref/ucs_api_0011.html b/docs/ucs/api-ref/ucs_api_0011.html deleted file mode 100644 index 1d674d785..000000000 --- a/docs/ucs/api-ref/ucs_api_0011.html +++ /dev/null @@ -1,13 +0,0 @@ - - -

API

-
-
- -
- diff --git a/docs/ucs/api-ref/ucs_api_0015.html b/docs/ucs/api-ref/ucs_api_0015.html deleted file mode 100644 index 12bf0388f..000000000 --- a/docs/ucs/api-ref/ucs_api_0015.html +++ /dev/null @@ -1,21 +0,0 @@ - - -

Appendix

-
-
- -
- diff --git a/docs/ucs/api-ref/ucs_api_0016.html b/docs/ucs/api-ref/ucs_api_0016.html deleted file mode 100644 index 07f290589..000000000 --- a/docs/ucs/api-ref/ucs_api_0016.html +++ /dev/null @@ -1,121 +0,0 @@ - - -

Status Codes

-
-
-
-
-
Parent topic: Appendix
-
-
- diff --git a/docs/ucs/api-ref/ucs_api_0018.html b/docs/ucs/api-ref/ucs_api_0018.html deleted file mode 100644 index 8f96efe42..000000000 --- a/docs/ucs/api-ref/ucs_api_0018.html +++ /dev/null @@ -1,46 +0,0 @@ - - -

Obtaining a Project ID

-

Scenarios

A project ID is required for some URLs when an API is called. Therefore, you need to obtain a project ID in advance. Two methods are available:

- -
-

Obtaining a Project ID by Calling an API

You can obtain the project ID by calling the IAM API used to query project information based on the specified criteria.

-

The API used to obtain a project ID is GET https://{Endpoint}/v3/projects. {Endpoint} is the IAM endpoint and can be obtained from the administratorRegions and Endpoints. For details about API authentication, see Authentication.

-

The following is an example response. The value of id is the project ID.

-
{
-    "projects": [
-        {
-            "domain_id": "65382450e8f64ac0870cd180d14e684b",
-            "is_domain": false,
-            "parent_id": "65382450e8f64ac0870cd180d14e684b",
-            "name": "project_name",
-            "description": "",
-            "links": {
-                "next": null,
-                "previous": null,
-                "self": "https://www.example.com/v3/projects/a4a5d4098fb4474fa22cd05f897d6b99"
-            },
-            "id": "a4a5d4098fb4474fa22cd05f897d6b99",
-            "enabled": true
-        }
-    ],
-    "links": {
-        "next": null,
-        "previous": null,
-        "self": "https://www.example.com/v3/projects"
-    }
-}
-
-

Obtaining a Project ID on the Console

A project ID needs to be specified in the URIs of some APIs. Therefore, you need to obtain the project ID before calling APIs. The following procedure describes how to obtain a project ID:
  1. Log in to the management console.
  2. Click the username and select My Credentials from the drop-down list.

    On the My Credentials page, view project IDs in the project list.

    -
    Figure 1 Viewing project IDs
    -

    In multi-project scenarios, expand the region, and obtain your sub-project ID from the Project ID column.

    -
-
-
-
-
-
-
Parent topic: Appendix
-
-
- diff --git a/docs/ucs/api-ref/ucs_api_0019.html b/docs/ucs/api-ref/ucs_api_0019.html deleted file mode 100644 index ea6636da3..000000000 --- a/docs/ucs/api-ref/ucs_api_0019.html +++ /dev/null @@ -1,13 +0,0 @@ - - -

Obtaining an Account ID

-

An account ID is required for some URLs when an API is called. To obtain the account ID, perform the following steps:

-
  1. Register an account and log in to the management console.
  2. Click the username and select My Credentials from the drop-down list.

    On the API Credentials page, view Account ID.

    -
-
-
-
-
Parent topic: Appendix
-
-
- diff --git a/docs/ucs/api-ref/ucs_api_0022.html b/docs/ucs/api-ref/ucs_api_0022.html deleted file mode 100644 index b4417b6a2..000000000 --- a/docs/ucs/api-ref/ucs_api_0022.html +++ /dev/null @@ -1,11 +0,0 @@ - - -

Country Codes

-
-
-
-
-
Parent topic: Appendix
-
-
- diff --git a/docs/ucs/api-ref/ucs_api_0024.html b/docs/ucs/api-ref/ucs_api_0024.html deleted file mode 100644 index 7157a85a4..000000000 --- a/docs/ucs/api-ref/ucs_api_0024.html +++ /dev/null @@ -1,66 +0,0 @@ - - -

Cluster Categories and Types

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Category

-

Type

-

Provider

-

Attached clusters

-

AKS clusters

-

Azure

-

EKS clusters

-

AWS

-

GKE clusters

-

Google Cloud

-

OpenShift clusters

-

OpenShift

-

Self-managed clusters

-

Private Kubernetes provider

-

Self-hosted clusters

-

Self

-

OTC clusters (self)

-

CCE standard clusters

-

OTC

-

CCE Turbo clusters

-

OTC

-
-
-
-
-
-
Parent topic: Appendix
-
-
-