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.

Calling Method

For details, see Calling APIs.

URI

GET /api/v3/projects/{project_id}/clusters/{cluster_id}/configuration/detail

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

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. 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
{User defined key}	Map<String,Array<PackageOptions>>	Definition Configuration items supported by a cluster

**Table 4** PackageOptions
Parameter	Type	Description
name	String	Definition Parameter name Range N/A
default	Object	Definition 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. Range N/A
validAt	String	Definition How parameters will take effect Range static: The parameters take effect during the cluster or node pool creation and cannot be changed later. immediately: The parameters can be modified during the cluster or node pool running, and the modification takes effect immediately.
empty	Boolean	Definition Whether a configuration item can be empty Range true: If the configuration item is empty, the default value is not used. The value remains empty. false: If the configuration item is empty, the default value is used.
schema	String	Definition Parameter category Range N/A
type	String	Definition Type Range str: character string int: integer float: floating point bool: Boolean

Example Requests

None

Example Responses

Status code: 200

The list of parameters that can be configured for a cluster is obtained.

{
  "kube-apiserver" : [ {
    "name" : "default-not-ready-toleration-seconds",
    "default" : 300,
    "validAt" : "immediately",
    "empty" : true,
    "schema" : "kubernetes",
    "type" : "int"
  } ]
}

Status Codes

Status Code	Description
200	The list of parameters that can be configured for a cluster is obtained.

Error Codes

See Error Codes.

Parent topic: Configuration Management

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

Next topic: Obtaining the List of Configurable Parameters Supported by a Cluster

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.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

For any further questions, feel free to contact us through the chatbot.

Chatbot