Modifies the configuration of a cluster component. This operation may affect your businesses. We recommend that you assess the impact, back up data, and perform the operation during off-peak hours.
Operation description
You can call this API operation to modify the component parameters of an ACK Basic cluster or the control plane parameters of an ACK Pro cluster:
- To view the component parameters of an ACK Basic cluster, call the DescribeClusterAddonMetadata API operation. For more information, see Query the metadata of a cluster component.
- To view the control plane parameters of an ACK Pro cluster, see Customize the control plane parameters of an ACK Pro cluster.
After you call this operation, the component may be redeployed and restarted. We recommend that you assess the impact before you call this operation.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| cs:ModifyClusterAddon | update |
|
| none |
Request syntax
POST /clusters/{cluster_id}/components/{component_id}/config HTTP/1.1
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| cluster_id | string | Yes | The cluster ID. | c71d616e629ff40d5b42d7bb87770**** |
| component_id | string | Yes | The component ID. | coredns |
| body | object | No | The component configuration. | |
| config | string | No | The custom parameter settings that you want to use. | {"CpuRequest":"800m"} |
Set config to a JSON string.
Response parameters
Examples
Sample success responses
JSONformat
{}Error codes
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|