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 |
---|---|---|
name |
String |
Configuration name |
labels |
Map<String,String> |
A configuration label in a key-value pair.
Example: "foo": "bar" |
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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot