From 5d711fd34ae48aa19f96c9b42d8c7e7c63fd180c Mon Sep 17 00:00:00 2001 From: qiujiandong1 Date: Thu, 17 Jul 2025 10:46:59 +0000 Subject: [PATCH] CCE API 20250311 version Reviewed-by: Eotvos, Oliver Co-authored-by: qiujiandong1 Co-committed-by: qiujiandong1 --- docs/cce/api-ref/ALL_META.TXT.json | 264 ++++++--- docs/cce/api-ref/AddNode.html | 4 +- docs/cce/api-ref/CLASS.TXT.json | 289 +++++---- docs/cce/api-ref/ResetNode.html | 4 +- docs/cce/api-ref/ResizeCluster.html | 239 ++++++++ .../ShowClusterConfigurationDetails.html | 225 +++++++ .../ShowNodePoolConfigurationDetails.html | 241 ++++++++ .../api-ref/ShowNodePoolConfigurations.html | 346 +++++++++++ .../api-ref/UpdateNodePoolConfiguration.html | 554 ++++++++++++++++++ docs/cce/api-ref/cce_02_0092.html | 2 + docs/cce/api-ref/cce_02_0103.html | 2 + docs/cce/api-ref/cce_02_0236.html | 237 +++++++- docs/cce/api-ref/cce_02_0238.html | 168 ++++-- docs/cce/api-ref/cce_02_0242.html | 138 ++--- docs/cce/api-ref/cce_02_0243.html | 2 +- docs/cce/api-ref/cce_02_0244.html | 64 +- docs/cce/api-ref/cce_02_0246.html | 64 +- docs/cce/api-ref/cce_02_0269.html | 4 +- docs/cce/api-ref/cce_02_0273.html | 53 +- docs/cce/api-ref/cce_02_0322.html | 2 +- docs/cce/api-ref/cce_02_0323.html | 2 +- docs/cce/api-ref/cce_02_0354.html | 138 ++--- docs/cce/api-ref/cce_02_0355.html | 68 +-- docs/cce/api-ref/cce_02_0356.html | 66 +-- docs/cce/api-ref/cce_02_0357.html | 68 +-- docs/cce/api-ref/cce_02_0366.html | 2 + docs/cce/api-ref/cce_02_0422.html | 418 +++++++++++++ .../configuration_lifecycle_management.html | 22 + 28 files changed, 3118 insertions(+), 568 deletions(-) create mode 100644 docs/cce/api-ref/ResizeCluster.html create mode 100644 docs/cce/api-ref/ShowClusterConfigurationDetails.html create mode 100644 docs/cce/api-ref/ShowNodePoolConfigurationDetails.html create mode 100644 docs/cce/api-ref/ShowNodePoolConfigurations.html create mode 100644 docs/cce/api-ref/UpdateNodePoolConfiguration.html create mode 100644 docs/cce/api-ref/cce_02_0422.html create mode 100644 docs/cce/api-ref/configuration_lifecycle_management.html diff --git a/docs/cce/api-ref/ALL_META.TXT.json b/docs/cce/api-ref/ALL_META.TXT.json index 69faad5c7..083d40b2b 100644 --- a/docs/cce/api-ref/ALL_META.TXT.json +++ b/docs/cce/api-ref/ALL_META.TXT.json @@ -272,11 +272,29 @@ "title":"Obtaining Cluster Certificates (Deprecated)", "githuburl":"" }, + { + "uri":"ResizeCluster.html", + "node_id":"resizecluster.xml", + "product_code":"cce", + "code":"16", + "des":"This API is used to modify the specifications of a cluster.The URL for cluster management is in the format of https://Endpoint/uri, in which uri indicates the resource pa", + "doc_type":"api2", + "kw":"Modifying Cluster Specifications,Cluster Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api2", + "prodname":"cce" + } + ], + "title":"Modifying Cluster Specifications", + "githuburl":"" + }, { "uri":"cce_02_0242.html", "node_id":"cce_02_0242.xml", "product_code":"cce", - "code":"16", + "code":"17", "des":"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", "doc_type":"api2", "kw":"Creating a Node,Cluster Management,API Reference", @@ -294,7 +312,7 @@ "uri":"cce_02_0243.html", "node_id":"cce_02_0243.xml", "product_code":"cce", - "code":"17", + "code":"18", "des":"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", "doc_type":"api2", "kw":"Reading a Specified Node,Cluster Management,API Reference", @@ -312,7 +330,7 @@ "uri":"cce_02_0244.html", "node_id":"cce_02_0244.xml", "product_code":"cce", - "code":"18", + "code":"19", "des":"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", "doc_type":"api2", "kw":"Listing All Nodes in a Cluster,Cluster Management,API Reference", @@ -330,7 +348,7 @@ "uri":"cce_02_0245.html", "node_id":"cce_02_0245.xml", "product_code":"cce", - "code":"19", + "code":"20", "des":"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", "doc_type":"api2", "kw":"Updating a Specified Node,Cluster Management,API Reference", @@ -348,7 +366,7 @@ "uri":"cce_02_0246.html", "node_id":"cce_02_0246.xml", "product_code":"cce", - "code":"20", + "code":"21", "des":"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 ", "doc_type":"api2", "kw":"Deleting a Node,Cluster Management,API Reference", @@ -366,7 +384,7 @@ "uri":"cce_02_0247.html", "node_id":"cce_02_0247.xml", "product_code":"cce", - "code":"21", + "code":"22", "des":"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://", "doc_type":"api2", "kw":"Reading Job Progress,Cluster Management,API Reference", @@ -384,7 +402,7 @@ "uri":"cce_02_0347.html", "node_id":"cce_02_0347.xml", "product_code":"cce", - "code":"22", + "code":"23", "des":"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", "doc_type":"api2", "kw":"Querying the Access Information of a Specified Cluster,Cluster Management,API Reference", @@ -402,7 +420,7 @@ "uri":"cce_02_0346.html", "node_id":"cce_02_0346.xml", "product_code":"cce", - "code":"23", + "code":"24", "des":"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", "doc_type":"api2", "kw":"Modifying the Access Information of a Specified Cluster,Cluster Management,API Reference", @@ -420,7 +438,7 @@ "uri":"AddNode.html", "node_id":"addnode.xml", "product_code":"cce", - "code":"24", + "code":"25", "des":"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", "doc_type":"api2", "kw":"Accepting a Node,Cluster Management,API Reference", @@ -438,7 +456,7 @@ "uri":"ResetNode.html", "node_id":"resetnode.xml", "product_code":"cce", - "code":"25", + "code":"26", "des":"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", "doc_type":"api2", "kw":"Resetting a Node,Cluster Management,API Reference", @@ -456,7 +474,7 @@ "uri":"RemoveNode.html", "node_id":"removenode.xml", "product_code":"cce", - "code":"26", + "code":"27", "des":"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", "doc_type":"api2", "kw":"Removing a Node,Cluster Management,API Reference", @@ -474,7 +492,7 @@ "uri":"MigrateNode.html", "node_id":"migratenode.xml", "product_code":"cce", - "code":"27", + "code":"28", "des":"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", "doc_type":"api2", "kw":"Migrating a Node,Cluster Management,API Reference", @@ -492,7 +510,7 @@ "uri":"cce_02_0354.html", "node_id":"cce_02_0354.xml", "product_code":"cce", - "code":"28", + "code":"29", "des":"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", "doc_type":"api2", "kw":"Creating a Node Pool,Cluster Management,API Reference", @@ -510,7 +528,7 @@ "uri":"cce_02_0355.html", "node_id":"cce_02_0355.xml", "product_code":"cce", - "code":"29", + "code":"30", "des":"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", "doc_type":"api2", "kw":"Querying a Specified Node Pool,Cluster Management,API Reference", @@ -528,7 +546,7 @@ "uri":"cce_02_0356.html", "node_id":"cce_02_0356.xml", "product_code":"cce", - "code":"30", + "code":"31", "des":"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", "doc_type":"api2", "kw":"Updating a Specified Node Pool,Cluster Management,API Reference", @@ -546,7 +564,7 @@ "uri":"cce_02_0269.html", "node_id":"cce_02_0269.xml", "product_code":"cce", - "code":"31", + "code":"32", "des":"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", "doc_type":"api2", "kw":"Listing All Node Pools in a Specified Cluster,Cluster Management,API Reference", @@ -564,7 +582,7 @@ "uri":"cce_02_0357.html", "node_id":"cce_02_0357.xml", "product_code":"cce", - "code":"32", + "code":"33", "des":"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", "doc_type":"api2", "kw":"Deleting a Node Pool,Cluster Management,API Reference", @@ -582,7 +600,7 @@ "uri":"cce_02_0320.html", "node_id":"cce_02_0320.xml", "product_code":"cce", - "code":"33", + "code":"34", "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":"api2", "kw":"Add-on Management", @@ -600,7 +618,7 @@ "uri":"cce_02_0322.html", "node_id":"cce_02_0322.xml", "product_code":"cce", - "code":"34", + "code":"35", "des":"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 ", "doc_type":"api2", "kw":"Installing an Add-on Instance,Add-on Management,API Reference", @@ -618,7 +636,7 @@ "uri":"cce_02_0321.html", "node_id":"cce_02_0321.xml", "product_code":"cce", - "code":"35", + "code":"36", "des":"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", "doc_type":"api2", "kw":"Reading Add-on Templates,Add-on Management,API Reference", @@ -636,7 +654,7 @@ "uri":"cce_02_0323.html", "node_id":"cce_02_0323.xml", "product_code":"cce", - "code":"36", + "code":"37", "des":"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", "doc_type":"api2", "kw":"Updating an Add-on Instance,Add-on Management,API Reference", @@ -654,7 +672,7 @@ "uri":"cce_02_0324.html", "node_id":"cce_02_0324.xml", "product_code":"cce", - "code":"37", + "code":"38", "des":"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", "doc_type":"api2", "kw":"Deleting an Add-on Instance,Add-on Management,API Reference", @@ -672,7 +690,7 @@ "uri":"cce_02_0325.html", "node_id":"cce_02_0325.xml", "product_code":"cce", - "code":"38", + "code":"39", "des":"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", "doc_type":"api2", "kw":"Reading an Add-on Instance,Add-on Management,API Reference", @@ -690,7 +708,7 @@ "uri":"cce_02_0326.html", "node_id":"cce_02_0326.xml", "product_code":"cce", - "code":"39", + "code":"40", "des":"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", "doc_type":"api2", "kw":"Listing Add-on Instances,Add-on Management,API Reference", @@ -708,7 +726,7 @@ "uri":"quota_lifecycle_management.html", "node_id":"quota_lifecycle_management.xml", "product_code":"cce", - "code":"40", + "code":"41", "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":"api2", "kw":"Quota Management", @@ -726,7 +744,7 @@ "uri":"ShowQuotas.html", "node_id":"showquotas.xml", "product_code":"cce", - "code":"41", + "code":"42", "des":"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", "doc_type":"api2", "kw":"Querying Resource Quotas,Quota Management,API Reference", @@ -744,7 +762,7 @@ "uri":"chart_lifecycle_management.html", "node_id":"chart_lifecycle_management.xml", "product_code":"cce", - "code":"42", + "code":"43", "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":"api2", "kw":"Chart Management", @@ -762,7 +780,7 @@ "uri":"UploadChart.html", "node_id":"uploadchart.xml", "product_code":"cce", - "code":"43", + "code":"44", "des":"This API is used to upload a chart.POST /v2/chartsStatus code: 201If the FormDataparameter exists, the value of Content-Typemust be multipart/form-data, and the file path", "doc_type":"api2", "kw":"Uploading a Chart,Chart Management,API Reference", @@ -780,7 +798,7 @@ "uri":"ListCharts.html", "node_id":"listcharts.xml", "product_code":"cce", - "code":"44", + "code":"45", "des":"This API is used to obtain the chart list.GET /v2/chartsStatus code: 200NoneStatus code: 200OKSee Error Codes.", "doc_type":"api2", "kw":"Obtaining a Chart List,Chart Management,API Reference", @@ -798,7 +816,7 @@ "uri":"ListReleases.html", "node_id":"listreleases.xml", "product_code":"cce", - "code":"45", + "code":"46", "des":"This API is used to obtain a release list.GET /cce/cam/v3/clusters/{cluster_id}/releasesStatus code: 200NoneStatus code: 200OKSee Error Codes.", "doc_type":"api2", "kw":"Obtaining a Release List,Chart Management,API Reference", @@ -816,7 +834,7 @@ "uri":"UpdateChart.html", "node_id":"updatechart.xml", "product_code":"cce", - "code":"46", + "code":"47", "des":"This API is used to update a chart.PUT /v2/charts/{chart_id}Status code: 200If the FormDataparameter exists, the value of Content-Typemust be multipart/form-data, and the", "doc_type":"api2", "kw":"Updating a Chart,Chart Management,API Reference", @@ -834,7 +852,7 @@ "uri":"CreateRelease.html", "node_id":"createrelease.xml", "product_code":"cce", - "code":"47", + "code":"48", "des":"This API is used to create a release.POST /cce/cam/v3/clusters/{cluster_id}/releasesStatus code: 201Status code: 201CreatedSee Error Codes.", "doc_type":"api2", "kw":"Creating a Release,Chart Management,API Reference", @@ -852,7 +870,7 @@ "uri":"DeleteChart.html", "node_id":"deletechart.xml", "product_code":"cce", - "code":"48", + "code":"49", "des":"This API is used to delete a chart.DELETE /v2/charts/{chart_id}Status code: 200NoneStatus code: 200OKSee Error Codes.", "doc_type":"api2", "kw":"Deleting a Chart,Chart Management,API Reference", @@ -870,7 +888,7 @@ "uri":"UpdateRelease.html", "node_id":"updaterelease.xml", "product_code":"cce", - "code":"49", + "code":"50", "des":"This API is used to update a release.PUT /cce/cam/v3/clusters/{cluster_id}/namespace/{namespace}/releases/{name}Status code: 200Status code: 200OKSee Error Codes.", "doc_type":"api2", "kw":"Updating a Release,Chart Management,API Reference", @@ -888,7 +906,7 @@ "uri":"ShowChart.html", "node_id":"showchart.xml", "product_code":"cce", - "code":"50", + "code":"51", "des":"This API is used to obtain a chart.GET /v2/charts/{chart_id}Status code: 200NoneStatus code: 200OKSee Error Codes.", "doc_type":"api2", "kw":"Obtaining a Chart,Chart Management,API Reference", @@ -906,7 +924,7 @@ "uri":"DeleteRelease.html", "node_id":"deleterelease.xml", "product_code":"cce", - "code":"51", + "code":"52", "des":"This API is used to delete a release.DELETE /cce/cam/v3/clusters/{cluster_id}/namespace/{namespace}/releases/{name}Status code: 200NoneStatus code: 200OKSee Error Codes.", "doc_type":"api2", "kw":"Deleting a Release,Chart Management,API Reference", @@ -924,7 +942,7 @@ "uri":"DownloadChart.html", "node_id":"downloadchart.xml", "product_code":"cce", - "code":"52", + "code":"53", "des":"This API is used to download a chart.GET /v2/charts/{chart_id}/archiveStatus code: 200NoneStatus code: 200OKSee Error Codes.", "doc_type":"api2", "kw":"Downloading a Chart,Chart Management,API Reference", @@ -942,7 +960,7 @@ "uri":"ShowRelease.html", "node_id":"showrelease.xml", "product_code":"cce", - "code":"53", + "code":"54", "des":"This API is used to obtain a release.GET /cce/cam/v3/clusters/{cluster_id}/namespace/{namespace}/releases/{name}Status code: 200NoneStatus code: 200OKSee Error Codes.", "doc_type":"api2", "kw":"Obtaining a Release,Chart Management,API Reference", @@ -960,7 +978,7 @@ "uri":"ShowChartValues.html", "node_id":"showchartvalues.xml", "product_code":"cce", - "code":"54", + "code":"55", "des":"This API is used to obtain chart values.GET /v2/charts/{chart_id}/valuesStatus code: 200NoneStatus code: 200OKSee Error Codes.", "doc_type":"api2", "kw":"Obtaining Chart Values,Chart Management,API Reference", @@ -978,7 +996,7 @@ "uri":"ShowReleaseHistory.html", "node_id":"showreleasehistory.xml", "product_code":"cce", - "code":"55", + "code":"56", "des":"This API is used to obtain historical records of a release.GET /cce/cam/v3/clusters/{cluster_id}/namespace/{namespace}/releases/{name}/historyStatus code: 200NoneStatus c", "doc_type":"api2", "kw":"Obtaining Historical Records of a Release,Chart Management,API Reference", @@ -996,7 +1014,7 @@ "uri":"ShowUserChartsQuotas.html", "node_id":"showuserchartsquotas.xml", "product_code":"cce", - "code":"56", + "code":"57", "des":"This API is used to obtain the quota of a user chart.GET /v2/charts/{project_id}/quotasStatus code: 200NoneStatus code: 200OKSee Error Codes.", "doc_type":"api2", "kw":"Obtaining the Quota of a User Chart,Chart Management,API Reference", @@ -1010,11 +1028,101 @@ "title":"Obtaining the Quota of a User Chart", "githuburl":"" }, + { + "uri":"configuration_lifecycle_management.html", + "node_id":"configuration_lifecycle_management.xml", + "product_code":"cce", + "code":"58", + "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":"api2", + "kw":"Configuration Management", + "search_title":"", + "metedata":[ + { + "documenttype":"api2", + "prodname":"cce" + } + ], + "title":"Configuration Management", + "githuburl":"" + }, + { + "uri":"ShowNodePoolConfigurationDetails.html", + "node_id":"shownodepoolconfigurationdetails.xml", + "product_code":"cce", + "code":"59", + "des":"This API is used to obtain the list of parameters that can be configured for a CCE node pool.GET /api/v3/projects/{project_id}/clusters/{cluster_id}/nodepools/{nodepool_i", + "doc_type":"api2", + "kw":"Obtaining the List of Parameters That Can Be Configured for a Node Pool,Configuration Management,API", + "search_title":"", + "metedata":[ + { + "documenttype":"api2", + "prodname":"cce" + } + ], + "title":"Obtaining the List of Parameters That Can Be Configured for a Node Pool", + "githuburl":"" + }, + { + "uri":"ShowClusterConfigurationDetails.html", + "node_id":"showclusterconfigurationdetails.xml", + "product_code":"cce", + "code":"60", + "des":"This API is used to obtain the list of parameters that can be configured for a CCE cluster.GET /api/v3/projects/{project_id}/clusters/{cluster_id}/configuration/detailSta", + "doc_type":"api2", + "kw":"Obtaining the List of Parameters That Can Be Configured for a Cluster,Configuration Management,API R", + "search_title":"", + "metedata":[ + { + "documenttype":"api2", + "prodname":"cce" + } + ], + "title":"Obtaining the List of Parameters That Can Be Configured for a Cluster", + "githuburl":"" + }, + { + "uri":"ShowNodePoolConfigurations.html", + "node_id":"shownodepoolconfigurations.xml", + "product_code":"cce", + "code":"61", + "des":"This API is used to obtain the parameters that can be configured for a node pool.GET /api/v3/projects/{project_id}/clusters/{cluster_id}/nodepools/{nodepool_id}/configura", + "doc_type":"api2", + "kw":"Obtaining the Parameters That Can Be Configured for a Node Pool,Configuration Management,API Referen", + "search_title":"", + "metedata":[ + { + "documenttype":"api2", + "prodname":"cce" + } + ], + "title":"Obtaining the Parameters That Can Be Configured for a Node Pool", + "githuburl":"" + }, + { + "uri":"UpdateNodePoolConfiguration.html", + "node_id":"updatenodepoolconfiguration.xml", + "product_code":"cce", + "code":"62", + "des":"This API is used to change the values of parameter configurations of a node pool in the CCE cluster.PUT /api/v3/projects/{project_id}/clusters/{cluster_id}/nodepools/{nod", + "doc_type":"api2", + "kw":"Changing the Values of Configuration Parameters of a Node Pool,Configuration Management,API Referenc", + "search_title":"", + "metedata":[ + { + "documenttype":"api2", + "prodname":"cce" + } + ], + "title":"Changing the Values of Configuration Parameters of a Node Pool", + "githuburl":"" + }, { "uri":"cce_02_0366.html", "node_id":"cce_02_0366.xml", "product_code":"cce", - "code":"57", + "code":"63", "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":"api2", "kw":"Add-on Instance Parameters", @@ -1032,7 +1140,7 @@ "uri":"cce_02_0407.html", "node_id":"cce_02_0407.xml", "product_code":"cce", - "code":"58", + "code":"64", "des":"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", "doc_type":"api2", "kw":"CoreDNS,Add-on Instance Parameters,API Reference", @@ -1050,7 +1158,7 @@ "uri":"cce_02_0408.html", "node_id":"cce_02_0408.xml", "product_code":"cce", - "code":"59", + "code":"65", "des":"The CCE Container Storage (Everest) add-on uses the Container Storage Interface (CSI) to link Kubernetes clusters with cloud storage services.", "doc_type":"api2", "kw":"CCE Container Storage (Everest),Add-on Instance Parameters,API Reference", @@ -1068,7 +1176,7 @@ "uri":"cce_02_0409.html", "node_id":"cce_02_0409.xml", "product_code":"cce", - "code":"60", + "code":"66", "des":"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", "doc_type":"api2", "kw":"CCE Node Problem Detector,Add-on Instance Parameters,API Reference", @@ -1086,7 +1194,7 @@ "uri":"cce_02_0411.html", "node_id":"cce_02_0411.xml", "product_code":"cce", - "code":"61", + "code":"67", "des":"The CCE Cluster Autoscaler (autoscaler) add-on enables node pools to be scaled in or out.", "doc_type":"api2", "kw":"CCE Cluster Autoscaler,Add-on Instance Parameters,API Reference", @@ -1104,7 +1212,7 @@ "uri":"cce_02_0412.html", "node_id":"cce_02_0412.xml", "product_code":"cce", - "code":"62", + "code":"68", "des":"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", "doc_type":"api2", "kw":"NGINX Ingress Controller,Add-on Instance Parameters,API Reference", @@ -1122,7 +1230,7 @@ "uri":"cce_02_0413.html", "node_id":"cce_02_0413.xml", "product_code":"cce", - "code":"63", + "code":"69", "des":"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", "doc_type":"api2", "kw":"Kubernetes Metrics Server,Add-on Instance Parameters,API Reference", @@ -1140,7 +1248,7 @@ "uri":"cce_02_0414.html", "node_id":"cce_02_0414.xml", "product_code":"cce", - "code":"64", + "code":"70", "des":"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", "doc_type":"api2", "kw":"CCE Advanced HPA,Add-on Instance Parameters,API Reference", @@ -1158,7 +1266,7 @@ "uri":"cce_02_0415.html", "node_id":"cce_02_0415.xml", "product_code":"cce", - "code":"65", + "code":"71", "des":"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.", "doc_type":"api2", "kw":"CCE AI Suite (NVIDIA GPU),Add-on Instance Parameters,API Reference", @@ -1176,7 +1284,7 @@ "uri":"cce_02_0417.html", "node_id":"cce_02_0417.xml", "product_code":"cce", - "code":"66", + "code":"72", "des":"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", "doc_type":"api2", "kw":"Volcano Scheduler,Add-on Instance Parameters,API Reference", @@ -1194,7 +1302,7 @@ "uri":"cce_02_0421.html", "node_id":"cce_02_0421.xml", "product_code":"cce", - "code":"67", + "code":"73", "des":"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", "doc_type":"api2", "kw":"Cloud Native Cluster Monitoring,Add-on Instance Parameters,API Reference", @@ -1208,11 +1316,29 @@ "title":"Cloud Native Cluster Monitoring", "githuburl":"" }, + { + "uri":"cce_02_0422.html", + "node_id":"cce_02_0422.xml", + "product_code":"cce", + "code":"74", + "des":"The Cloud Native Logging add-on (log-agent) is developed based on Fluent Bit and OpenTelemetry for collecting logs and Kubernetes events. This add-on supports CRD-based l", + "doc_type":"api2", + "kw":"Cloud Native Log Collection,Add-on Instance Parameters,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api2", + "prodname":"cce" + } + ], + "title":"Cloud Native Log Collection", + "githuburl":"" + }, { "uri":"cce_02_0340.html", "node_id":"cce_02_0340.xml", "product_code":"cce", - "code":"68", + "code":"75", "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":"api2", "kw":"Kubernetes APIs", @@ -1230,7 +1356,7 @@ "uri":"kubernetesapi.html", "node_id":"kubernetesapi.xml", "product_code":"cce", - "code":"69", + "code":"76", "des":"Kubernetes APIs are resource-based (RESTful) programming interfaces provided through HTTP. It supports query, creation, update, and deletion of various cluster resources ", "doc_type":"api2", "kw":"Overview,Kubernetes APIs,API Reference", @@ -1248,7 +1374,7 @@ "uri":"cce_02_0327.html", "node_id":"cce_02_0327.xml", "product_code":"cce", - "code":"70", + "code":"77", "des":"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", "doc_type":"api2", "kw":"Permissions Policies and Supported Actions,API Reference", @@ -1266,7 +1392,7 @@ "uri":"cce_02_0083.html", "node_id":"cce_02_0083.xml", "product_code":"cce", - "code":"71", + "code":"78", "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":"api2", "kw":"Appendix", @@ -1284,7 +1410,7 @@ "uri":"cce_02_0085.html", "node_id":"cce_02_0085.xml", "product_code":"cce", - "code":"72", + "code":"79", "des":"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", "doc_type":"api2", "kw":"Patch Request Method Operation Description,Appendix,API Reference", @@ -1302,7 +1428,7 @@ "uri":"cce_02_0086.html", "node_id":"cce_02_0086.xml", "product_code":"cce", - "code":"73", + "code":"80", "des":"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", "doc_type":"api2", "kw":"Patch Request Method Operation Example,Appendix,API Reference", @@ -1320,7 +1446,7 @@ "uri":"cce_02_0084.html", "node_id":"cce_02_0084.xml", "product_code":"cce", - "code":"74", + "code":"81", "des":"Table 1 describes the status codes.", "doc_type":"api2", "kw":"Status Code,Appendix,API Reference", @@ -1338,7 +1464,7 @@ "uri":"cce_02_0250.html", "node_id":"cce_02_0250.xml", "product_code":"cce", - "code":"75", + "code":"82", "des":"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 ", "doc_type":"api2", "kw":"Error Codes,Appendix,API Reference", @@ -1356,7 +1482,7 @@ "uri":"cce_02_0341.html", "node_id":"cce_02_0341.xml", "product_code":"cce", - "code":"76", + "code":"83", "des":"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", "doc_type":"api2", "kw":"Obtaining a Project ID,Appendix,API Reference", @@ -1374,7 +1500,7 @@ "uri":"cce_02_0342.html", "node_id":"cce_02_0342.xml", "product_code":"cce", - "code":"77", + "code":"84", "des":"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", "doc_type":"api2", "kw":"Obtaining the Account ID,Appendix,API Reference", @@ -1392,7 +1518,7 @@ "uri":"cce_02_0271.html", "node_id":"cce_02_0271.xml", "product_code":"cce", - "code":"78", + "code":"85", "des":"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", "doc_type":"api2", "kw":"How to Obtain Parameters in the API URI,Appendix,API Reference", @@ -1410,7 +1536,7 @@ "uri":"cce_02_0272.html", "node_id":"cce_02_0272.xml", "product_code":"cce", - "code":"79", + "code":"86", "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":"api2", "kw":"API Permissions,Appendix,API Reference", @@ -1428,7 +1554,7 @@ "uri":"cce_02_0100.html", "node_id":"cce_02_0100.xml", "product_code":"cce", - "code":"80", + "code":"87", "des":"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", "doc_type":"api2", "kw":"Creating a VPC and Subnet,Appendix,API Reference", @@ -1446,7 +1572,7 @@ "uri":"cce_02_0101.html", "node_id":"cce_02_0101.xml", "product_code":"cce", - "code":"81", + "code":"88", "des":"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, ", "doc_type":"api2", "kw":"Creating a Key Pair,Appendix,API Reference", @@ -1464,7 +1590,7 @@ "uri":"cce_02_0368.html", "node_id":"cce_02_0368.xml", "product_code":"cce", - "code":"82", + "code":"89", "des":"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", "doc_type":"api2", "kw":"Node Flavor Description,Appendix,API Reference", @@ -1482,7 +1608,7 @@ "uri":"node_storage_example.html", "node_id":"node_storage_example.xml", "product_code":"cce", - "code":"83", + "code":"90", "des":"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", "doc_type":"api2", "kw":"Attaching Disks to a Node,Appendix,API Reference", @@ -1500,7 +1626,7 @@ "uri":"cce_02_0273.html", "node_id":"cce_02_0273.xml", "product_code":"cce", - "code":"84", + "code":"91", "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":"api2", "kw":"Change History,API Reference", diff --git a/docs/cce/api-ref/AddNode.html b/docs/cce/api-ref/AddNode.html index b8e979e1f..ae5b71957 100644 --- a/docs/cce/api-ref/AddNode.html +++ b/docs/cce/api-ref/AddNode.html @@ -340,6 +340,7 @@

String

Key of the cloud server label. The value cannot start with CCE- or __type_baremetal.

+

Only uppercase letters, lowercase letters, digits, special characters (-_@), and Unicode characters (\u4E00-\u9FA5) are supported. It can contain a maximum of 36 characters. The key cannot be empty.

value

@@ -349,6 +350,7 @@

String

Value of the cloud server label.

+

Only uppercase letters, lowercase letters, digits, special characters (-_@), and Unicode characters (\u4E00-\u9FA5) are supported. It can contain a maximum of 43 characters. The value can be empty.

@@ -526,7 +528,7 @@

String

EVS disk type.

-
  • SATA: common I/O
  • SAS: high I/O
  • SSD: ultra-high I/O
  • GPSSD: general-purpose SSD
  • ESSD: extreme SSD
+
  • SAS: high I/O
  • SSD: ultra-high I/O
  • GPSSD: general-purpose SSD
  • ESSD: extreme SSD

metadataEncrypted

diff --git a/docs/cce/api-ref/CLASS.TXT.json b/docs/cce/api-ref/CLASS.TXT.json index 5f2fc7f4b..63f902fb7 100644 --- a/docs/cce/api-ref/CLASS.TXT.json +++ b/docs/cce/api-ref/CLASS.TXT.json @@ -134,6 +134,15 @@ "p_code":"6", "code":"15" }, + { + "desc":"This API is used to modify the specifications of a cluster.The URL for cluster management is in the format of https://Endpoint/uri, in which uri indicates the resource pa", + "product_code":"cce", + "title":"Modifying Cluster Specifications", + "uri":"ResizeCluster.html", + "doc_type":"api2", + "p_code":"6", + "code":"16" + }, { "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", @@ -141,7 +150,7 @@ "uri":"cce_02_0242.html", "doc_type":"api2", "p_code":"6", - "code":"16" + "code":"17" }, { "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", @@ -150,7 +159,7 @@ "uri":"cce_02_0243.html", "doc_type":"api2", "p_code":"6", - "code":"17" + "code":"18" }, { "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", @@ -159,7 +168,7 @@ "uri":"cce_02_0244.html", "doc_type":"api2", "p_code":"6", - "code":"18" + "code":"19" }, { "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", @@ -168,7 +177,7 @@ "uri":"cce_02_0245.html", "doc_type":"api2", "p_code":"6", - "code":"19" + "code":"20" }, { "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 ", @@ -177,7 +186,7 @@ "uri":"cce_02_0246.html", "doc_type":"api2", "p_code":"6", - "code":"20" + "code":"21" }, { "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://", @@ -186,7 +195,7 @@ "uri":"cce_02_0247.html", "doc_type":"api2", "p_code":"6", - "code":"21" + "code":"22" }, { "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", @@ -195,7 +204,7 @@ "uri":"cce_02_0347.html", "doc_type":"api2", "p_code":"6", - "code":"22" + "code":"23" }, { "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", @@ -204,7 +213,7 @@ "uri":"cce_02_0346.html", "doc_type":"api2", "p_code":"6", - "code":"23" + "code":"24" }, { "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", @@ -213,7 +222,7 @@ "uri":"AddNode.html", "doc_type":"api2", "p_code":"6", - "code":"24" + "code":"25" }, { "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", @@ -222,7 +231,7 @@ "uri":"ResetNode.html", "doc_type":"api2", "p_code":"6", - "code":"25" + "code":"26" }, { "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", @@ -231,7 +240,7 @@ "uri":"RemoveNode.html", "doc_type":"api2", "p_code":"6", - "code":"26" + "code":"27" }, { "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", @@ -240,7 +249,7 @@ "uri":"MigrateNode.html", "doc_type":"api2", "p_code":"6", - "code":"27" + "code":"28" }, { "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", @@ -249,7 +258,7 @@ "uri":"cce_02_0354.html", "doc_type":"api2", "p_code":"6", - "code":"28" + "code":"29" }, { "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", @@ -258,7 +267,7 @@ "uri":"cce_02_0355.html", "doc_type":"api2", "p_code":"6", - "code":"29" + "code":"30" }, { "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", @@ -267,7 +276,7 @@ "uri":"cce_02_0356.html", "doc_type":"api2", "p_code":"6", - "code":"30" + "code":"31" }, { "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", @@ -276,7 +285,7 @@ "uri":"cce_02_0269.html", "doc_type":"api2", "p_code":"6", - "code":"31" + "code":"32" }, { "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", @@ -285,7 +294,7 @@ "uri":"cce_02_0357.html", "doc_type":"api2", "p_code":"6", - "code":"32" + "code":"33" }, { "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.", @@ -294,7 +303,7 @@ "uri":"cce_02_0320.html", "doc_type":"api2", "p_code":"2", - "code":"33" + "code":"34" }, { "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 ", @@ -302,8 +311,8 @@ "title":"Installing an Add-on Instance", "uri":"cce_02_0322.html", "doc_type":"api2", - "p_code":"33", - "code":"34" + "p_code":"34", + "code":"35" }, { "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", @@ -311,8 +320,8 @@ "title":"Reading Add-on Templates", "uri":"cce_02_0321.html", "doc_type":"api2", - "p_code":"33", - "code":"35" + "p_code":"34", + "code":"36" }, { "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", @@ -320,8 +329,8 @@ "title":"Updating an Add-on Instance", "uri":"cce_02_0323.html", "doc_type":"api2", - "p_code":"33", - "code":"36" + "p_code":"34", + "code":"37" }, { "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", @@ -329,8 +338,8 @@ "title":"Deleting an Add-on Instance", "uri":"cce_02_0324.html", "doc_type":"api2", - "p_code":"33", - "code":"37" + "p_code":"34", + "code":"38" }, { "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", @@ -338,8 +347,8 @@ "title":"Reading an Add-on Instance", "uri":"cce_02_0325.html", "doc_type":"api2", - "p_code":"33", - "code":"38" + "p_code":"34", + "code":"39" }, { "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", @@ -347,8 +356,8 @@ "title":"Listing Add-on Instances", "uri":"cce_02_0326.html", "doc_type":"api2", - "p_code":"33", - "code":"39" + "p_code":"34", + "code":"40" }, { "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.", @@ -357,7 +366,7 @@ "uri":"quota_lifecycle_management.html", "doc_type":"api2", "p_code":"2", - "code":"40" + "code":"41" }, { "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", @@ -365,8 +374,8 @@ "title":"Querying Resource Quotas", "uri":"ShowQuotas.html", "doc_type":"api2", - "p_code":"40", - "code":"41" + "p_code":"41", + "code":"42" }, { "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.", @@ -375,7 +384,7 @@ "uri":"chart_lifecycle_management.html", "doc_type":"api2", "p_code":"2", - "code":"42" + "code":"43" }, { "desc":"This API is used to upload a chart.POST /v2/chartsStatus code: 201If the FormDataparameter exists, the value of Content-Typemust be multipart/form-data, and the file path", @@ -383,8 +392,8 @@ "title":"Uploading a Chart", "uri":"UploadChart.html", "doc_type":"api2", - "p_code":"42", - "code":"43" + "p_code":"43", + "code":"44" }, { "desc":"This API is used to obtain the chart list.GET /v2/chartsStatus code: 200NoneStatus code: 200OKSee Error Codes.", @@ -392,8 +401,8 @@ "title":"Obtaining a Chart List", "uri":"ListCharts.html", "doc_type":"api2", - "p_code":"42", - "code":"44" + "p_code":"43", + "code":"45" }, { "desc":"This API is used to obtain a release list.GET /cce/cam/v3/clusters/{cluster_id}/releasesStatus code: 200NoneStatus code: 200OKSee Error Codes.", @@ -401,8 +410,8 @@ "title":"Obtaining a Release List", "uri":"ListReleases.html", "doc_type":"api2", - "p_code":"42", - "code":"45" + "p_code":"43", + "code":"46" }, { "desc":"This API is used to update a chart.PUT /v2/charts/{chart_id}Status code: 200If the FormDataparameter exists, the value of Content-Typemust be multipart/form-data, and the", @@ -410,8 +419,8 @@ "title":"Updating a Chart", "uri":"UpdateChart.html", "doc_type":"api2", - "p_code":"42", - "code":"46" + "p_code":"43", + "code":"47" }, { "desc":"This API is used to create a release.POST /cce/cam/v3/clusters/{cluster_id}/releasesStatus code: 201Status code: 201CreatedSee Error Codes.", @@ -419,8 +428,8 @@ "title":"Creating a Release", "uri":"CreateRelease.html", "doc_type":"api2", - "p_code":"42", - "code":"47" + "p_code":"43", + "code":"48" }, { "desc":"This API is used to delete a chart.DELETE /v2/charts/{chart_id}Status code: 200NoneStatus code: 200OKSee Error Codes.", @@ -428,8 +437,8 @@ "title":"Deleting a Chart", "uri":"DeleteChart.html", "doc_type":"api2", - "p_code":"42", - "code":"48" + "p_code":"43", + "code":"49" }, { "desc":"This API is used to update a release.PUT /cce/cam/v3/clusters/{cluster_id}/namespace/{namespace}/releases/{name}Status code: 200Status code: 200OKSee Error Codes.", @@ -437,8 +446,8 @@ "title":"Updating a Release", "uri":"UpdateRelease.html", "doc_type":"api2", - "p_code":"42", - "code":"49" + "p_code":"43", + "code":"50" }, { "desc":"This API is used to obtain a chart.GET /v2/charts/{chart_id}Status code: 200NoneStatus code: 200OKSee Error Codes.", @@ -446,8 +455,8 @@ "title":"Obtaining a Chart", "uri":"ShowChart.html", "doc_type":"api2", - "p_code":"42", - "code":"50" + "p_code":"43", + "code":"51" }, { "desc":"This API is used to delete a release.DELETE /cce/cam/v3/clusters/{cluster_id}/namespace/{namespace}/releases/{name}Status code: 200NoneStatus code: 200OKSee Error Codes.", @@ -455,8 +464,8 @@ "title":"Deleting a Release", "uri":"DeleteRelease.html", "doc_type":"api2", - "p_code":"42", - "code":"51" + "p_code":"43", + "code":"52" }, { "desc":"This API is used to download a chart.GET /v2/charts/{chart_id}/archiveStatus code: 200NoneStatus code: 200OKSee Error Codes.", @@ -464,8 +473,8 @@ "title":"Downloading a Chart", "uri":"DownloadChart.html", "doc_type":"api2", - "p_code":"42", - "code":"52" + "p_code":"43", + "code":"53" }, { "desc":"This API is used to obtain a release.GET /cce/cam/v3/clusters/{cluster_id}/namespace/{namespace}/releases/{name}Status code: 200NoneStatus code: 200OKSee Error Codes.", @@ -473,8 +482,8 @@ "title":"Obtaining a Release", "uri":"ShowRelease.html", "doc_type":"api2", - "p_code":"42", - "code":"53" + "p_code":"43", + "code":"54" }, { "desc":"This API is used to obtain chart values.GET /v2/charts/{chart_id}/valuesStatus code: 200NoneStatus code: 200OKSee Error Codes.", @@ -482,8 +491,8 @@ "title":"Obtaining Chart Values", "uri":"ShowChartValues.html", "doc_type":"api2", - "p_code":"42", - "code":"54" + "p_code":"43", + "code":"55" }, { "desc":"This API is used to obtain historical records of a release.GET /cce/cam/v3/clusters/{cluster_id}/namespace/{namespace}/releases/{name}/historyStatus code: 200NoneStatus c", @@ -491,8 +500,8 @@ "title":"Obtaining Historical Records of a Release", "uri":"ShowReleaseHistory.html", "doc_type":"api2", - "p_code":"42", - "code":"55" + "p_code":"43", + "code":"56" }, { "desc":"This API is used to obtain the quota of a user chart.GET /v2/charts/{project_id}/quotasStatus code: 200NoneStatus code: 200OKSee Error Codes.", @@ -500,8 +509,53 @@ "title":"Obtaining the Quota of a User Chart", "uri":"ShowUserChartsQuotas.html", "doc_type":"api2", - "p_code":"42", - "code":"56" + "p_code":"43", + "code":"57" + }, + { + "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":"Configuration Management", + "uri":"configuration_lifecycle_management.html", + "doc_type":"api2", + "p_code":"2", + "code":"58" + }, + { + "desc":"This API is used to obtain the list of parameters that can be configured for a CCE node pool.GET /api/v3/projects/{project_id}/clusters/{cluster_id}/nodepools/{nodepool_i", + "product_code":"cce", + "title":"Obtaining the List of Parameters That Can Be Configured for a Node Pool", + "uri":"ShowNodePoolConfigurationDetails.html", + "doc_type":"api2", + "p_code":"58", + "code":"59" + }, + { + "desc":"This API is used to obtain the list of parameters that can be configured for a CCE cluster.GET /api/v3/projects/{project_id}/clusters/{cluster_id}/configuration/detailSta", + "product_code":"cce", + "title":"Obtaining the List of Parameters That Can Be Configured for a Cluster", + "uri":"ShowClusterConfigurationDetails.html", + "doc_type":"api2", + "p_code":"58", + "code":"60" + }, + { + "desc":"This API is used to obtain the parameters that can be configured for a node pool.GET /api/v3/projects/{project_id}/clusters/{cluster_id}/nodepools/{nodepool_id}/configura", + "product_code":"cce", + "title":"Obtaining the Parameters That Can Be Configured for a Node Pool", + "uri":"ShowNodePoolConfigurations.html", + "doc_type":"api2", + "p_code":"58", + "code":"61" + }, + { + "desc":"This API is used to change the values of parameter configurations of a node pool in the CCE cluster.PUT /api/v3/projects/{project_id}/clusters/{cluster_id}/nodepools/{nod", + "product_code":"cce", + "title":"Changing the Values of Configuration Parameters of a Node Pool", + "uri":"UpdateNodePoolConfiguration.html", + "doc_type":"api2", + "p_code":"58", + "code":"62" }, { "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.", @@ -510,7 +564,7 @@ "uri":"cce_02_0366.html", "doc_type":"api2", "p_code":"2", - "code":"57" + "code":"63" }, { "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", @@ -518,8 +572,8 @@ "title":"CoreDNS", "uri":"cce_02_0407.html", "doc_type":"api2", - "p_code":"57", - "code":"58" + "p_code":"63", + "code":"64" }, { "desc":"The CCE Container Storage (Everest) add-on uses the Container Storage Interface (CSI) to link Kubernetes clusters with cloud storage services.", @@ -527,8 +581,8 @@ "title":"CCE Container Storage (Everest)", "uri":"cce_02_0408.html", "doc_type":"api2", - "p_code":"57", - "code":"59" + "p_code":"63", + "code":"65" }, { "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", @@ -536,8 +590,8 @@ "title":"CCE Node Problem Detector", "uri":"cce_02_0409.html", "doc_type":"api2", - "p_code":"57", - "code":"60" + "p_code":"63", + "code":"66" }, { "desc":"The CCE Cluster Autoscaler (autoscaler) add-on enables node pools to be scaled in or out.", @@ -545,8 +599,8 @@ "title":"CCE Cluster Autoscaler", "uri":"cce_02_0411.html", "doc_type":"api2", - "p_code":"57", - "code":"61" + "p_code":"63", + "code":"67" }, { "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", @@ -554,8 +608,8 @@ "title":"NGINX Ingress Controller", "uri":"cce_02_0412.html", "doc_type":"api2", - "p_code":"57", - "code":"62" + "p_code":"63", + "code":"68" }, { "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", @@ -563,8 +617,8 @@ "title":"Kubernetes Metrics Server", "uri":"cce_02_0413.html", "doc_type":"api2", - "p_code":"57", - "code":"63" + "p_code":"63", + "code":"69" }, { "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", @@ -572,8 +626,8 @@ "title":"CCE Advanced HPA", "uri":"cce_02_0414.html", "doc_type":"api2", - "p_code":"57", - "code":"64" + "p_code":"63", + "code":"70" }, { "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.", @@ -581,8 +635,8 @@ "title":"CCE AI Suite (NVIDIA GPU)", "uri":"cce_02_0415.html", "doc_type":"api2", - "p_code":"57", - "code":"65" + "p_code":"63", + "code":"71" }, { "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", @@ -590,8 +644,8 @@ "title":"Volcano Scheduler", "uri":"cce_02_0417.html", "doc_type":"api2", - "p_code":"57", - "code":"66" + "p_code":"63", + "code":"72" }, { "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", @@ -599,8 +653,17 @@ "title":"Cloud Native Cluster Monitoring", "uri":"cce_02_0421.html", "doc_type":"api2", - "p_code":"57", - "code":"67" + "p_code":"63", + "code":"73" + }, + { + "desc":"The Cloud Native Logging add-on (log-agent) is developed based on Fluent Bit and OpenTelemetry for collecting logs and Kubernetes events. This add-on supports CRD-based l", + "product_code":"cce", + "title":"Cloud Native Log Collection", + "uri":"cce_02_0422.html", + "doc_type":"api2", + "p_code":"63", + "code":"74" }, { "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.", @@ -609,7 +672,7 @@ "uri":"cce_02_0340.html", "doc_type":"api2", "p_code":"", - "code":"68" + "code":"75" }, { "desc":"Kubernetes APIs are resource-based (RESTful) programming interfaces provided through HTTP. It supports query, creation, update, and deletion of various cluster resources ", @@ -617,8 +680,8 @@ "title":"Overview", "uri":"kubernetesapi.html", "doc_type":"api2", - "p_code":"68", - "code":"69" + "p_code":"75", + "code":"76" }, { "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", @@ -627,7 +690,7 @@ "uri":"cce_02_0327.html", "doc_type":"api2", "p_code":"", - "code":"70" + "code":"77" }, { "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.", @@ -636,7 +699,7 @@ "uri":"cce_02_0083.html", "doc_type":"api2", "p_code":"", - "code":"71" + "code":"78" }, { "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", @@ -644,8 +707,8 @@ "title":"Patch Request Method Operation Description", "uri":"cce_02_0085.html", "doc_type":"api2", - "p_code":"71", - "code":"72" + "p_code":"78", + "code":"79" }, { "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", @@ -653,8 +716,8 @@ "title":"Patch Request Method Operation Example", "uri":"cce_02_0086.html", "doc_type":"api2", - "p_code":"71", - "code":"73" + "p_code":"78", + "code":"80" }, { "desc":"Table 1 describes the status codes.", @@ -662,8 +725,8 @@ "title":"Status Code", "uri":"cce_02_0084.html", "doc_type":"api2", - "p_code":"71", - "code":"74" + "p_code":"78", + "code":"81" }, { "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 ", @@ -671,8 +734,8 @@ "title":"Error Codes", "uri":"cce_02_0250.html", "doc_type":"api2", - "p_code":"71", - "code":"75" + "p_code":"78", + "code":"82" }, { "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", @@ -680,8 +743,8 @@ "title":"Obtaining a Project ID", "uri":"cce_02_0341.html", "doc_type":"api2", - "p_code":"71", - "code":"76" + "p_code":"78", + "code":"83" }, { "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", @@ -689,8 +752,8 @@ "title":"Obtaining the Account ID", "uri":"cce_02_0342.html", "doc_type":"api2", - "p_code":"71", - "code":"77" + "p_code":"78", + "code":"84" }, { "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", @@ -698,8 +761,8 @@ "title":"How to Obtain Parameters in the API URI", "uri":"cce_02_0271.html", "doc_type":"api2", - "p_code":"71", - "code":"78" + "p_code":"78", + "code":"85" }, { "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.", @@ -707,8 +770,8 @@ "title":"API Permissions", "uri":"cce_02_0272.html", "doc_type":"api2", - "p_code":"71", - "code":"79" + "p_code":"78", + "code":"86" }, { "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", @@ -716,8 +779,8 @@ "title":"Creating a VPC and Subnet", "uri":"cce_02_0100.html", "doc_type":"api2", - "p_code":"71", - "code":"80" + "p_code":"78", + "code":"87" }, { "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, ", @@ -725,8 +788,8 @@ "title":"Creating a Key Pair", "uri":"cce_02_0101.html", "doc_type":"api2", - "p_code":"71", - "code":"81" + "p_code":"78", + "code":"88" }, { "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", @@ -734,8 +797,8 @@ "title":"Node Flavor Description", "uri":"cce_02_0368.html", "doc_type":"api2", - "p_code":"71", - "code":"82" + "p_code":"78", + "code":"89" }, { "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", @@ -743,8 +806,8 @@ "title":"Attaching Disks to a Node", "uri":"node_storage_example.html", "doc_type":"api2", - "p_code":"71", - "code":"83" + "p_code":"78", + "code":"90" }, { "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.", @@ -753,6 +816,6 @@ "uri":"cce_02_0273.html", "doc_type":"api2", "p_code":"", - "code":"84" + "code":"91" } ] \ No newline at end of file diff --git a/docs/cce/api-ref/ResetNode.html b/docs/cce/api-ref/ResetNode.html index b9a1a1e24..850c7abab 100644 --- a/docs/cce/api-ref/ResetNode.html +++ b/docs/cce/api-ref/ResetNode.html @@ -338,6 +338,7 @@

