Help Center/ Distributed Database Middleware/ API Reference/ APIs (Recommended)/ Accounts/ Resetting the Password of a DDM Account
Updated on 2024-08-02 GMT+08:00
View PDF
Share

Resetting the Password of a DDM Account

Function

This API is used to reset the password of a DDM account.

Constraints

None

URI

POST /v2/{project_id}/instances/{instance_id}/users/{username}/password

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID

To obtain this value, see Obtaining a Project ID.

instance_id

Yes

String

DDM instance ID

username

Yes

String

Username of the DDM account to be modified

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token

You can obtain the token by calling the IAM API used to obtain a user token.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

password

Yes

String

New password

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

success

Boolean

Whether the operation is successful

instance_id

String

DDM instance ID

user_name

String

Username of the DDM account

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

errCode

String

Service error code

externalMessage

String

Error message

Status code: 500

Table 6 Response body parameters

Parameter

Type

Description

errCode

String

Service error code

externalMessage

String

Error message

Example Request

Resetting the password of a DDM account

POST https://{endpoint}/v2/{project_id}/instances/{instance_id}/users/{username}/password

{
  "password" : "xxxxxx"
}

Example Response

Status code: 200

OK

{
  "success": true,
  "instance_id": "e6b99563-xxxx-xxxx-xxxx-1820d4fd2a67",
  "user_name" : "ddmtest"
}

Status code: 400

bad request

{
  "externalMessage" : "Parameter error.",
  "errCode" : "DBS.280001"
}

Status code: 500

server error

{
  "externalMessage" : "Server failure.",
  "errCode" : "DBS.200412"
}

Status Codes

Status Code

Description

200

OK

400

bad request

500

server error

Error Codes

For details, see Error Codes.

Parent topic: Accounts