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.
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