Overview
You can call this API to modify the parameters at the tenant level.
API details
Constraints
You have an AccessKey for accessing the multi-cloud API. For information about how to obtain the AccessKey ID and AccessKey secret, see Manage AccessKeys.
Request path
PUT /api/v2/instances/{instanceId}/tenants/{tenantId}/parameters
Request parameters
Path
| Name | Type | Required | Description | Example value |
|---|---|---|---|---|
| instanceId | String | Yes | The ID of the OceanBase cluster. | obcluster-***** |
| tenantId | String | Yes | The ID of the tenant. | t4louaeei**** |
Query
| Name | Type | Required | Description | Example value |
|---|---|---|---|---|
| requestId | String | Yes | The ID of the request, which is used for tracing. | dc302d76-66b5-48d8-ab53-a035******** |
Body
| Name | Type | Required | Description | Example value |
|---|---|---|---|---|
| name | string | Yes | The name of the parameter. | max_allowed_packet |
| value | string | Yes | The value of the parameter. | 367108096 |
Response parameters
| Name | Type | Description | Example value |
|---|---|---|---|
| data | array | The list of parameters. | [] |
| name | string | The name of the parameter. | max_allowed_packet |
| value | string | The value of the parameter. | 367108096 |
| success | boolean | Indicates whether the operation succeeded. | true |
| message | string | The description. | "" |
Examples
Request example
curl --digest -u '<Your ak:sk>' \
-X PUT \
'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/tenants/{tenantId}/parameters?requestId={requestId}' \
-H 'Content-Type: application/json' \
--data '[{"name":"max_allowed_packet","value":"367108096"}]'
Response example
JSON format
{
"data": [
{
"name": "max_allowed_packet",
"value": "367108096"
}
],
"success": true,
"message": ""
}