Overview
You can call this API to modify a tenant parameter.
API details
Constraints
You have an AccessKey for accessing APIs of OceanBase Cloud. 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
| Parameter | Type | Required | Description | Example value |
|---|---|---|---|---|
| instanceId | String | Yes | The ID of the instance. | obxxx |
| tenantId | String | Yes | The ID of the tenant. | txxx |
Body
| Parameter | Type | Required | Description | Example value |
|---|---|---|---|---|
| name | string | Parameter name | max_allowed_packet | |
| value | string | Yes | Parameter value | 367108096 |
Response parameters
| Parameter | Type | Description | Example value |
|---|---|---|---|
| data | array | The parameter list. | [] |
| name | string | Parameter name. | max_allowed_packet |
| value | string | Parameter value. | 367108096 |
| success | boolean | Indicates whether the operation succeeded. | true |
| message | string | Description. | "" |
Examples
Request example
curl --digest -u 'ak:sk' \
-X PUT \
'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/tenants/{tenantId}/parameters' \
--data '[{"name":"max_allowed_packet","value":"367108096"}]'
Response example
JSON format
{
"data": [
{
"name": "max_allowed_packet",
"value": "367108096"
}
],
"success": true,
"message": ""
}