Updated on 2026-09-30 GMT+08:00

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.

Calling Method

For details, see Calling APIs.

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	Definition: Type (or format) of the request body. The default value is application/json. Other values of this field will be provided for specific APIs, if any. Constraints: GET requests are not validated. Range: N/A 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	Definition: API version. The value is fixed at v3. Range: v3
kind	String	Definition: API type. The value is fixed at Configuration. Range: Configuration
metadata	ConfigurationMetadata object	Definition: Metadata of Configuration Range: N/A
spec	ClusterConfigurationsSpec object	Definition: Spec of Configuration Range: N/A
status	Object	Definition: Status of Configuration Range: N/A

**Table 4** ConfigurationMetadata
Parameter	Type	Description
name	String	Definition: Configuration name Range: N/A
labels	Map<String,String>	Definition: A configuration label in a key-value pair. Key: The key must contain a maximum of 63 characters that start with a letter or digit. Only letters, digits, hyphens (-), underscores (_), and periods (.) are allowed. A DNS subdomain can be prefixed to a key, for example, example.com/my-key, and contain a maximum of 253 characters. Value: The value can be left empty or contain a maximum of 63 characters that start and end with a letter or digit. Only letters, digits, hyphens (-), underscores (_), and periods (.) are allowed. Example: "foo": "bar" Range: N/A

**Table 5** ClusterConfigurationsSpec
Parameter	Type	Description
packages	Array of packages objects	Definition: Component configuration item list Range: N/A

**Table 6** packages
Parameter	Type	Description
name	String	Definition: Component name Range: N/A
configurations	Array of ConfigurationItem objects	Definition: Details about component configuration items Range: N/A

**Table 7** ConfigurationItem
Parameter	Type	Description
name	String	Definition: Component configuration parameters. Options: N/A Default value: N/A
value	Object	Definition: Values of component configuration parameters. Options: N/A Default value: N/A

Example Requests

None

Example Responses

Status code: 200

{
  "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