String

Key of the cloud server label. The value cannot start with CCE- or __type_baremetal.

+

Only uppercase letters, lowercase letters, digits, special characters (-_@), and Unicode characters (\u4E00-\u9FA5) are supported. It can contain a maximum of 36 characters. The key cannot be empty.

value

@@ -347,6 +348,7 @@

String

Value of the cloud server label.

+

Only uppercase letters, lowercase letters, digits, special characters (-_@), and Unicode characters (\u4E00-\u9FA5) are supported. It can contain a maximum of 43 characters. The value can be empty.

@@ -524,7 +526,7 @@

String

EVS disk type.

-
  • SATA: common I/O
  • SAS: high I/O
  • SSD: ultra-high I/O
  • GPSSD: general-purpose SSD
  • ESSD: extreme SSD
+
  • SAS: high I/O
  • SSD: ultra-high I/O
  • GPSSD: general-purpose SSD
  • ESSD: extreme SSD

metadataEncrypted

diff --git a/docs/cce/api-ref/ResizeCluster.html b/docs/cce/api-ref/ResizeCluster.html new file mode 100644 index 000000000..37e1adbe6 --- /dev/null +++ b/docs/cce/api-ref/ResizeCluster.html @@ -0,0 +1,239 @@ + + +

Modifying Cluster Specifications

