Call the ModifyParameters API to modify cluster and tenant parameters - ApsaraDB for OceanBase (Deprecated) - Alibaba Cloud - ApsaraDB for OceanBase (Deprecated)

Alibaba Cloud provides SDKs in different languages to help you quickly integrate Alibaba Cloud products and services by using APIs. We recommend that you use an SDK to call APIs. In this way, you do not need to sign for verification.

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

oceanbase:ModifyParameters

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	Alibaba Cloud CLI	ob317v4uif****
DimensionValue	string	No	The cause of the modification failure.	t4qx8****
Dimension	string	Yes	The ID of the OceanBase cluster.	TENANT
Parameters	string	Yes	The resource ID of the parameter type. You can leave this parameter unspecified when you call this operation to modify cluster parameters. In the case of tenant parameters, pass the tenant ID.	[{"Name":"connect_timeout","Value":"20"}]

Response elements

Element	Type	Description	Example
	object	The parameters. It is a JSON array. Each object in the array has two elements: Name and Value. Note The names and values of cluster parameters that can be modified are different from those of tenant parameters. For more information, see DescribeParameters.
RequestId	string	The operation that you want to perform. Set the value to ModifyParameters.	EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C
Results	object	Example 1
Success	boolean	Indicates whether the modification succeeded. true: The modification succeeded. false: The modification failed.	false
Message	string	The message indicating why the modification failed.	schedule timeout.

Examples

Success response

JSON format

{
  "RequestId": "EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C",
  "Results": {
    "Success": false,
    "Message": "schedule timeout."
  }
}

Error codes

HTTP status code	Error code	Error message	Description
500	InternalError	The request processing has failed due to some unknown error.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.