Help Center/ Distributed Database Middleware/ API Reference (Kuala Lumpur Region)/ Account Management/ Resetting the Password of a DDM Account
Updated on 2022-08-17 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

instance_id

Yes

String

DDM instance ID

username

Yes

String

Username of the DDM account

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token

It can be obtained by calling the IAM API (value of X-Subject-Token in the response header).
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

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

{
  "password" : "GaussTest_234"
}

Example Response

Status code: 200

OK

{
	"success": true,
	"instance_id": "46aa2a7d7e8c4b23a9193639ed4950f5in09",
	"user_name": "testUser"
}

Status code: 400

bad request

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

Status code: 500

server error

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

Status Codes

Status Code

Description

200

OK

400

bad request

500

server error

Error Codes

For details, see Error Codes.

Parent topic: Account Management