+

Function

This API is used to modify the specifications of a cluster.

+

  • The URL for cluster management is in the format of https://Endpoint/uri, in which uri indicates the resource path, that is, the path for API access.

    +
+

+
+
+

URI

POST /api/v3/projects/{project_id}/clusters/{cluster_id}/operation/resize

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Details:

+

Project ID. For details about how to obtain the value, see How to Obtain Parameters in the API URI.

+

Constraints:

+

None

+

Options:

+

Project IDs of the account

+

Default value:

+

N/A

+

cluster_id

+

Yes

+

String

+

Details:

+

Cluster ID. For details about how to obtain the value, see How to Obtain Parameters in the API URI.

+

Constraints:

+

None

+

Options:

+

Cluster IDs

+

Default value:

+

N/A

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 2 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

Content-Type

+

Yes

+

String

+

Details:

+

The request body type or format

+

Constraints:

+

The GET method is not verified.

+

Options:

+

  • application/json

    +

  • application/json;charset=utf-8

    +

  • application/x-pem-file

    +

  • multipart/form-data (used when the FormData parameter is present)

    +
+

Default value:

+

N/A

+

X-Auth-Token

+

Yes

+

String

+

Details:

+

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. For details, see API Usage Guidelines.

+

Constraints:

+

None

+

