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.
+ +
URI
POST /api/v3/projects/{project_id}/clusters/{cluster_id}/operation/resize
+ +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
+Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
Content-Type + |
+Yes + |
+String + |
+Details: +The request body type or format +Constraints: +The GET method is not verified. +Options: + +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 + |
+
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. +
NOTE:
+The fields in the parameters are described as follows: +
|
+
extendParam + |
+No + |
+extendParam object + |
+Extended field for changing cluster specifications + |
+
Response Parameters
Status code: 201
+ +Parameter + |
+Type + |
+Description + |
+
|---|---|---|
jobID + |
+String + |
+Job ID + |
+
Example Requests
+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.
+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
+ +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
+Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
Content-Type + |
+Yes + |
+String + |
+Details: +The request body type or format +Constraints: +The GET method is not verified. +Options: + +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
+ +Parameter + |
+Type + |
+Description + |
+
|---|---|---|
{User defined key} + |
+Map<String,Array<PackageOptions>> + |
+Response body for obtaining the parameter configuration list of a cluster + |
+
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. + + |
+
empty + |
+Boolean + |
+Whether the configuration item can be empty. Options: + + |
+
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.
+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
+ +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
+Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
Content-Type + |
+Yes + |
+String + |
+Details: +The request body type or format +Constraints: +The GET method is not verified. +Options: + +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
+ +Parameter + |
+Type + |
+Description + |
+
|---|---|---|
{User defined key} + |
+Map<String,Array<PackageOptions>> + |
+Response body for obtaining the parameter configuration list of a specified node pool + |
+
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. + + |
+
empty + |
+Boolean + |
+Whether the configuration item can be empty. Options: + + |
+
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.
+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
+ +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
+Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
Content-Type + |
+Yes + |
+String + |
+Details: +The request body type or format +Constraints: +The GET method is not verified. +Options: + +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
+ +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 + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
packages + |
+Array of packages objects + |
+Component configuration item details + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
name + |
+String + |
+Component name + |
+
configurations + |
+Array of ConfigurationItem objects + |
+Component configuration items + |
+
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.
+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
+ +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
+Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
Content-Type + |
+Yes + |
+String + |
+Details: +The request body type or format +Constraints: +The GET method is not verified. +Options: + +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 + |
+
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 + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
packages + |
+Yes + |
+Array of packages objects + |
+Component configuration item details + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
name + |
+No + |
+String + |
+Component name + |
+
configurations + |
+No + |
+Array of ConfigurationItem objects + |
+Component configuration items + |
+
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
+ +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 + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
packages + |
+Array of packages objects + |
+Component configuration item details + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
name + |
+String + |
+Component name + |
+
configurations + |
+Array of ConfigurationItem objects + |
+Component configuration items + |
+
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.
++
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 @@
+
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.