Modify cluster configuration by using ModifyDBClusterConfig - ApsaraDB for SelectDB - Alibaba Cloud - ApsaraDB for SelectDB

Modifies the cluster configuration.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

selectdb:ModifyDBClusterConfig

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Parameters	string	Yes	JSON string of parameters and parameter values.	[{\"name\":\"param1\",\"value\":\"1234577777\"},{\"name\":\"param2\",\"value\":\"${yyyyMMdd}\"}]
ConfigKey	string	Yes	Configuration file to modify. For compute clusters, it is fixed as be.conf. For fe clusters, it is fixed as fe.conf.	be.conf
DBClusterId	string	Yes	Cluster ID.	selectdb-cn-7213c8yvv09-be
DBInstanceId	string	Yes	Instance ID.	selectdb-xxxd8a5h60y
RegionId	string	No	Region ID.	cn-hangzhou
SwitchTimeMode	string	No	Upgrade method. If not specified, the upgrade will be performed immediately. If set to 1, the upgrade will be performed during the maintenance window.	1
ParallelOperation	boolean	No	Whether to operate cluster nodes in parallel	false

Response elements

Parameter	Type	Description	Example
	object	PlainResponse
Data	object	Return data.
DbInstanceName	string	Instance ID.	selectdb-cn-wny3li00g02
DbInstanceId	string	Instance numeric ID.	6585
DbClusterId	string	Cluster ID.	selectdb-cn-wny3li00g02-be
TaskId	integer	Task ID	107878719
DynamicCode	string	Dynamic code, currently not in use, please ignore.	0
DynamicMessage	string	Dynamic message, currently not in use, please ignore.	An error occurred while processing your request.
AccessDeniedDetail	string	Access denied details.	failed
RequestId	string	Request ID.	BC854513-E85E-54F3-9842-B9CCD3308CDD

Examples

Success response

JSON format

{
  "Data": {
    "DbInstanceName": "selectdb-cn-wny3li00g02",
    "DbInstanceId": "6585",
    "DbClusterId": "selectdb-cn-wny3li00g02-be",
    "TaskId": 107878719
  },
  "DynamicCode": "0",
  "DynamicMessage": "An error occurred while processing your request.",
  "AccessDeniedDetail": "failed",
  "RequestId": "BC854513-E85E-54F3-9842-B9CCD3308CDD"
}

Error codes

HTTP status code	Error code	Error message
400	DocumentConvertFailed.ExceedFileSizeLimit	The conversion has been failed, exceed file size limit.
400	Forbidden	User not authorized to operate on the specified resource, or this API does not support RAM.
400	InvalidDBName	The specified database name is not allowed.
400	CreateOrderFailed	Failed to create order.
400	InvalidConfigName	The ConfigName is not valid.
400	InvalidParameters.Format	Specified parameters is not valid.
400	InvalidDBInstanceId.Malformed	The specified parameter "DBInstanceId" is not valid.
400	InvalidConfigKey.Malformed	The specified parameter "ConfigKey" is not valid.
400	InvalidClusterId.Malformed	The specified parameter "ClusterId" is not valid.
400	InvalidConfigParameters.Malformed	The specified parameter "Parameters" is not valid.
403	DBClusterNotSupported	The requested operation can not be performed while the cluster is not sale.
403	IncorrectDBInstanceState	Current DB instance state does not support this operation.
403	InstanceEngineType.NotSupport	The instance engine and type does not support operations.
403	InvalidDBInstanceState.NotSupport	The specified instance state does't support this operation.
403	MoneyLessThan100	The Account Monet less Than 100.
403	OperationDenied.DBNameAndAccountPrivilegeCount	The operation is not permitted due to count of database or account privilege.
403	InsufficientResourceCapacity	The resource is out of usage.
404	DBInstanceLocked	The current instance lock mode does not support this operation.
404	IncorrectVswitchId	The specified parameter VSwitchId is not valid.
404	InvalidApi.NotFound	Specified api is not found, please check your url and method.
404	InvalidDBInstance.NotFound	The specified instance is not found.
404	InvalidDBInstanceClass.NotFound	The specified instance classic does not exist.
404	InvalidRegionId.NotFound	The provided RegionId does not exist in our records.
404	QueryPrice.Failed	The inquiry failed. Contact Alibaba Cloud customer service representatives.
404	InvalidDBInstanceId.NotFound	The DBInstanceId provided does not exist in our records.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.