Options:

+

N/A

+

Default value:

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 3 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

flavorResize

+

Yes

+

String

+

The target flavor to be changed. You can only adjust the maximum number of worker nodes in a cluster. The number of master nodes is fixed and cannot be altered, and the cluster flavors cannot be downgraded. Suppose the original cluster flavor is cce.s2.medium. In that case, you can only upgrade it to cce.s2.large or higher, but you cannot downgrade it to cce.s2.small or cce.s1.medium.

+

  • cce.s1.small: a small-scale CCE cluster with one master node and a maximum of 50 worker nodes

    +

  • cce.s1.medium: a medium-scale CCE cluster with one master node and a maximum of 200 worker nodes

    +

  • cce.s2.small: a small-scale CCE cluster with three master nodes and a maximum of 50 worker nodes

    +

  • cce.s2.medium: a medium-scale CCE cluster with three master nodes and a maximum of 200 worker nodes

    +

  • cce.s2.large: a large-scale CCE cluster with three master nodes and a maximum of 1,000 worker nodes

    +

  • cce.s2.xlarge: an ultra-large-scale CCE cluster with three master nodes and a maximum of 2,000 worker nodes

    +
+
NOTE:

The fields in the parameters are described as follows:

+

  • s1: specifies a cluster with one master node. If the master node is faulty, the cluster will become unavailable, but running workloads in the cluster are not affected.

    +

  • s2: specifies an HA cluster with three master nodes. If one of the master nodes is faulty, the cluster is still available.

    +

  • small: specifies that a cluster can manage a maximum of 50 worker nodes.

    +

  • medium: specifies that a cluster can manage a maximum of 200 worker nodes.

    +

  • large: specifies that a cluster can manage a maximum of 1,000 worker nodes.

    +

  • xlarge: specifies that a cluster can manage a maximum of 2,000 worker nodes.

    +
+
+

extendParam

+

No

+

extendParam object

+

Extended field for changing cluster specifications

+
+
+ +
+ + + + + + + + + + + +
Table 4 extendParam

Parameter

+

Mandatory

+

Type

+

Description

+

decMasterFlavor

+

No

+

String

+

Specifications of the master node in the dedicated hybrid cluster

+
+
+
+

Response Parameters

Status code: 201

+ +
+ + + + + + + + + +
Table 5 Response body parameters

Parameter

+

Type

+

Description

+

jobID

+

String

+

Job ID

+
+
+
+

Example Requests

  • Modifying the specifications of the pay-per-use cluster

    +
    POST /api/v3/projects/{project_id}/clusters/{cluster_id}/operation/resize
+
+{
+  "flavorResize" : "cce.s1.medium"
+}
    +
+
+

Example Responses

Status code: 201

+

The job for modifying the specifications of the pay-per-use cluster is delivered.

