[ { "desc":"Cloud APIs comply with the RESTful API design principles. REST-based web services are organized into resources. Each resource is identified by one or more Uniform Resourc", "product_code":"cce", "title":"API Usage Guidelines", "uri":"cce_02_0004.html", "doc_type":"api2", "p_code":"", "code":"1" }, { "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":"cce", "title":"APIs", "uri":"cce_02_0103.html", "doc_type":"api2", "p_code":"", "code":"2" }, { "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":"cce", "title":"API Version Query", "uri":"cce_02_0348.html", "doc_type":"api2", "p_code":"2", "code":"3" }, { "desc":"This API is used to query all available API versions.GET /N/AResponse parameters:Table 1 describes the response parameters.Example response:Table 3 describes the status c", "product_code":"cce", "title":"Querying All API Versions", "uri":"cce_02_0349.html", "doc_type":"api2", "p_code":"3", "code":"4" }, { "desc":"This API is used to query information about API v3.GET /v3N/AResponse parameters:Table 1 describes the response parameters.Example response:Table 2 describes the status c", "product_code":"cce", "title":"Querying Information About API v3", "uri":"cce_02_0350.html", "doc_type":"api2", "p_code":"3", "code":"5" }, { "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":"cce", "title":"Cluster Management", "uri":"cce_02_0092.html", "doc_type":"api2", "p_code":"2", "code":"6" }, { "desc":"This API is used to create an empty cluster, which has only master nodes but do not have worker nodes. After creating a cluster by calling this API, you can add nodes to ", "product_code":"cce", "title":"Creating a Cluster", "uri":"cce_02_0236.html", "doc_type":"api2", "p_code":"6", "code":"7" }, { "desc":"This API is used to obtain details about a specified cluster.GET /api/v3/projects/{project_id}/clusters/{cluster_id}Table 1 describes the parameters of this API.Request p", "product_code":"cce", "title":"Reading a Specified Cluster", "uri":"cce_02_0238.html", "doc_type":"api2", "p_code":"6", "code":"8" }, { "desc":"This API is used to obtain details about all clusters in a specified project.GET /api/v3/projects/{project_id}/clustersTable 1 describes the parameters of this API.Reques", "product_code":"cce", "title":"Listing Clusters in a Specified Project", "uri":"cce_02_0239.html", "doc_type":"api2", "p_code":"6", "code":"9" }, { "desc":"This API is used to update information about a specified cluster.PUT /api/v3/projects/{project_id}/clusters/{cluster_id}Table 1 describes the parameters of this API.Reque", "product_code":"cce", "title":"Updating a Specified Cluster", "uri":"cce_02_0240.html", "doc_type":"api2", "p_code":"6", "code":"10" }, { "desc":"This API is used to delete a specified cluster.The URL for cluster management is in the format of https://Endpoint/uri. In the URL, uri indicates the resource path, that ", "product_code":"cce", "title":"Deleting a Specified Cluster", "uri":"cce_02_0241.html", "doc_type":"api2", "p_code":"6", "code":"11" }, { "desc":"This API is used to hibernate a running cluster.After a cluster is hibernated, resources such as workloads cannot be created or managed in the cluster.POST /api/v3/projec", "product_code":"cce", "title":"Hibernating a Cluster", "uri":"cce_02_0374.html", "doc_type":"api2", "p_code":"6", "code":"12" }, { "desc":"This API is used to wake up a hibernated cluster.POST /api/v3/projects/{project_id}/clusters/{cluster_id}/operation/awakeNoneNoneNoneSee Error Codes.", "product_code":"cce", "title":"Waking Up a Cluster", "uri":"cce_02_0375.html", "doc_type":"api2", "p_code":"6", "code":"13" }, { "desc":"This API is used to obtain certificates of a specified cluster in form of kubeconfig file.POST /api/v3/projects/{project_id}/clusters/{cluster_id}/clustercertTable 1 desc", "product_code":"cce", "title":"Obtaining Cluster Certificates", "uri":"cce_02_0248.html", "doc_type":"api2", "p_code":"6", "code":"14" }, { "desc":"This API is used to obtain certificates of a specified cluster in form of kubeconfig file.GET /api/v3/projects/{project_id}/clusters/{cluster_id}/clustercertTable 1 descr", "product_code":"cce", "title":"Obtaining Cluster Certificates (Deprecated)", "uri":"cce_02_0359.html", "doc_type":"api2", "p_code":"6", "code":"15" }, { "desc":"This API is used to create a node in a specified cluster.POST /api/v3/projects/{project_id}/clusters/{cluster_id}/nodesTable 1 describes the parameters of the API.Request", "product_code":"cce", "title":"Creating a Node", "uri":"cce_02_0242.html", "doc_type":"api2", "p_code":"6", "code":"16" }, { "desc":"This API is used to obtain details about a node with a specified node ID.GET /api/v3/projects/{project_id}/clusters/{cluster_id}/nodes/{node_id}Table 1 describes the para", "product_code":"cce", "title":"Reading a Specified Node", "uri":"cce_02_0243.html", "doc_type":"api2", "p_code":"6", "code":"17" }, { "desc":"This API is used to obtain details about all nodes in a cluster with a specified cluster ID.GET /api/v3/projects/{project_id}/clusters/{cluster_id}/nodesTable 1 describes", "product_code":"cce", "title":"Listing All Nodes in a Cluster", "uri":"cce_02_0244.html", "doc_type":"api2", "p_code":"6", "code":"18" }, { "desc":"This API is used to update information about a specified node.PUT /api/v3/projects/{project_id}/clusters/{cluster_id}/nodes/{node_id}Table 1 describes the parameters of t", "product_code":"cce", "title":"Updating a Specified Node", "uri":"cce_02_0245.html", "doc_type":"api2", "p_code":"6", "code":"19" }, { "desc":"This API is used to delete a specified node.DELETE /api/v3/projects/{project_id}/clusters/{cluster_id}/nodes/{node_id}Table 1 describes the parameters of the API.Request ", "product_code":"cce", "title":"Deleting a Node", "uri":"cce_02_0246.html", "doc_type":"api2", "p_code":"6", "code":"20" }, { "desc":"This API is used to query the progress of a job with a specified job ID returned after a job request is issued.The URL for cluster management is in the format of https://", "product_code":"cce", "title":"Reading Job Progress", "uri":"cce_02_0247.html", "doc_type":"api2", "p_code":"6", "code":"21" }, { "desc":"This API is used to query the access information of a specified cluster.The URL for cluster management is in the format of https://Endpoint/uri. In the URL, uri indicates", "product_code":"cce", "title":"Querying the Access Information of a Specified Cluster", "uri":"cce_02_0347.html", "doc_type":"api2", "p_code":"6", "code":"22" }, { "desc":"This API is used to modify the access information of a specified cluster.PUT /api/v3/projects/{project_id}/clusters/{cluster_id}/mastereipTable 1 describes the parameters", "product_code":"cce", "title":"Modifying the Access Information of a Specified Cluster", "uri":"cce_02_0346.html", "doc_type":"api2", "p_code":"6", "code":"23" }, { "desc":"This API is used to accept a node into a specified cluster.The URL for cluster management is in the format of https://Endpoint/uri. In the URL, uri indicates the resource", "product_code":"cce", "title":"Accepting a Node", "uri":"AddNode.html", "doc_type":"api2", "p_code":"6", "code":"24" }, { "desc":"This API is used to reset a node in a specified cluster.The URL for cluster management is in the format of https://Endpoint/uri. In the URL, uri indicates the resource pa", "product_code":"cce", "title":"Resetting a Node", "uri":"ResetNode.html", "doc_type":"api2", "p_code":"6", "code":"25" }, { "desc":"This API is used to remove a node from a specified cluster.The URL for cluster management is in the format of https://Endpoint/uri. In the URL, uri indicates the resource", "product_code":"cce", "title":"Removing a Node", "uri":"RemoveNode.html", "doc_type":"api2", "p_code":"6", "code":"26" }, { "desc":"This API is used to migrate a node from a specified cluster to another cluster (both clusters must in the same VPC). Physical nodes of the ECS service in a CCE Turbo clus", "product_code":"cce", "title":"Migrating a Node", "uri":"MigrateNode.html", "doc_type":"api2", "p_code":"6", "code":"27" }, { "desc":"This API is used to create a node pool in a specified cluster.POST /api/v3/projects/{project_id}/clusters/{cluster_id}/nodepoolsTable 1 describes the parameters of the AP", "product_code":"cce", "title":"Creating a Node Pool", "uri":"cce_02_0354.html", "doc_type":"api2", "p_code":"6", "code":"28" }, { "desc":"This API is used to query a specified node pool.The URL for cluster management is in the format of https://Endpoint/uri. In the URL, uri indicates the resource path, that", "product_code":"cce", "title":"Querying a Specified Node Pool", "uri":"cce_02_0355.html", "doc_type":"api2", "p_code":"6", "code":"29" }, { "desc":"This API is used to update a specified node pool.The URL for cluster management is in the format of https://Endpoint/uri. In the URL, uri indicates the resource path, tha", "product_code":"cce", "title":"Updating a Specified Node Pool", "uri":"cce_02_0356.html", "doc_type":"api2", "p_code":"6", "code":"30" }, { "desc":"This API is used to obtain information about all node pools in a specified cluster.The URL for cluster management is in the format of https://Endpoint/uri. In the URL, ur", "product_code":"cce", "title":"Listing All Node Pools in a Specified Cluster", "uri":"cce_02_0269.html", "doc_type":"api2", "p_code":"6", "code":"31" }, { "desc":"This API is used to delete a specified node pool.The URL for cluster management is in the format of https://Endpoint/uri. In the URL, uri indicates the resource path, tha", "product_code":"cce", "title":"Deleting a Node Pool", "uri":"cce_02_0357.html", "doc_type":"api2", "p_code":"6", "code":"32" }, { "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":"cce", "title":"Add-on Management", "uri":"cce_02_0320.html", "doc_type":"api2", "p_code":"2", "code":"33" }, { "desc":"This API is used to install an add-on instance by using the add-on template. One or more instances will be created for the installed add-on.The URL for add-on management ", "product_code":"cce", "title":"Installing an Add-on Instance", "uri":"cce_02_0322.html", "doc_type":"api2", "p_code":"33", "code":"34" }, { "desc":"This API is used to query add-on information.The URL for add-on management is in the format of https://{clusterid}.Endpoint/uri. In the URL, {clusterid} indicates the clu", "product_code":"cce", "title":"Reading Add-on Templates", "uri":"cce_02_0321.html", "doc_type":"api2", "p_code":"33", "code":"35" }, { "desc":"This API is used to update an add-on instance.The URL for add-on management is in the format of https://{clusterid}.Endpoint/uri. In the URL, {clusterid} indicates the cl", "product_code":"cce", "title":"Updating an Add-on Instance", "uri":"cce_02_0323.html", "doc_type":"api2", "p_code":"33", "code":"36" }, { "desc":"This API is used to delete an add-on instance.The URL for add-on management is in the format of https://{clusterid}.Endpoint/uri. In the URL, {clusterid} indicates the cl", "product_code":"cce", "title":"Deleting an Add-on Instance", "uri":"cce_02_0324.html", "doc_type":"api2", "p_code":"33", "code":"37" }, { "desc":"This API is used to obtain details about an add-on instance.The URL for add-on management is in the format of https://{clusterid}.Endpoint/uri. In the URL, {clusterid} in", "product_code":"cce", "title":"Reading an Add-on Instance", "uri":"cce_02_0325.html", "doc_type":"api2", "p_code":"33", "code":"38" }, { "desc":"This API is used to list all add-on instances in the cluster.The URL for add-on management is in the format of https://{clusterid}.Endpoint/uri. In the URL, {clusterid} i", "product_code":"cce", "title":"Listing Add-on Instances", "uri":"cce_02_0326.html", "doc_type":"api2", "p_code":"33", "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":"cce", "title":"Quota Management", "uri":"quota_lifecycle_management.html", "doc_type":"api2", "p_code":"2", "code":"40" }, { "desc":"This API is used to query CCE resource quotas.GET /api/v3/projects/{project_id}/quotasStatus code: 200NoneStatus code: 200The resource quotas are obtained successfully.Se", "product_code":"cce", "title":"Querying Resource Quotas", "uri":"ShowQuotas.html", "doc_type":"api2", "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":"cce", "title":"Add-on Instance Parameters", "uri":"cce_02_0366.html", "doc_type":"api2", "p_code":"2", "code":"42" }, { "desc":"CoreDNS is a DNS server that uses chain plug-ins to provide domain name resolution services for Kubernetes clusters. It is the recommended DNS server solution by the Kube", "product_code":"cce", "title":"CoreDNS", "uri":"cce_02_0407.html", "doc_type":"api2", "p_code":"42", "code":"43" }, { "desc":"The CCE Container Storage (Everest) add-on uses the Container Storage Interface (CSI) to link Kubernetes clusters with cloud storage services.", "product_code":"cce", "title":"CCE Container Storage (Everest)", "uri":"cce_02_0408.html", "doc_type":"api2", "p_code":"42", "code":"44" }, { "desc":"CCE Node Problem Detector (node-problem-detector, NPD) is an add-on that monitors abnormal events of cluster nodes and connects to a third-party monitoring platform. It i", "product_code":"cce", "title":"CCE Node Problem Detector", "uri":"cce_02_0409.html", "doc_type":"api2", "p_code":"42", "code":"45" }, { "desc":"The CCE Cluster Autoscaler (autoscaler) add-on enables node pools to be scaled in or out.", "product_code":"cce", "title":"CCE Cluster Autoscaler", "uri":"cce_02_0411.html", "doc_type":"api2", "p_code":"42", "code":"46" }, { "desc":"The NGINX Ingress Controller add-on can automatically modify configurations when there are changes to pods in Services. This add-on uses Nginx's excellent stability, perf", "product_code":"cce", "title":"NGINX Ingress Controller", "uri":"cce_02_0412.html", "doc_type":"api2", "p_code":"42", "code":"47" }, { "desc":"From version 1.8 onwards, Kubernetes provides resource usage metrics, such as the container CPU and memory usage, through the Metrics API. These metrics can be directly a", "product_code":"cce", "title":"Kubernetes Metrics Server", "uri":"cce_02_0413.html", "doc_type":"api2", "p_code":"42", "code":"48" }, { "desc":"CCE Advanced HPA (cce-hpa-controller) is an in-house add-on, which can be used to flexibly scale in or out Deployments based on metrics such as CPU usage and memory usage", "product_code":"cce", "title":"CCE Advanced HPA", "uri":"cce_02_0414.html", "doc_type":"api2", "p_code":"42", "code":"49" }, { "desc":"CCE AI Suite (NVIDIA GPU) is a device management add-on that supports GPUs in containers. To use GPU nodes in a cluster, this add-on must be installed.", "product_code":"cce", "title":"CCE AI Suite (NVIDIA GPU)", "uri":"cce_02_0415.html", "doc_type":"api2", "p_code":"42", "code":"50" }, { "desc":"Volcano is a batch scheduling platform based on Kubernetes. It provides a series of features required by machine learning, deep learning, bioinformatics, genomics, and ot", "product_code":"cce", "title":"Volcano Scheduler", "uri":"cce_02_0417.html", "doc_type":"api2", "p_code":"42", "code":"51" }, { "desc":"The Cluster Native Cluster Monitoring add-on (kube-prometheus-stack) uses Prometheus-operator and Prometheus to provide easy-to-use, end-to-end Kubernetes cluster monitor", "product_code":"cce", "title":"Cloud Native Cluster Monitoring", "uri":"cce_02_0421.html", "doc_type":"api2", "p_code":"42", "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":"cce", "title":"Kubernetes APIs", "uri":"cce_02_0340.html", "doc_type":"api2", "p_code":"", "code":"53" }, { "desc":"Kubernetes APIs are resource-based (RESTful) programming interfaces provided through HTTP. It supports query, creation, update, and deletion of various cluster resources ", "product_code":"cce", "title":"Overview", "uri":"kubernetesapi.html", "doc_type":"api2", "p_code":"53", "code":"54" }, { "desc":"This chapter describes fine-grained permissions management for your CCE. If your cloud account does not need individual IAM users, then you may skip over this chapter.A p", "product_code":"cce", "title":"Permissions Policies and Supported Actions", "uri":"cce_02_0327.html", "doc_type":"api2", "p_code":"", "code":"55" }, { "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":"cce", "title":"Appendix", "uri":"cce_02_0083.html", "doc_type":"api2", "p_code":"", "code":"56" }, { "desc":"Kubernetes APIs use the HTTP header \"Content-Type\" to distinguish between patch request method operations.Currently, three types of patch request method operations are su", "product_code":"cce", "title":"Patch Request Method Operation Description", "uri":"cce_02_0085.html", "doc_type":"api2", "p_code":"56", "code":"57" }, { "desc":"This section provides examples of Merge Patch and Strategic Merge Patch method operations.By way of example, Merge Patch and Strategic Merge Patch method operations are p", "product_code":"cce", "title":"Patch Request Method Operation Example", "uri":"cce_02_0086.html", "doc_type":"api2", "p_code":"56", "code":"58" }, { "desc":"Table 1 describes the status codes.", "product_code":"cce", "title":"Status Code", "uri":"cce_02_0084.html", "doc_type":"api2", "p_code":"56", "code":"59" }, { "desc":"If an error occurs in API calling, no result is returned. Identify the cause based on the error code of each API. If an error occurs in API calling, HTTP status code 4xx ", "product_code":"cce", "title":"Error Codes", "uri":"cce_02_0250.html", "doc_type":"api2", "p_code":"56", "code":"60" }, { "desc":"You can obtain the project ID by calling the API used to query project information based on the specified criteria.The API used to obtain a project ID is GET https://{End", "product_code":"cce", "title":"Obtaining a Project ID", "uri":"cce_02_0341.html", "doc_type":"api2", "p_code":"56", "code":"61" }, { "desc":"An account ID is required for some URLs when an API is called. To obtain an account ID, perform the following operations:On the My Credentials page, view account IDs in t", "product_code":"cce", "title":"Obtaining the Account ID", "uri":"cce_02_0342.html", "doc_type":"api2", "p_code":"56", "code":"62" }, { "desc":"If you are using Google Chrome, press F12. On the pane displayed on the right, click the Network tab. Enter jobs in the Filter text box to filter the job list. Select a j", "product_code":"cce", "title":"How to Obtain Parameters in the API URI", "uri":"cce_02_0271.html", "doc_type":"api2", "p_code":"56", "code":"63" }, { "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":"cce", "title":"API Permissions", "uri":"cce_02_0272.html", "doc_type":"api2", "p_code":"56", "code":"64" }, { "desc":"To provide a secure and isolated network environment for CCE, create a VPC before creating a cluster.If you have already created a VPC, you do not need to create it again", "product_code":"cce", "title":"Creating a VPC and Subnet", "uri":"cce_02_0100.html", "doc_type":"api2", "p_code":"56", "code":"65" }, { "desc":"Create a key pair before you create a container cluster. Key pairs are used for user identity authentication upon login to a node.If you have already created a key pair, ", "product_code":"cce", "title":"Creating a Key Pair", "uri":"cce_02_0101.html", "doc_type":"api2", "p_code":"56", "code":"66" }, { "desc":"Different regions support different node flavors, and node flavors may be changed. You are advised to log in to the CCE console and check whether the required node flavor", "product_code":"cce", "title":"Node Flavor Description", "uri":"cce_02_0368.html", "doc_type":"api2", "p_code":"56", "code":"67" }, { "desc":"In disk planning and striped logical disk creation, it is difficult for users to flexibly attach and partition disks when creating a node.During node creation, the storag", "product_code":"cce", "title":"Attaching Disks to a Node", "uri":"node_storage_example.html", "doc_type":"api2", "p_code":"56", "code":"68" }, { "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":"cce", "title":"Change History", "uri":"cce_02_0273.html", "doc_type":"api2", "p_code":"", "code":"69" } ]