Applicability
Currently, this API is not supported for standby clusters.
Overview
You can call this API to modify the login password of a database user in the specified tenant. The new password takes effect immediately. Existing connections are not affected.
API details
Constraints
The caller must have an AccessKey for accessing APIs. 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}/password
Request parameters
Path parameters
| 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**** |
| userName | string | Yes | The name of the user. | N/A |
Query parameters
| Name | Type | Required | Description | Example value |
|---|---|---|---|---|
| requestId | string | Yes | The ID of the request, which is used for tracing. | dc302d76-66b5-48d8-ab53-a035******** |
Request body parameters
| Name | Type | Required | Description | Example value |
|---|---|---|---|---|
| userPassword | string | Yes | The password of the database user. The password must contain uppercase letters, lowercase letters, digits, and special characters. The length of the password must be 10 to 32 characters. The special characters are !@#$%^&* ()_ +-= | ob********* |
Response parameters
| Name | Type | Description | Example value |
|---|---|---|---|
| success | boolean | Indicates whether the password is modified. | true |
Examples
Request example
curl -X PUT \
-H 'Content-Type: application/json' \
-H 'X-Ob-Project-Id: <Project ID>' \
-u '<Your ak:sk>' \
'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/tenants/{tenantId}/tenantUsers/{userName}/password?requestId={requestId}' \
-d '{
"userPassword": "yourNewPassword123!"
}'
Note
- A project ID uniquely identifies a project. For information about how to obtain the project ID of an instance, see Manage projects.
- Make sure that the project ID corresponding to the specified instanceId is consistent with the specified project ID.
Response example
JSON format
{
"requestId": "dc302d76-66b5-48d8-ab53-a035********",
"success": true,
"server": "xxx.xxx.x.xxx:xxxx"
}