+
{
+  "jobID" : "13b8d958-8fcf-11ed-aef3-0255ac1001bd"
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

201

+

The job for modifying the specifications of the pay-per-use cluster is delivered.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Cluster Management
+
+
+ diff --git a/docs/cce/api-ref/ShowClusterConfigurationDetails.html b/docs/cce/api-ref/ShowClusterConfigurationDetails.html new file mode 100644 index 000000000..95c80b64e --- /dev/null +++ b/docs/cce/api-ref/ShowClusterConfigurationDetails.html @@ -0,0 +1,225 @@ + + +

Obtaining the List of Parameters That Can Be Configured for a Cluster

+

Function

This API is used to obtain the list of parameters that can be configured for a CCE cluster.

+
+

URI

GET /api/v3/projects/{project_id}/clusters/{cluster_id}/configuration/detail

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Details:

+

Project ID. For details about how to obtain the value, see How to Obtain Parameters in the API URI.

+

Constraints:

+

None

+

Options:

+

Project IDs of the account

+

Default value:

+

N/A

+

cluster_id

+

Yes

+

String

+

Details:

+

Cluster ID. For details about how to obtain the value, see How to Obtain Parameters in the API URI.

+

Constraints:

+

None

+

Options:

+

Cluster IDs

+

Default value:

+

N/A

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 2 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

Content-Type

+

Yes

+

String

+

Details:

+

The request body type or format

+

Constraints:

+

The GET method is not verified.

+

Options:

+

  • application/json

    +

  • application/json;charset=utf-8

    +

  • application/x-pem-file

    +

  • multipart/form-data (used when the FormData parameter is present)

    +
+

Default value:

+

N/A

+

X-Auth-Token

+

Yes

+

String

+

Details:

+

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. For details, see Obtaining a User Token.

+

Constraints:

+

None

+

Options:

+

N/A

+

Default value:

+

N/A

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

{User defined key}

+

Map<String,Array<PackageOptions>>

+

Response body for obtaining the parameter configuration list of a cluster

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 PackageOptions

Parameter

+

Type

+

Description

+

name

+

String

+

Parameter name

+

default

+

Object

+

Default parameter value. If this parameter is not specified, the default value will take effect. The returned parameter can be of integer, string, or Boolean type.

+

validAt

+

String

+

How parameters will take effect.

+

  • static: The parameters take effect when the cluster or node pool is being created and cannot be changed later.

    +

  • immediately: The parameters can be modified when the cluster or node pool is running, and the modification takes effect immediately.

    +
+

empty

+

Boolean

+

Whether the configuration item can be empty. Options:

+

  • true: If this parameter is set to true, no value will take effect.

    +

  • false: If this parameter is set to false, the default value will take effect.

    +
+

schema

+

String

+

Parameter category

+

type

+

String

+

Parameter type

+
+
+
+

Example Requests

None

+
+

Example Responses

Status code: 200

+

A list of parameters that can be configured for a cluster is obtained successfully.

+
{
+  "kube-apiserver" : [ {
+    "name" : "default-not-ready-toleration-seconds",
+    "default" : 300,
+    "validAt" : "immediately",
+    "empty" : true,
+    "schema" : "kubernetes",
+    "type" : "int"
+  } ]
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

A list of parameters that can be configured for a cluster is obtained successfully.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Configuration Management
+
+
+ diff --git a/docs/cce/api-ref/ShowNodePoolConfigurationDetails.html b/docs/cce/api-ref/ShowNodePoolConfigurationDetails.html new file mode 100644 index 000000000..40739f568 --- /dev/null +++ b/docs/cce/api-ref/ShowNodePoolConfigurationDetails.html @@ -0,0 +1,241 @@ + + +

Obtaining the List of Parameters That Can Be Configured for a Node Pool

+

Function

This API is used to obtain the list of parameters that can be configured for a CCE node pool.

+
+

URI

GET /api/v3/projects/{project_id}/clusters/{cluster_id}/nodepools/{nodepool_id}/configuration/detail

+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Details:

+

Project ID. For details about how to obtain the value, see How to Obtain Parameters in the API URI.

+

Constraints:

+

None

+

Options:

+

Project IDs of the account

+

Default value:

+

N/A

+

cluster_id

+

Yes

+

String

+

Details:

+

Cluster ID. For details about how to obtain the value, see How to Obtain Parameters in the API URI.

+

Constraints:

+

None

+

Options:

+

Cluster IDs

+

Default value:

+

N/A

+

nodepool_id

+

Yes

+

String

+

Details:

+

Node pool ID. For details about how to obtain the ID, see How to Obtain Parameters in the API URI.

+

Constraints:

+

None

+

Options:

+

Cluster IDs

+

Default value:

+

N/A

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 2 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

Content-Type

+

Yes

+

String

+

Details:

+

The request body type or format

+

Constraints:

+

The GET method is not verified.

+

Options:

+

  • application/json

    +

  • application/json;charset=utf-8

    +

  • application/x-pem-file

    +

  • multipart/form-data (used when the FormData parameter is present)

    +
+

Default value:

+

N/A

+

X-Auth-Token

+

Yes

+

String

+

Details:

+

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. For details, see Obtaining a User Token.

+

Constraints:

+

None

+

Options:

+

N/A

+

Default value:

+

N/A

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

{User defined key}

+

Map<String,Array<PackageOptions>>

+

Response body for obtaining the parameter configuration list of a specified node pool

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 PackageOptions

Parameter

+

Type

+

Description

+

name

+

String

+

Parameter name

+

default

+

Object

+

Default parameter value. If this parameter is not specified, the default value will take effect. The returned parameter can be of integer, string, or Boolean type.

+

validAt

+

String

+

How parameters will take effect.

+

  • static: The parameters take effect when the cluster or node pool is being created and cannot be changed later.

    +

  • immediately: The parameters can be modified when the cluster or node pool is running, and the modification takes effect immediately.

    +
+

empty

+

Boolean

+

Whether the configuration item can be empty. Options:

+

  • true: If this parameter is set to true, no value will take effect.

    +

  • false: If this parameter is set to false, the default value will take effect.

    +
+

schema

+

String

+

Parameter category

+

type

+

String

+

Parameter type

+
+
+
+

Example Requests

None

+
+

Example Responses

Status code: 200

+

The list of parameters that can be configured for the node pool is obtained.

+
{
+  "kubelet" : [ {
+    "name" : "kube-api-qps",
+    "default" : 300,
+    "validAt" : "immediately",
+    "empty" : false,
+    "schema" : "",
+    "type" : "float"
+  } ]
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

The list of parameters that can be configured for the node pool is obtained.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Configuration Management
+
+
+ diff --git a/docs/cce/api-ref/ShowNodePoolConfigurations.html b/docs/cce/api-ref/ShowNodePoolConfigurations.html new file mode 100644 index 000000000..71dc42f60 --- /dev/null +++ b/docs/cce/api-ref/ShowNodePoolConfigurations.html @@ -0,0 +1,346 @@ + + +

Obtaining the Parameters That Can Be Configured for a Node Pool

+

Function

This API is used to obtain the parameters that can be configured for a node pool.

+
+

URI

GET /api/v3/projects/{project_id}/clusters/{cluster_id}/nodepools/{nodepool_id}/configuration

+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Details:

+

Project ID. For details about how to obtain the value, see How to Obtain Parameters in the API URI.

+

Constraints:

+

None

+

Options:

+

Project IDs of the account

+

Default value:

+

N/A

+

cluster_id

+

Yes

+

String

+

Details:

+

Cluster ID. For details about how to obtain the value, see How to Obtain Parameters in the API URI.

+

Constraints:

+

None

+

Options:

+

Cluster IDs

+

Default value:

+

N/A

+

nodepool_id

+

Yes

+

String

+

Details:

+

Node pool ID. For details about how to obtain the ID, see How to Obtain Parameters in the API URI.

+

Constraints:

+

None

+

Options:

+

Cluster IDs

+

Default value:

+

N/A

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 2 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

Content-Type

+

Yes

+

String

+

Details:

+

The request body type or format

+

Constraints:

+

The GET method is not verified.

+

Options:

+

  • application/json

    +

  • application/json;charset=utf-8

    +

  • application/x-pem-file

    +

  • multipart/form-data (used when the FormData parameter is present)

    +
+

Default value:

+

N/A

+

X-Auth-Token

+

Yes

+

String

+

Details:

+

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. For details, see Obtaining a User Token.

+

Constraints:

+

None

+

Options:

+

N/A

+

Default value:

+

N/A

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

API version

+

kind

+

String

+

API type. The value is fixed at Configuration.

+

metadata

+

ConfigurationMetadata object

+

Configuration metadata

+

spec

+

ClusterConfigurationsSpec object

+

Configuration specifications

+

status

+

Object

+

Configuration status

+
+
+ +
+ + + + + + + + + + + + + +
Table 4 ConfigurationMetadata

Parameter

+

Type

+

Description

+

name

+

String

+

Configuration name

+

labels

+

Map<String,String>

+

A configuration label in a key-value pair.

+

  • Key: Enter 1 to 63 characters starting with a letter or digit. Only letters, digits, hyphens (-), underscores (_), and periods (.) are allowed. A DNS subdomain containing a maximum of 253 characters (such as example.com/my-key) can be prefixed to a key.

    +

  • Value: The value can be left blank or contain 1 to 63 characters that start and end with a letter or digit. Only letters, digits, hyphens (-), underscores (_), and periods (.) are allowed.

    +
+

Example: "foo": "bar"

+
+
+ +
+ + + + + + + + + +
Table 5 ClusterConfigurationsSpec

Parameter

+

Type

+

Description

+

packages

+

Array of packages objects

+

Component configuration item details

+
+
+ +
+ + + + + + + + + + + + + +
Table 6 packages

Parameter

+

Type

+

Description

+

name

+

String

+

Component name

+

configurations

+

Array of ConfigurationItem objects

+

Component configuration items

+
+
+ +
+ + + + + + + + + + + + + +
Table 7 ConfigurationItem

Parameter

+

Type

+

Description

+

name

+

String

+

Details:

+

Configuration overrides of the default components in a cluster.

+

Constraints:

+

If you specify a component or parameter that is not supported, this configuration item will be ignored.

+

Options:

+

N/A

+

Default value:

+

N/A

+

value

+

AnyType

+

Details:

+

Configuration overrides of the default components in a cluster.

+

Constraints:

+

If you specify a component or parameter that is not supported, this configuration item will be ignored.

+

Options:

+

N/A

+

Default value:

+

N/A

+
+
+
+

Example Requests

None

+
+

Example Responses

Status code: 200

+

The parameter configurations of the node pool are obtained successfully.

+
{
+  "kind" : "Configuration",
+  "apiVersion" : "v3",
+  "metadata" : {
+    "name" : "configuration",
+    "labels" : {
+      "nodepool_id" : "61de338d-a1f9-11ed-8891-0255ac100036"
+    }
+  },
+  "spec" : {
+    "packages" : [ {
+      "name" : "kube-apiserver",
+      "configurations" : [ {
+        "name" : "event-rate-limit-qps",
+        "value" : 200
+      }, {
+        "name" : "support-overload",
+        "value" : false
+      } ]
+    }, {
+      "name" : "kube-scheduler",
+      "configurations" : [ {
+        "name" : "kube-api-qps",
+        "value" : 100
+      }, {
+        "name" : "default-scheduler",
+        "value" : "kube-scheduler"
+      } ]
+    } ]
+  },
+  "status" : { }
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

The parameter configurations of the node pool are obtained successfully.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Configuration Management
+
+
+ diff --git a/docs/cce/api-ref/UpdateNodePoolConfiguration.html b/docs/cce/api-ref/UpdateNodePoolConfiguration.html new file mode 100644 index 000000000..e8d211d40 --- /dev/null +++ b/docs/cce/api-ref/UpdateNodePoolConfiguration.html @@ -0,0 +1,554 @@ + + +

Changing the Values of Configuration Parameters of a Node Pool

+

Function

This API is used to change the values of parameter configurations of a node pool in the CCE cluster.

+
+

URI

PUT /api/v3/projects/{project_id}/clusters/{cluster_id}/nodepools/{nodepool_id}/configuration

+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Details:

+

Project ID. For details about how to obtain the value, see How to Obtain Parameters in the API URI.

+

Constraints:

+

None

+

Options:

+

Project IDs of the account

+

Default value:

+

N/A

+

cluster_id

+

Yes

+

String

+

Details:

+

Cluster ID. For details about how to obtain the value, see How to Obtain Parameters in the API URI.

+

Constraints:

+

None

+

Options:

+

Cluster IDs

+

Default value:

+

N/A

+

nodepool_id

+

Yes

+

String

+

Details:

+

Node pool ID. For details about how to obtain the ID, see How to Obtain Parameters in the API URI.

+

Constraints:

+

None

+

Options:

+

Cluster IDs

+

Default value:

+

N/A

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 2 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

Content-Type

+

Yes

+

String

+

Details:

+

The request body type or format

+

Constraints:

+

The GET method is not verified.

+

Options:

+

  • application/json

    +

  • application/json;charset=utf-8

    +

  • application/x-pem-file

    +

  • multipart/form-data (used when the FormData parameter is present)

    +
+

Default value:

+

N/A

+

X-Auth-Token

+

Yes

+

String

+

Details:

+

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. For details, see Obtaining a User Token.

+

Constraints:

+

None

+

Options:

+

N/A

+

Default value:

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

apiVersion

+

Yes

+

String

+

API version. The value is fixed at v3.

+

kind

+

Yes

+

String

+

API type. The value is fixed at Configuration.

+

metadata

+

Yes

+

ConfigurationMetadata object

+

Configuration metadata

+

spec

+

Yes

+

ClusterConfigurationsSpec object

+

Configuration specifications

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 4 ConfigurationMetadata

Parameter

+

Mandatory

+

Type

+

Description

+

name

+

Yes

+

String

+

Configuration name

+

labels

+

No

+

Map<String,String>

+

A configuration label in a key-value pair.

+

  • Key: Enter 1 to 63 characters starting with a letter or digit. Only letters, digits, hyphens (-), underscores (_), and periods (.) are allowed. A DNS subdomain containing a maximum of 253 characters (such as example.com/my-key) can be prefixed to a key.

    +

  • Value: The value can be left blank or contain 1 to 63 characters that start and end with a letter or digit. Only letters, digits, hyphens (-), underscores (_), and periods (.) are allowed.

    +
+

Example: "foo": "bar"

+
+
+ +
+ + + + + + + + + + + +
Table 5 ClusterConfigurationsSpec

Parameter

+

Mandatory

+

Type

+

Description

+

packages

+

Yes

+

Array of packages objects

+

Component configuration item details

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 6 packages

Parameter

+

Mandatory

+

Type

+

Description

+

name

+

No

+

String

+

Component name

+

configurations

+

No

+

Array of ConfigurationItem objects

+

Component configuration items

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 7 ConfigurationItem

Parameter

+

Mandatory

+

Type

+

Description

+

name

+

No

+

String

+

Details:

+

Configuration overrides of the default components in a cluster.

+

Constraints:

+

If you specify a component or parameter that is not supported, this configuration item will be ignored.

+

Options:

+

N/A

+

Default value:

+

N/A

+

value

+

No

+

AnyType

+

Details:

+

Configuration overrides of the default components in a cluster.

+

Constraints:

+

If you specify a component or parameter that is not supported, this configuration item will be ignored.

+

Options:

+

N/A

+

Default value:

+

N/A

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Table 8 Response body parameters

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

API version

+

kind

+

String

+

API type. The value is fixed at Configuration.

+

metadata

+

ConfigurationMetadata object

+

Configuration metadata

+

spec

+

ClusterConfigurationsSpec object

+

Configuration specifications

+

status

+

Object

+

Configuration status

+
+
+ +
+ + + + + + + + + + + + + +
Table 9 ConfigurationMetadata

Parameter

+

Type

+

Description

+

name

+

String

+

Configuration name

+

labels

+

Map<String,String>

+

A configuration label in a key-value pair.

+

  • Key: Enter 1 to 63 characters starting with a letter or digit. Only letters, digits, hyphens (-), underscores (_), and periods (.) are allowed. A DNS subdomain containing a maximum of 253 characters (such as example.com/my-key) can be prefixed to a key.

    +

  • Value: The value can be left blank or contain 1 to 63 characters that start and end with a letter or digit. Only letters, digits, hyphens (-), underscores (_), and periods (.) are allowed.

    +
+

Example: "foo": "bar"

+
+
+ +
+ + + + + + + + + +
Table 10 ClusterConfigurationsSpec

Parameter

+

Type

+

Description

+

packages

+

Array of packages objects

+

Component configuration item details

+
+
+ +
+ + + + + + + + + + + + + +
Table 11 packages

Parameter

+

Type

+

Description

+

name

+

String

+

Component name

+

configurations

+

Array of ConfigurationItem objects

+

Component configuration items

+
+
+ +
+ + + + + + + + + + + + + +
Table 12 ConfigurationItem

Parameter

+

Type

+

Description

+

name

+

String

+

Details:

+

Configuration overrides of the default components in a cluster.

+

Constraints:

+

If you specify a component or parameter that is not supported, this configuration item will be ignored.

+

Options:

+

N/A

+

Default value:

+

N/A

+

value

+

AnyType

+

Details:

+

Configuration overrides of the default components in a cluster.

+

Constraints:

+

If you specify a component or parameter that is not supported, this configuration item will be ignored.

+

Options:

+

N/A

+

Default value:

+

N/A

+
+
+
+

Example Requests

The following example describes how to update the system-reserved-mem and kube-reserved-mem parameters in kubelet.

+
/api/v3/projects/{project_id}/clusters/{cluster_id}/nodepools/{nodepool_id}/configuration
+
+{
+  "kind" : "Configuration",
+  "apiVersion" : "v3",
+  "metadata" : {
+    "name" : "configuration"
+  },
+  "spec" : {
+    "packages" : [ {
+      "name" : "kubelet",
+      "configurations" : [ {
+        "name" : "system-reserved-mem",
+        "value" : 600
+      }, {
+        "name" : "kube-reserved-mem",
+        "value" : 800
+      } ]
+    } ]
+  }
+}
+
+

Example Responses

Status code: 200

+

The parameter configurations of the node pool are updated successfully.

+
{
+  "kind" : "Configuration",
+  "apiVersion" : "v3",
+  "metadata" : {
+    "name" : "configuration",
+    "labels" : {
+      "nodepool_id" : "61de338d-a1f9-11ed-8891-0255ac100036"
+    }
+  },
+  "spec" : {
+    "packages" : [ {
+      "name" : "kube-apiserver",
+      "configurations" : [ {
+        "name" : "event-rate-limit-qps",
+        "value" : 200
+      }, {
+        "name" : "support-overload",
+        "value" : false
+      } ]
+    }, {
+      "name" : "kube-scheduler",
+      "configurations" : [ {
+        "name" : "kube-api-qps",
+        "value" : 100
+      }, {
+        "name" : "default-scheduler",
+        "value" : "kube-scheduler"
+      } ]
+    } ]
+  },
+  "status" : { }
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

The parameter configurations of the node pool are updated successfully.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Configuration Management
+
+
+ diff --git a/docs/cce/api-ref/cce_02_0092.html b/docs/cce/api-ref/cce_02_0092.html index 8c6b4c47d..ed993f48c 100644 --- a/docs/cce/api-ref/cce_02_0092.html +++ b/docs/cce/api-ref/cce_02_0092.html @@ -22,6 +22,8 @@
  • Obtaining Cluster Certificates (Deprecated)
    • +
  • Modifying Cluster Specifications
    +
  • Creating a Node
  • Reading a Specified Node
    diff --git a/docs/cce/api-ref/cce_02_0103.html b/docs/cce/api-ref/cce_02_0103.html index 92d7d2d56..03973e52a 100644 --- a/docs/cce/api-ref/cce_02_0103.html +++ b/docs/cce/api-ref/cce_02_0103.html @@ -14,6 +14,8 @@
  • Chart Management
    • +
  • Configuration Management
    +
  • Add-on Instance Parameters
    • diff --git a/docs/cce/api-ref/cce_02_0236.html b/docs/cce/api-ref/cce_02_0236.html index e0fcda895..7ba133b3d 100644 --- a/docs/cce/api-ref/cce_02_0236.html +++ b/docs/cce/api-ref/cce_02_0236.html @@ -282,7 +282,7 @@

    Boolean

    -

    Whether the cluster supports IPv6 addresses. This field is supported in clusters of v1.25 and later versions.

    +

    Whether the cluster supports IPv6 addresses. This field is supported in clusters of v1.25 and later versions.

    hostNetwork

    @@ -312,13 +312,13 @@

    Configuration of Cloud Native Network 2.0. Specify this field when creating a CCE Turbo cluster.

    -

    publicAccess

    +

    publicAccess

    -

    No

    +

    No

    -

    PublicAccess object

    +

    PublicAccess object

    -

    Cluster API access control.

    +

    Cluster API access control.

    authentication

    @@ -377,6 +377,18 @@

    The system disks and data disks of the master nodes in the cluster are encrypted. By default, the AES-256 encryption algorithm is used. This function is available in both CCE standard and Turbo clusters of v1.25 and later versions. The configuration cannot be modified after the cluster is created. After this function is enabled, there is some disk I/O performance loss.

    +

    configurationsOverride

    + +

    No

    + +

    Array of PackageConfiguration objects

    + +

    Details:

    +

    Overrides the default component configurations in a cluster.

    +

    Constraints:

    +

    If you specify a component or parameter that is not supported, the configuration item will be ignored.

    + + @@ -415,7 +427,7 @@

    String

    -

    Default worker node security group ID of the cluster. If specified, the cluster will be bound to the target security group. Otherwise, the system will automatically create a default worker node security group for you. The default worker node security group needs to allow access from certain ports to ensure normal communications.

    +

    Default worker node security group ID of the cluster. If specified, the cluster will be bound to the target security group. Otherwise, the system will automatically create a default worker node security group for you. The default worker node security group needs to allow access from certain ports to ensure normal communications.

    @@ -464,8 +476,9 @@

    String

    Cluster authentication mode.

    -
    • Clusters of Kubernetes v1.11 and earlier
      • Possible values: x509, rbac, and authenticating_proxy
      • Default value: x509
      -
    • Clusters of Kubernetes v1.13 and later
      • Possible values: rbac and authenticating_proxy
      • Default value: rbac
      +
      • Clusters of Kubernetes v1.11 and earlier
        • Possible values: rbac, and authenticating_proxy
        +
      • Clusters of Kubernetes v1.13
        • Possible values: rbac and authenticating_proxy
        • Default value: rbac
        +
      • Clusters of Kubernetes v1.15 and later
        • Possible values: rbac, and authenticating_proxy
        • Default value: rbac
      @@ -751,6 +764,94 @@ + +
      + + + + + + + + + + + + + + + + +
      Table 15 PackageConfiguration

      Parameter

      +

      Mandatory

      +

      Type

      +

      Description

      +

      name

      +

      No

      +

      String

      +

      Details:

      +

      Component name

      +

      Constraints:

      +

      None

      +

      Options:

      +

      N/A

      +

      Default value:

      +

      N/A

      +

      configurations

      +

      No

      +

      Array of ConfigurationItem objects

      +

      Details:

      +

      Component configuration items

      +

      Constraints:

      +

      None

      +
      +
      + +
      + + + + + + + + + + + + + + + + +
      Table 16 ConfigurationItem

      Parameter

      +

      Mandatory

      +

      Type

      +

      Description

      +

      name

      +

      No

      +

      String

      +

      Details:

      +

      Configuration overrides of the default components in a cluster.

      +

      Constraints:

      +

      If you specify a component or parameter that is not supported, this configuration item will be ignored.

      +

      Options:

      +

      N/A

      +

      Default value:

      +

      N/A

      +

      value

      +

      No

      +

      AnyType

      +

      Details:

      +

      Configuration overrides of the default components in a cluster.

      +

      Constraints:

      +

      If you specify a component or parameter that is not supported, this configuration item will be ignored.

      +

      Options:

      +

      N/A

      +

      Default value:

      +

      N/A

      +
      +

      Example Request

      CCE Cluster:
      {
     "kind": "Cluster",
@@ -821,9 +922,9 @@
 }

      Response

      Response parameters:

      -

      Table 15 describes the response parameters.

      +

      Table 17 describes the response parameters.

      -
      Table 15 Response parameters

      Parameter

      +
      @@ -870,7 +971,7 @@
      Table 17 Response parameters

      Parameter

      Type

      -
      Table 16 Data structure of the metadata field

      Parameter

      +
      @@ -943,7 +1044,7 @@
      Table 18 Data structure of the metadata field

      Parameter

      Type

      -
      Table 17 Data structure of the spec field

      Parameter

      +
      @@ -1015,7 +1116,7 @@ - - + + + +
      Table 19 Data structure of the spec field

      Parameter

      Type

      Boolean

      Whether the cluster supports IPv6 addresses. This field is supported in clusters of v1.25 and later versions.

      +

      Whether the cluster supports IPv6 addresses. This field is supported in clusters of v1.25 and later versions.

      hostNetwork

      @@ -1043,7 +1144,7 @@

      PublicAccess object

      Cluster API access control.

      +

      Cluster API access control.

      authentication

      @@ -1107,11 +1208,21 @@

      configurationsOverride

      +

      Array of PackageConfiguration objects

      +

      Details:

      +

      Overrides the default component configurations in a cluster.

      +

      Constraints:

      +

      If you specify a component or parameter that is not supported, the configuration item will be ignored.

      +
      -
      Table 18 Data structure of the hostNetwork field

      Parameter

      +
      @@ -1137,14 +1248,14 @@ -
      Table 20 Data structure of the hostNetwork field

      Parameter

      Type

      String

      Default worker node security group ID of the cluster. If specified, the cluster will be bound to the target security group. Otherwise, the system will automatically create a default worker node security group for you. The default worker node security group needs to allow access from certain ports to ensure normal communications.

      +

      Default worker node security group ID of the cluster. If specified, the cluster will be bound to the target security group. Otherwise, the system will automatically create a default worker node security group for you. The default worker node security group needs to allow access from certain ports to ensure normal communications.
      -
      Table 19 EniNetwork

      Parameter

      +
      @@ -1176,7 +1287,7 @@
      Table 21 EniNetwork

      Parameter

      Mandatory

      -
      Table 20 PublicAccess

      Parameter

      +
      @@ -1197,7 +1308,7 @@
      Table 22 PublicAccess

      Parameter

      Type

      -
      Table 21 Data structure of the authentication field

      Parameter

      +
      @@ -1210,14 +1321,14 @@
      Table 23 Data structure of the authentication field

      Parameter

      Type

      String

      Cluster authentication mode.

      -
      • Clusters of Kubernetes v1.11 or earlier support x509, rbac, and authenticating_proxy. The default value is x509.
      • Clusters of Kubernetes v1.13 or later support rbac and authenticating_proxy. The default value is rbac.
      +
      • Clusters of Kubernetes v1.11 or earlier support rbac, and authenticating_proxy.
      • Clusters of Kubernetes v1.13 support rbac and authenticating_proxy. The default value is rbac.
      • Clusters of Kubernetes v1.15 or later support rbac and authenticating_proxy. The default value is rbac.
      -
      Table 22 MasterSpec

      Parameter

      +
      @@ -1247,7 +1358,7 @@
      Table 24 MasterSpec

      Parameter

      Type

      -
      Table 23 Data structure of the extendParam field

      Parameter

      +
      @@ -1314,7 +1425,7 @@
      Table 25 Data structure of the extendParam field

      Parameter

      Type

      -
      Table 24 Data structure of the status field

      Parameter

      +
      @@ -1354,6 +1465,82 @@
      Table 26 Data structure of the status field

      Parameter

      Type
      + +
      + + + + + + + + + + + + + +
      Table 27 PackageConfiguration

      Parameter

      +

      Type

      +

      Description

      +

      name

      +

      String

      +

      Details:

      +

      Component name

      +

      Constraints:

      +

      None

      +

      Options:

      +

      N/A

      +

      Default value:

      +

      N/A

      +

      configurations

      +

      Array of ConfigurationItem objects

      +

      Details:

      +

      Component configuration items

      +

      Constraints:

      +

      None

      +
      +
      + +
      + + + + + + + + + + + + + +
      Table 28 ConfigurationItem

      Parameter

      +

      Type

      +

      Description

      +

      name

      +

      String

      +

      Details:

      +

      Configuration overrides of the default components in a cluster.

      +

      Constraints:

      +

      If you specify a component or parameter that is not supported, this configuration item will be ignored.

      +

      Options:

      +

      N/A

      +

      Default value:

      +

      N/A

      +

      value

      +

      AnyType

      +

      Details:

      +

      Configuration overrides of the default components in a cluster.

      +

      Constraints:

      +

      If you specify a component or parameter that is not supported, this configuration item will be ignored.

      +

      Options:

      +

      N/A

      +

      Default value:

      +

      N/A

      +
      +

      Example response:

          "kind": "Cluster",
@@ -1402,9 +1589,9 @@
         "jobID": "d6bcbb0b-8529-11ea-8e34-0255ac101108"
     }
 }
      -

      Status Code

      Table 25 describes the status code of this API.

      +

      Status Code

      Table 29 describes the status code of this API.

      -
      - @@ -498,74 +508,150 @@
      Table 25 Status code

      Status Code

      +
      diff --git a/docs/cce/api-ref/cce_02_0238.html b/docs/cce/api-ref/cce_02_0238.html index b1762e374..99a288317 100644 --- a/docs/cce/api-ref/cce_02_0238.html +++ b/docs/cce/api-ref/cce_02_0238.html @@ -177,7 +177,7 @@ - - + + + +
      Table 29 Status code

      Status Code

      Description

      Boolean

      Whether the cluster supports IPv6 addresses. This field is supported in clusters of v1.25 and later versions.

      +

      Whether the cluster supports IPv6 addresses. This field is supported in clusters of v1.25 and later versions.

      supportIstio

      @@ -230,7 +230,7 @@

      PublicAccess object

      Cluster API access control.

      +

      Cluster API access control.

      authentication

      @@ -286,6 +286,16 @@

      The system disks and data disks of the master nodes in the cluster are encrypted. By default, the AES-256 encryption algorithm is used. This function is available in both CCE standard and Turbo clusters of v1.25 and later versions. The configuration cannot be modified after the cluster is created. After this function is enabled, there is some disk I/O performance loss.

      configurationsOverride

      +

      Array of PackageConfiguration objects

      +

      Details:

      +

      Overrides the default component configurations in a cluster.

      +

      Constraints:

      +

      If you specify a component or parameter that is not supported, the configuration item will be ignored.

      +
      @@ -316,7 +326,7 @@

      String

      Default worker node security group ID of the cluster. If specified, the cluster will be bound to the target security group. Otherwise, the system will automatically create a default worker node security group for you. The default worker node security group needs to allow access from certain ports to ensure normal communications.

      +

      Default worker node security group ID of the cluster. If specified, the cluster will be bound to the target security group. Otherwise, the system will automatically create a default worker node security group for you. The default worker node security group needs to allow access from certain ports to ensure normal communications.
      -
      Table 12 Data structure of the status field

      Parameter

      +
      - - - - - - - - - - - - - - - -
      Table 12 PackageConfiguration

      Parameter

      Type

      +

      Type

      Description

      +

      Description

      phase

      +

      name

      String

      +

      String

      Cluster status. Possible values:

      -
      • Available: The cluster is running properly.
      • Unavailable: The cluster is exhibiting unexpected behavior. Manually delete the cluster or contact the administrator to delete the cluster.
      • ScalingUp: Nodes are being added to the cluster.
      • ScalingDown: The cluster is being downsized to fewer nodes.
      • Creating: The cluster is being created.
      • Deleting: The cluster is being deleted.
      • Upgrading: The cluster is being upgraded.
      • Resizing: Cluster specifications are being changed.
      • Empty: The cluster has no resources.
      +

      Details:

      +

      Component name

      +

      Constraints:

      +

      None

      +

      Options:

      +

      N/A

      +

      Default value:

      +

      N/A

      reason

      +

      configurations

      String

      +

      Array of ConfigurationItem objects

      Reason of cluster state transition. This parameter is returned if the cluster is not in the Available state.

      -

      message

      -

      String

      -

      Detailed information about why the cluster changes to the current state. This parameter is returned if the cluster is not in the Available state.

      -

      endpoints

      -

      endpoint object

      -

      Access address of the kube-apiserver in the cluster.

      +

      Details:

      +

      Component configuration items

      +

      Constraints:

      +

      None
      -
      Table 13 Data structure of the endpoint field

      Parameter

      +
      - - - - - - - - - +
      Table 13 ConfigurationItem

      Parameter

      Type

      +

      Type

      Description

      +

      Description

      internal

      +

      name

      String

      +

      String

      Internal network address.

      +

      Details:

      +

      Configuration overrides of the default components in a cluster.

      +

      Constraints:

      +

      If you specify a component or parameter that is not supported, this configuration item will be ignored.

      +

      Options:

      +

      N/A

      +

      Default value:

      +

      N/A

      external

      +

      value

      String

      +

      AnyType

      External network address.

      +

      Details:

      +

      Configuration overrides of the default components in a cluster.

      +

      Constraints:

      +

      If you specify a component or parameter that is not supported, this configuration item will be ignored.

      +

      Options:

      +

      N/A

      +

      Default value:

      +

      N/A

      external_otc

      +
      +
      + +
      + + + + + - - + + + + + + + + + + + + + + +
      Table 14 Data structure of the status field

      Parameter

      +

      Type

      +

      Description

      +

      phase

      String

      +

      String

      Endpoint of the cluster to be accessed through API Gateway.

      +

      Cluster status. Possible values:

      +
      • Available: The cluster is running properly.
      • Unavailable: The cluster is exhibiting unexpected behavior. Manually delete the cluster or contact the administrator to delete the cluster.
      • ScalingUp: Nodes are being added to the cluster.
      • ScalingDown: The cluster is being downsized to fewer nodes.
      • Creating: The cluster is being created.
      • Deleting: The cluster is being deleted.
      • Upgrading: The cluster is being upgraded.
      • Resizing: Cluster specifications are being changed.
      • Empty: The cluster has no resources.
      +

      reason

      +

      String

      +

      Reason of cluster state transition. This parameter is returned if the cluster is not in the Available state.

      +

      message

      +

      String

      +

      Detailed information about why the cluster changes to the current state. This parameter is returned if the cluster is not in the Available state.

      +

      endpoints

      +

      endpoint object

      +

      Access address of the kube-apiserver in the cluster.

      +
      +
      + +
      + + + + + + + + + + + + + + + @@ -626,9 +712,9 @@ } } -

      Status Code

      Table 14 describes the status code of this API.

      +

      Status Code

      Table 16 describes the status code of this API.

      -
      Table 15 Data structure of the endpoint field

      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 14 Status code

      Status Code

      +
      diff --git a/docs/cce/api-ref/cce_02_0242.html b/docs/cce/api-ref/cce_02_0242.html index e5284af16..f6bef7b91 100644 --- a/docs/cce/api-ref/cce_02_0242.html +++ b/docs/cce/api-ref/cce_02_0242.html @@ -318,7 +318,7 @@
      Table 16 Status code

      Status Code

      Description

      Tag of a VM.

      The format is key-value pair. The number of key-value pairs cannot exceed 20.

      -
      • Key: Only letters, digits, hyphens (-), underscores (_), and at signs (@) are supported.
      • Value: Only letters, digits, hyphens (-), underscores (_), and at signs (@) are supported.
      +
      • Key: Only uppercase letters, lowercase letters, digits, special characters (-_@), and Unicode characters (\u4E00-\u9FA5) are supported. It can contain a maximum of 36 characters. The key cannot be empty.
      • Value: Only uppercase letters, lowercase letters, digits, special characters (-_@), and Unicode characters (\u4E00-\u9FA5) are supported. It can contain a maximum of 43 characters. The value can be empty.

      Example:

      "userTags": [
 {
@@ -632,7 +632,7 @@

      String

      Disk type. For details, see the description of root_volume in Creating an ECS.

      -
      • SATA: common I/O
      • SAS: high I/O
      • SSD: ultra-high I/O
      • GPSSD: general-purpose SSD
      • ESSD: extreme SSD
      +
      • SAS: high I/O
      • SSD: ultra-high I/O
      • GPSSD: general-purpose SSD
      • ESSD: extreme SSD

      size

      @@ -959,7 +959,7 @@

      String

      EVS disk type.

      -
      • SATA: common I/O
      • SAS: high I/O
      • SSD: ultra-high I/O
      • GPSSD: general-purpose SSD
      • ESSD: extreme SSD
      +
      • SAS: high I/O
      • SSD: ultra-high I/O
      • GPSSD: general-purpose SSD
      • ESSD: extreme SSD

      metadataEncrypted

      @@ -1516,7 +1516,7 @@

      The format is key-value pair.

      It is recommended that you use TMS's predefined tag function to add the same tag to different cloud resources.

      -
      • The tag key can consist of only uppercase letters, lowercase letters, digits, hyphens (-), underscores (_), and Unicode characters.
      • The tag value can contain only uppercase letters, lowercase letters, digits, hyphens (-), underscores (_), and at signs (@).
      +
      • Key: Only uppercase letters, lowercase letters, digits, special characters (-_@), and Unicode characters (\u4E00-\u9FA5) are supported. It can contain a maximum of 36 characters. The key cannot be empty.
      • Value: Only uppercase letters, lowercase letters, digits, special characters (-_@), and Unicode characters (\u4E00-\u9FA5) are supported. It can contain a maximum of 43 characters. The value can be empty.

      Example:

      "userTags": [
 {
@@ -1905,7 +1905,7 @@

      String

      EVS disk type.

      -
      • SATA: common I/O
      • SAS: high I/O
      • SSD: ultra-high I/O
      • GPSSD: general-purpose SSD
      • ESSD: extreme SSD
      +
      • SAS: high I/O
      • SSD: ultra-high I/O
      • GPSSD: general-purpose SSD
      • ESSD: extreme SSD

      metadataEncrypted

      @@ -2091,38 +2091,38 @@ "size": 100 } ], - "storage": { - "storageSelectors": [ - { - "name": "cceUse", - "storageType": "evs", - "matchLabels": { - "size": "100", - "volumeType": "SAS", - "count": "1" - } - } - ], - "storageGroups": [ - { - "name": "vgpaas", - "selectorNames": [ - "cceUse" - ], - "cceManaged": true, - "virtualSpaces": [ - { - "name": "runtime", - "size": "90%" - }, - { - "name": "kubernetes", - "size": "10%" - } - ] - } - ] - }, + "storage": { + "storageSelectors": [ + { + "name": "cceUse", + "storageType": "evs", + "matchLabels": { + "size": "100", + "volumeType": "SAS", + "count": "1" + } + } + ], + "storageGroups": [ + { + "name": "vgpaas", + "selectorNames": [ + "cceUse" + ], + "cceManaged": true, + "virtualSpaces": [ + { + "name": "runtime", + "size": "90%" + }, + { + "name": "kubernetes", + "size": "10%" + } + ] + } + ] + }, "publicIP": { "count": 2, "eip": { @@ -2178,38 +2178,38 @@ "hw:passthrough": true } ], - "storage": { - "storageSelectors": [ - { - "name": "cceUse", - "storageType": "evs", - "matchLabels": { - "size": "100", - "volumeType": "SAS", - "count": "1" - } - } - ], - "storageGroups": [ - { - "name": "vgpaas", - "selectorNames": [ - "cceUse" - ], - "cceManaged": true, - "virtualSpaces": [ - { - "name": "runtime", - "size": "90%" - }, - { - "name": "kubernetes", - "size": "10%" - } - ] - } - ] - }, + "storage": { + "storageSelectors": [ + { + "name": "cceUse", + "storageType": "evs", + "matchLabels": { + "size": "100", + "volumeType": "SAS", + "count": "1" + } + } + ], + "storageGroups": [ + { + "name": "vgpaas", + "selectorNames": [ + "cceUse" + ], + "cceManaged": true, + "virtualSpaces": [ + { + "name": "runtime", + "size": "90%" + }, + { + "name": "kubernetes", + "size": "10%" + } + ] + } + ] + }, "count": 1, "runtime": { "name": "containerd" diff --git a/docs/cce/api-ref/cce_02_0243.html b/docs/cce/api-ref/cce_02_0243.html index 48da2167c..9956cbcb8 100644 --- a/docs/cce/api-ref/cce_02_0243.html +++ b/docs/cce/api-ref/cce_02_0243.html @@ -674,7 +674,7 @@

      String

      EVS disk type.

      -
      • SATA: common I/O
      • SAS: high I/O
      • SSD: ultra-high I/O
      • GPSSD: general-purpose SSD
      • ESSD: extreme SSD
      +
      • SAS: high I/O
      • SSD: ultra-high I/O
      • GPSSD: general-purpose SSD
      • ESSD: extreme SSD

      metadataEncrypted

      diff --git a/docs/cce/api-ref/cce_02_0244.html b/docs/cce/api-ref/cce_02_0244.html index 82cc3ffcc..45db42dd3 100644 --- a/docs/cce/api-ref/cce_02_0244.html +++ b/docs/cce/api-ref/cce_02_0244.html @@ -134,38 +134,38 @@ "size": 100 } ], - "storage": { - "storageSelectors": [ - { - "name": "cceUse", - "storageType": "evs", - "matchLabels": { - "size": "100", - "volumeType": "SAS", - "count": "1" - } - } - ], - "storageGroups": [ - { - "name": "vgpaas", - "selectorNames": [ - "cceUse" - ], - "cceManaged": true, - "virtualSpaces": [ - { - "name": "runtime", - "size": "90%" - }, - { - "name": "kubernetes", - "size": "10%" - } - ] - } - ] - }, + "storage": { + "storageSelectors": [ + { + "name": "cceUse", + "storageType": "evs", + "matchLabels": { + "size": "100", + "volumeType": "SAS", + "count": "1" + } + } + ], + "storageGroups": [ + { + "name": "vgpaas", + "selectorNames": [ + "cceUse" + ], + "cceManaged": true, + "virtualSpaces": [ + { + "name": "runtime", + "size": "90%" + }, + { + "name": "kubernetes", + "size": "10%" + } + ] + } + ] + }, "publicIP": { "eip": { "bandwidth": {} diff --git a/docs/cce/api-ref/cce_02_0246.html b/docs/cce/api-ref/cce_02_0246.html index facd4f81c..6a3829c1a 100644 --- a/docs/cce/api-ref/cce_02_0246.html +++ b/docs/cce/api-ref/cce_02_0246.html @@ -253,38 +253,38 @@ "size": 100 } ], - "storage": { - "storageSelectors": [ - { - "name": "cceUse", - "storageType": "evs", - "matchLabels": { - "size": "100", - "volumeType": "SAS", - "count": "1" - } - } - ], - "storageGroups": [ - { - "name": "vgpaas", - "selectorNames": [ - "cceUse" - ], - "cceManaged": true, - "virtualSpaces": [ - { - "name": "runtime", - "size": "90%" - }, - { - "name": "kubernetes", - "size": "10%" - } - ] - } - ] - }, + "storage": { + "storageSelectors": [ + { + "name": "cceUse", + "storageType": "evs", + "matchLabels": { + "size": "100", + "volumeType": "SAS", + "count": "1" + } + } + ], + "storageGroups": [ + { + "name": "vgpaas", + "selectorNames": [ + "cceUse" + ], + "cceManaged": true, + "virtualSpaces": [ + { + "name": "runtime", + "size": "90%" + }, + { + "name": "kubernetes", + "size": "10%" + } + ] + } + ] + }, "publicIP": { "eip": { "bandwidth": {} diff --git a/docs/cce/api-ref/cce_02_0269.html b/docs/cce/api-ref/cce_02_0269.html index 304e94ced..82b7cec31 100644 --- a/docs/cce/api-ref/cce_02_0269.html +++ b/docs/cce/api-ref/cce_02_0269.html @@ -514,7 +514,7 @@

      String

      Disk type. For details about possible values, see the description of the root_volume parameter in the API used to create an ECS in the ECS API reference.

      -
      • SATA: common I/O
      • SAS: high I/O
      • SSD: ultra-high I/O
      • GPSSD: general-purpose SSD
      • ESSD: extreme SSD
      +
      • SAS: high I/O
      • SSD: ultra-high I/O
      • GPSSD: general-purpose SSD
      • ESSD: extreme SSD

      extendParam

      @@ -1005,7 +1005,7 @@

      String

      EVS disk type.

      -
      • SATA: common I/O
      • SAS: high I/O
      • SSD: ultra-high I/O
      • GPSSD: general-purpose SSD
      • ESSD: extreme SSD
      +
      • SAS: high I/O
      • SSD: ultra-high I/O
      • GPSSD: general-purpose SSD
      • ESSD: extreme SSD

      metadataEncrypted

      diff --git a/docs/cce/api-ref/cce_02_0273.html b/docs/cce/api-ref/cce_02_0273.html index 01faffce0..e920a6c46 100644 --- a/docs/cce/api-ref/cce_02_0273.html +++ b/docs/cce/api-ref/cce_02_0273.html @@ -1,6 +1,6 @@ -

      Change History

      +

      Change History

      @@ -8,7 +8,41 @@ - + + + + + + + + + + + + + + + - - - diff --git a/docs/cce/api-ref/cce_02_0323.html b/docs/cce/api-ref/cce_02_0323.html index 9fc6c8221..8946458fd 100644 --- a/docs/cce/api-ref/cce_02_0323.html +++ b/docs/cce/api-ref/cce_02_0323.html @@ -187,7 +187,7 @@ - diff --git a/docs/cce/api-ref/cce_02_0354.html b/docs/cce/api-ref/cce_02_0354.html index 374472424..eb050ce51 100644 --- a/docs/cce/api-ref/cce_02_0354.html +++ b/docs/cce/api-ref/cce_02_0354.html @@ -343,7 +343,7 @@ - - -
      Table 1 Change history

      Date

      2025-02-26

      +

      2025-06-30

      +

      Add:

      + +

      Update:

      + +

      Delete:

      + +

      2025-06-05

      +

      Add:

      +

      Added Configuration Management.

      +

      2025-05-09

      +

      Update:

      +

      Updated the userTags field in Table 5 , Table 25 , Table 8 , Table 8 , Table 6.

      +

      2025-03-20

      +

      Update:

      +

      Updated the mode field in Table 8 and Table 23.

      +

      2025-03-10

      +

      Add:

      + +

      2025-02-26

      Add:

      Added the timezone field in Creating a Cluster.

      @@ -23,19 +57,18 @@

      2024-11-25

      Add:

      -

      Added NGINX Ingress Controller.

      +

      Update:

      -

      Updated Volcano Scheduler.

      -

      Updated the values field in Installing an Add-on Instance and Updating an Add-on Instance. Added some hyperlink to the "Add-on Instance Parameters".

      -

      Updated the volumetype field in Creating a Node , Reading a Specified Node , Accepting a Node , Resetting a Node , Creating a Node Pool , Querying a Specified Node Pool , Listing All Node Pools in a Specified Cluster and Deleting a Node Pool.

      + +

      2024-10-23

      Add:

      -

      Added Add-on Instance Parameters.

      +

      Update:

      -

      Updated Node Flavor Description.

      +

      2024-08-30

      @@ -110,12 +143,12 @@

      2020-05-08

      		 +

      2020-04-14

      		 +

      2020-03-25

      diff --git a/docs/cce/api-ref/cce_02_0322.html b/docs/cce/api-ref/cce_02_0322.html index ea0285626..1797abc01 100644 --- a/docs/cce/api-ref/cce_02_0322.html +++ b/docs/cce/api-ref/cce_02_0322.html @@ -154,7 +154,7 @@

      Object

      Add-on template installation parameters (varying depending on the add-on). During the add-on upgrade, you need to specify all the installation parameters. If the parameters are not specified, the default values in the add-on template are used. The current add-on installation parameters can be obtained through the API for querying add-on instances. For details, see Add-on Instance Parameters.

      +

      Add-on template installation parameters (varying depending on the add-on). During the add-on upgrade, you need to specify all the installation parameters. If the parameters are not specified, the default values in the add-on template are used. The current add-on installation parameters can be obtained through the API for querying add-on instances. For details, see Add-on Instance Parameters.

      Object

      Add-on template installation parameters (varying depending on the add-on). During the add-on upgrade, you need to specify all the installation parameters. If the parameters are not specified, the default values in the add-on template are used. The current add-on installation parameters can be obtained through the API for querying add-on instances. For details, see Add-on Instance Parameters.

      +

      Add-on template installation parameters (varying depending on the add-on). During the add-on upgrade, you need to specify all the installation parameters. If the parameters are not specified, the default values in the add-on template are used. The current add-on installation parameters can be obtained through the API for querying add-on instances. For details, see Add-on Instance Parameters.

      Tag of a VM.

      The format is key-value pair. The number of key-value pairs cannot exceed 20.

      -
      • Key: Only letters, digits, hyphens (-), underscores (_), and at signs (@) are supported.
      • Value: Only letters, digits, hyphens (-), underscores (_), and at signs (@) are supported.
      +
      • Key: Only uppercase letters, lowercase letters, digits, special characters (-_@), and Unicode characters (\u4E00-\u9FA5) are supported. It can contain a maximum of 36 characters. The key cannot be empty.
      • Value: Only uppercase letters, lowercase letters, digits, special characters (-_@), and Unicode characters (\u4E00-\u9FA5) are supported. It can contain a maximum of 43 characters. The value can be empty.

      Example:

      "userTags": [
 {
@@ -464,8 +464,8 @@

      String

      Disk type. For details, see the description of root_volume in Creating an ECS.

      -
      • SATA: common I/O disk type.
      • SAS: high I/O disk type.
      • SSD: ultra-high I/O disk type.
      • GPSSD: general-purpose SSD.
      • ESSD: extreme SSD.
      +

      Disk type. For details, see the description of root_volume in Creating an ECS.

      +
      • SAS: high I/O disk type.
      • SSD: ultra-high I/O disk type.
      • GPSSD: general-purpose SSD.
      • ESSD: extreme SSD.

      size

      @@ -484,7 +484,7 @@

      Map<String,Object>

      Disk extension parameter. For details, see the description of the extendparam parameter in Creating an ECS.

      +

      Disk extension parameter. For details, see the description of the extendparam parameter in Creating an ECS.

      hw:passthrough

      @@ -1054,7 +1054,7 @@

      String

      EVS disk type.

      -
      • SATA: common I/O
      • SAS: high I/O
      • SSD: ultra-high I/O
      • GPSSD: general-purpose SSD
      • ESSD: extreme SSD
      +
      • SAS: high I/O
      • SSD: ultra-high I/O
      • GPSSD: general-purpose SSD
      • ESSD: extreme SSD

      metadataEncrypted

      @@ -1650,38 +1650,38 @@ } } ], - "storage": { - "storageSelectors": [ - { - "name": "cceUse", - "storageType": "evs", - "matchLabels": { - "size": "100", - "volumeType": "SAS", - "count": "1" - } - } - ], - "storageGroups": [ - { - "name": "vgpaas", - "selectorNames": [ - "cceUse" - ], - "cceManaged": true, - "virtualSpaces": [ - { - "name": "runtime", - "size": "90%" - }, - { - "name": "kubernetes", - "size": "10%" - } - ] - } - ] - }, + "storage": { + "storageSelectors": [ + { + "name": "cceUse", + "storageType": "evs", + "matchLabels": { + "size": "100", + "volumeType": "SAS", + "count": "1" + } + } + ], + "storageGroups": [ + { + "name": "vgpaas", + "selectorNames": [ + "cceUse" + ], + "cceManaged": true, + "virtualSpaces": [ + { + "name": "runtime", + "size": "90%" + }, + { + "name": "kubernetes", + "size": "10%" + } + ] + } + ] + }, "runtime": { "name":"docker" }, @@ -1779,38 +1779,38 @@ "hw:passthrough": true } ], - "storage": { - "storageSelectors": [ - { - "name": "cceUse", - "storageType": "evs", - "matchLabels": { - "size": "100", - "volumeType": "SAS", - "count": "1" - } - } - ], - "storageGroups": [ - { - "name": "vgpaas", - "selectorNames": [ - "cceUse" - ], - "cceManaged": true, - "virtualSpaces": [ - { - "name": "runtime", - "size": "90%" - }, - { - "name": "kubernetes", - "size": "10%" - } - ] - } - ] - }, + "storage": { + "storageSelectors": [ + { + "name": "cceUse", + "storageType": "evs", + "matchLabels": { + "size": "100", + "volumeType": "SAS", + "count": "1" + } + } + ], + "storageGroups": [ + { + "name": "vgpaas", + "selectorNames": [ + "cceUse" + ], + "cceManaged": true, + "virtualSpaces": [ + { + "name": "runtime", + "size": "90%" + }, + { + "name": "kubernetes", + "size": "10%" + } + ] + } + ] + }, "runtime": { "name":"containerd" }, diff --git a/docs/cce/api-ref/cce_02_0355.html b/docs/cce/api-ref/cce_02_0355.html index 1faf8824a..eafc1c5d0 100644 --- a/docs/cce/api-ref/cce_02_0355.html +++ b/docs/cce/api-ref/cce_02_0355.html @@ -502,7 +502,7 @@

      String

      Disk type. For details, see the description of root_volume in Creating an ECS.

      -
      • SATA: common I/O
      • SAS: high I/O
      • SSD: ultra-high I/O
      • GPSSD: general-purpose SSD
      • ESSD: extreme SSD
      +
      • SAS: high I/O
      • SSD: ultra-high I/O
      • GPSSD: general-purpose SSD
      • ESSD: extreme SSD

      size

      @@ -998,7 +998,7 @@

      String

      EVS disk type.

      -
      • SATA: common I/O
      • SAS: high I/O
      • SSD: ultra-high I/O
      • GPSSD: general-purpose SSD
      • ESSD: extreme SSD
      +
      • SAS: high I/O
      • SSD: ultra-high I/O
      • GPSSD: general-purpose SSD
      • ESSD: extreme SSD

      metadataEncrypted

      @@ -1189,38 +1189,38 @@ } } ], - "storage": { - "storageSelectors": [ - { - "name": "cceUse", - "storageType": "evs", - "matchLabels": { - "size": "100", - "volumeType": "SAS", - "count": "1" - } - } - ], - "storageGroups": [ - { - "name": "vgpaas", - "selectorNames": [ - "cceUse" - ], - "cceManaged": true, - "virtualSpaces": [ - { - "name": "runtime", - "size": "90%" - }, - { - "name": "kubernetes", - "size": "10%" - } - ] - } - ] - }, + "storage": { + "storageSelectors": [ + { + "name": "cceUse", + "storageType": "evs", + "matchLabels": { + "size": "100", + "volumeType": "SAS", + "count": "1" + } + } + ], + "storageGroups": [ + { + "name": "vgpaas", + "selectorNames": [ + "cceUse" + ], + "cceManaged": true, + "virtualSpaces": [ + { + "name": "runtime", + "size": "90%" + }, + { + "name": "kubernetes", + "size": "10%" + } + ] + } + ] + }, "runtime": { "name":"docker" }, diff --git a/docs/cce/api-ref/cce_02_0356.html b/docs/cce/api-ref/cce_02_0356.html index 5a5baac14..de1bb5f95 100644 --- a/docs/cce/api-ref/cce_02_0356.html +++ b/docs/cce/api-ref/cce_02_0356.html @@ -165,7 +165,7 @@

      Yes

      nodeTemplate object

      +

      Table6 Data structure of the nodeTemplate field object

      Parameters of the node pool template.

      If az is set to random, when you create a node pool or update the number of nodes in a node pool, a scaling task is triggered. The system selects an AZ from all AZs where scaling is allowed to add nodes based on priorities.

      @@ -348,38 +348,38 @@ } } ], - "storage": { - "storageSelectors": [ - { - "name": "cceUse", - "storageType": "evs", - "matchLabels": { - "size": "100", - "volumeType": "SAS", - "count": "1" - } - } - ], - "storageGroups": [ - { - "name": "vgpaas", - "selectorNames": [ - "cceUse" - ], - "cceManaged": true, - "virtualSpaces": [ - { - "name": "runtime", - "size": "90%" - }, - { - "name": "kubernetes", - "size": "10%" - } - ] - } - ] - }, + "storage": { + "storageSelectors": [ + { + "name": "cceUse", + "storageType": "evs", + "matchLabels": { + "size": "100", + "volumeType": "SAS", + "count": "1" + } + } + ], + "storageGroups": [ + { + "name": "vgpaas", + "selectorNames": [ + "cceUse" + ], + "cceManaged": true, + "virtualSpaces": [ + { + "name": "runtime", + "size": "90%" + }, + { + "name": "kubernetes", + "size": "10%" + } + ] + } + ] + }, "runtime": { "name":"docker" }, diff --git a/docs/cce/api-ref/cce_02_0357.html b/docs/cce/api-ref/cce_02_0357.html index 2db3d5ef7..2ebaa9457 100644 --- a/docs/cce/api-ref/cce_02_0357.html +++ b/docs/cce/api-ref/cce_02_0357.html @@ -454,7 +454,7 @@

      String

      Disk type. For details about possible values, see the description of the root_volume parameter in the API used to create an ECS in the ECS API reference.

      -
      • SATA: common I/O
      • SAS: high I/O
      • SSD: ultra-high I/O
      • GPSSD: general-purpose SSD
      • ESSD: extreme SSD
      +
      • SAS: high I/O
      • SSD: ultra-high I/O
      • GPSSD: general-purpose SSD
      • ESSD: extreme SSD

      extendParam

      @@ -945,7 +945,7 @@

      String

      EVS disk type.

      -
      • SATA: common I/O
      • SAS: high I/O
      • SSD: ultra-high I/O
      • GPSSD: general-purpose SSD
      • ESSD: extreme SSD
      +
      • SAS: high I/O
      • SSD: ultra-high I/O
      • GPSSD: general-purpose SSD
      • ESSD: extreme SSD

      metadataEncrypted

      @@ -1136,38 +1136,38 @@ } } ], - "storage": { - "storageSelectors": [ - { - "name": "cceUse", - "storageType": "evs", - "matchLabels": { - "size": "100", - "volumeType": "SAS", - "count": "1" - } - } - ], - "storageGroups": [ - { - "name": "vgpaas", - "selectorNames": [ - "cceUse" - ], - "cceManaged": true, - "virtualSpaces": [ - { - "name": "runtime", - "size": "90%" - }, - { - "name": "kubernetes", - "size": "10%" - } - ] - } - ] - }, + "storage": { + "storageSelectors": [ + { + "name": "cceUse", + "storageType": "evs", + "matchLabels": { + "size": "100", + "volumeType": "SAS", + "count": "1" + } + } + ], + "storageGroups": [ + { + "name": "vgpaas", + "selectorNames": [ + "cceUse" + ], + "cceManaged": true, + "virtualSpaces": [ + { + "name": "runtime", + "size": "90%" + }, + { + "name": "kubernetes", + "size": "10%" + } + ] + } + ] + }, "runtime": { "name":"docker" }, diff --git a/docs/cce/api-ref/cce_02_0366.html b/docs/cce/api-ref/cce_02_0366.html index cf3581952..80a072cc0 100644 --- a/docs/cce/api-ref/cce_02_0366.html +++ b/docs/cce/api-ref/cce_02_0366.html @@ -24,6 +24,8 @@
    • Cloud Native Cluster Monitoring
      • +
    • Cloud Native Log Collection
      +
      • diff --git a/docs/cce/api-ref/cce_02_0422.html b/docs/cce/api-ref/cce_02_0422.html new file mode 100644 index 000000000..4f59f245e --- /dev/null +++ b/docs/cce/api-ref/cce_02_0422.html @@ -0,0 +1,418 @@ + + +

      Cloud Native Log Collection

      +

      Add-on Overview

      The Cloud Native Logging add-on (log-agent) is developed based on Fluent Bit and OpenTelemetry for collecting logs and Kubernetes events. This add-on supports CRD-based log collection policies. It collects and forwards standard output logs, container file logs, node logs, and Kubernetes event logs in a cluster based on configured policies. It also reports Kubernetes events to AOM for configuring event alarms. By default, all abnormal events and some normal events are reported.

      +
      +

      Add-on Parameters

      +
      + + + + + + + + + + + + + + + + + + + + + +
      Table 1 Parameters

      Parameter

      +

      Mandatory

      +

      Type

      +

      Description

      +

      basic

      +

      No

      +

      object

      +

      Basic configuration parameters, which do not need to be specified

      +

      flavor

      +

      Yes

      +

      Table 2 object

      +

      Flavor parameters

      +

      custom

      +

      Yes

      +

      Table 3 object

      +

      Custom parameters

      +
      +
      + +
      + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Table 2 Configuration of flavor

      Parameter

      +

      Mandatory

      +

      Type

      +

      Description

      +

      description

      +

      No

      +

      String

      +

      Add-on description

      +

      name

      +

      Yes

      +

      String

      +

      Add-on specification name. The value is fixed at Single-instance.

      +

      replicas

      +

      Yes

      +

      String

      +

      Number of otel-collector component instances. The default value is 1.

      +

      resources

      +

      Yes

      +

      resources object

      +

      Container resource (CPU and memory) quotas

      +
      +
      + +
      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Table 3 Configuration of custom

      Parameter

      +

      Mandatory

      +

      Type

      +

      Description

      +

      caCert

      +

      Yes

      +

      String

      +

      Specifies a client certificate, which is encrypted using Base64. This parameter is optional during installation. It is generated by the CCE add-on center and used for two-way authentication between components and webhook requests.

      +

      Domain name to be issued: *.monitoring.svc.

      +

      serverCert

      +

      Yes

      +

      String

      +

      Specifies a server certificate, which is encrypted using Base64. This parameter is optional during installation. It is generated by CCE add-ons and used for two-way authentication between components and webhook requests. Domain name to be issued: *.monitoring.svc.

      +

      serverKey

      +

      Yes

      +

      String

      +

      Specifies the private key of a server, which is encrypted using Base64. This parameter is optional during installation. It is generated by CCE add-ons and used for two-way authentication between components and webhook requests. Domain name to be issued: *.monitoring.svc.

      +

      accessKey

      +

      No

      +

      String

      +

      Specifies the access key ID of a user, which is used to request AOM and LTS APIs. If this parameter is left blank, a temporary AK/SK is used.

      +

      secretKey

      +

      No

      +

      String

      +

      Specifies the access key of a user, which is used to request AOM and LTS APIs. If this parameter is left blank, a temporary AK/SK is used.

      +

      createDefaultStdout

      +

      No

      +

      Bool

      +

      Specifies whether to create the default policy for collecting container standard output logs and reporting them to LTS. This parameter is valid only after it is specified during the add-on installation. The default value is false.

      +

      createDefaultEvent

      +

      No

      +

      Bool

      +

      Specifies whether to create the default policy for collecting Kubernetes events and reporting them to LTS. This parameter is valid only after it is specified during the add-on installation. The default value is false.

      +

      multiAZEnabled

      +

      No

      +

      Bool

      +

      Specifies whether to deploy the add-on pods in multiple AZs. The default value is false. If this parameter is set to true, cross-AZ deployment is forcibly performed. If this parameter is set to false, cross-AZ deployment is preferred.

      +

      cluster_category

      +

      No

      +

      String

      +

      The value is fixed at CCE.

      +

      ltsAccessEndpoint

      +

      No

      +

      String

      +

      Specifies the address for reporting logs to LTS. If this parameter is left blank, the address specified in basic is used.

      +

      ltsEndpoint

      +

      No

      +

      String

      +

      Specifies the address of the LTS APIs. If this parameter is left blank, the address specified in basic is used.

      +

      aomEndpoint

      +

      No

      +

      String

      +

      Specifies the address for reporting events to AOM. If this parameter is left blank, the address specified in basic is used.

      +

      projectID

      +

      Yes

      +

      String

      +

      Specifies the ID of the project to which the current CCE cluster belongs. This parameter is optional during installation.

      +

      clusterID

      +

      Yes

      +

      String

      +

      Specifies the ID of the current CCE cluster. This parameter is optional during installation.

      +

      clusterName

      +

      Yes

      +

      String

      +

      Specifies the name of the current CCE cluster.

      +
      +
      + +
      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Table 4 Data structure of the resources field

      Parameter

      +

      Mandatory

      +

      Type

      +

      Description

      +

      limitsCpu

      +

      Yes

      +

      String

      +

      CPU size limit (unit: m)

      +

      limitsMem

      +

      Yes

      +

      String

      +

      Memory size limit (unit: Mi)

      +

      name

      +

      Yes

      +

      String

      +

      Component name. Options:

      +

      fluent-bit: component for collecting node logs

      +

      cop-logs: generates soft links for collected files on each node.

      +

      log-operator: generates fluent-bit and otel-collector configurations.

      +

      otel-collector: reports collected logs and events to AOM and LTS.

      +

      requestsCpu

      +

      Yes

      +

      String

      +

      Requested CPU size (unit: m)

      +

      requestsMem

      +

      Yes

      +

      String

      +

      Requested memory size (unit: Mi)

      +
      +
      +
      +

      Example Request

      {
+  "kind": "Addon",
+  "apiVersion": "v3",
+  "metadata": {
+    "annotations": {
+      "addon.install/type": "install"
+    }
+  },
+  "spec": {
+    "clusterID": "ccbe7bdf-4**9-3**b-b**4-0********78",
+    "version": "1.4.4",
+    "addonTemplateName": "log-agent",
+    "values": {
+      "basic": {
+        "aomEndpoint": "https://***",
+        "iam_url": "***",
+        "ltsAccessEndpoint": "https://***:8102",
+        "ltsEndpoint": "https://***",
+        "region": "***",
+        "swr_addr": "***",
+        "swr_user": "***",
+        "rbac_enabled": true,
+        "cluster_version": "v1.25"
+      },
+      "flavor": {
+        "description": "Recommanded when the number of logs per second does not exceed 5000.",
+        "name": "Low",
+        "replicas": 1,
+        "resources": [
+          {
+            "limitsCpu": "500m",
+            "limitsMem": "500Mi",
+            "name": "fluent-bit",
+            "requestsCpu": "100m",
+            "requestsMem": "200Mi"
+          },
+          {
+            "limitsCpu": 1,
+            "limitsMem": "500Mi",
+            "name": "cop-logs",
+            "requestsCpu": "100m",
+            "requestsMem": "100Mi"
+          },
+          {
+            "limitsCpu": "500m",
+            "limitsMem": "500Mi",
+            "name": "log-operator",
+            "requestsCpu": "100m",
+            "requestsMem": "100Mi"
+          },
+          {
+            "limitsCpu": 1,
+            "limitsMem": "2Gi",
+            "name": "otel-collector",
+            "requestsCpu": "200m",
+            "requestsMem": "1Gi"
+          }
+        ],
+        "category": [
+          "CCE",
+          "Turbo"
+        ]
+      },
+      "custom": {
+        "accessKey": "",
+        "aomEndpoint": "https://***",
+        "aomPrivateEndpointIP": "",
+        "caCert": "",
+        "clusterID": "",
+        "clusterName": "clusterName",
+        "cluster_category": "CCE",
+        "createAudit": false,
+        "createDefaultEvent": false,
+        "createDefaultEventToAOM": true,
+        "createDefaultStdout": false,
+        "createKubeApiserver": false,
+        "createKubeControllerManager": false,
+        "createKubeScheduler": false,
+        "ltsAccessEndpoint": "https://***:8102",
+        "ltsAuditStreamID": "",
+        "ltsEndpoint": "https://***",
+        "ltsEventStreamID": "",
+        "ltsGroupID": "",
+        "ltsKubeApiserverStreamID": "",
+        "ltsKubeControllerManagerStreamID": "",
+        "ltsKubeSchedulerStreamID": "",
+        "ltsLogReportDomain": "",
+        "ltsPrivateEndpointIP": "",
+        "ltsStdoutStreamID": "",
+        "multiAZEnabled": false,
+        "paasakskEnable": true,
+        "projectID": "",
+        "secretKey": "",
+        "securityToken": "",
+        "serverCert": "",
+        "serverKey": ""
+      }
+    }
+  }
+}
      +
      +
      +
      +
      +
      Parent topic: Add-on Instance Parameters
      +
      +
      + diff --git a/docs/cce/api-ref/configuration_lifecycle_management.html b/docs/cce/api-ref/configuration_lifecycle_management.html new file mode 100644 index 000000000..435bafb23 --- /dev/null +++ b/docs/cce/api-ref/configuration_lifecycle_management.html @@ -0,0 +1,22 @@ + + +

      Configuration Management

      +

      +
      + +