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

Managing the Administrator Password

Function

If it is the first time to call this API, it is used to create an administrator and reset its password for a DDM instance. Then this API can only be used to update the administrator password.

URI

PUT /v3/{project_id}/instances/{instance_id}/admin-user

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID of a tenant in a region

To obtain this value, see Obtaining a Project ID.

instance_id

Yes

String

DDM instance ID

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

name

Yes

String

Username of the administrator. The username:

  • Can include 1 to 32 characters.
  • Must start with a letter.
  • Can contain only letters, digits, and underscores (_).

password

Yes

String

Password of the administrator. The password:

  • Can include 8 to 32 characters.
  • Must be a combination of uppercase letters, lowercase letters, digits, and the following special characters: ~!@#%^*-_+? Must be a strong password to improve security and prevent security risks such as brute force cracking.

Response Parameters

Status code: default

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error message

Example Request

Creating administrator account root and setting a password for it

PUT https://{endpoint}/v3/{project_id}/instances/{instance_id}/admin-user

{
  "name" : "root",
  "password" : "xxxxx"
}

Example Response

None

Status Codes

Status Code

Description

200

OK

default

Client or server error.

Error Codes

For details, see Error Codes.

Parent topic: Accounts