Overview
You can call this API to modify the remarks of a user in the current tenant. The new configuration may take some time to take effect.
API details
Constraints
The caller must have an AccessKey for accessing the 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}/tenantUsers/{userName}/description
Request parameters
Path
Name |
Type |
Required |
Description |
Example value |
|---|---|---|---|---|
| instanceId | String | Yes | The ID of the OceanBase Cloud instance. | obcluster-***** |
| tenantId | String | Yes | The ID of the tenant. | t4louaeei**** |
| userName | String | Yes | The name of the user. |
Query
Name |
Type |
Required |
Description |
Example value |
|---|---|---|---|---|
| requestId | String | Yes | The ID of the request. This parameter is used for tracing. | dc302d76-66b5-48d8-ab53-a035******** |
Body
Name |
Type |
Required |
Description |
Example value |
|---|---|---|---|---|
| description | String | Yes | The description of the user. | |
| host | String | No | The host of the user. |
Response parameters
Parameter |
Type |
Description |
|---|---|---|
| requestId | String | The ID of the request. |
| success | Boolean | Indicates whether the request was successful. |
Examples
Request example
curl --digest -u '<your ak:sk>' \
-X PUT \
'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/tenants/{tenantId}/tenantUsers/{userName}/description?requestId={requestId}' \
-H 'Content-Type: application/json' \
--data '{"description":"User description","host":"%"}'
Response example
JSON format
{
"requestId": "xxxxxx",
"success": true
}