All Products
Search
Document Center

ApsaraDB for OceanBase:ModifyParameters

Last Updated:Apr 29, 2024

You can call this operation to modify the parameters of a cluster or tenant.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

Alibaba Cloud CLI

ob317v4uif****
DimensionValuestringNo

The cause of the modification failure.

ob2mr3oae0****
DimensionstringYes

The ID of the OceanBase cluster.

TENANT
ParametersstringYes

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 parameters

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

The operation that you want to perform.
Set the value to ModifyParameters.

EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C
Resultsobject

Example 1

Successboolean
false
Messagestring
schedule timeout.

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError message
500InternalErrorThe request processing has failed due to some unknown error.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history