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	Project ID. For details about how to obtain the value, see How to Obtain Parameters in the API URI.
cluster_id	Yes	String	Cluster ID. For details about how to obtain the value, see How to Obtain Parameters in the API URI.
nodepool_id	Yes	String	Node pool ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
Content-Type	Yes	String	Message body type (format).
X-Auth-Token	Yes	String	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.

**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	Component configuration item name.
value	No	Object	Component configuration item value.

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	Component configuration item name.
value	Object	Component configuration item value.

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

Previous topic: Obtaining the Parameters That Can Be Configured for a Node Pool

Next topic: Chart Management

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.