Help Center/ Distributed Database Middleware/ API Reference/ APIs (Recommended)/ DDM Accounts/ Modifying a DDM Account
Updated on 2022-09-15 GMT+08:00
View PDF

Modifying a DDM Account

Function

This API is used to modify the permissions and associated schemas of a DDM account.

Constraints

At least one of the following parameters must be configured: password, base_authority, role, description, and databases.

URI

PUT /v1/{project_id}/instances/{instance_id}/users/{username}

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 an IAM API. The value of X-Subject-Token in the response header is the user token.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

user

Yes

UpdateUserDetailReq object

DDM account information
Table 4 UpdateUserDetailReq

Parameter

Mandatory

Type

Description

base_authority

No

Array of strings

Basic permissions of the DDM account. The default value is the original account permission.

The value can be CREATE, DROP, ALTER, INDEX, INSERT, DELETE, UPDATE, or SELECT.

Enumerated values:

  • CREATE
  • DROP
  • ALTER
  • INDEX
  • INSERT
  • DELETE
  • UPDATE
  • SELECT

description

No

String

Description of the DDM account, which cannot exceed 256 characters.

It is left blank by default.

Maximum length: 256 characters

databases

No

Array of UpdateUsersDatabases objects

DDM account information
Table 5 UpdateUsersDatabases

Parameter

Mandatory

Type

Description

name

No

String

Schema name, which is case-insensitive. The databases and name fields must be both or neither specified.

The parameter is left blank by default.

Response Parameters

Status code: 200

Table 6 Response body parameters

Parameter

Type

Description

name

String

Username of the DDM account

Status code: 400

Table 7 Response body parameters

Parameter

Type

Description

errCode

String

Service error code

externalMessage

String

Error message

Status code: 500

Table 8 Response body parameters

Parameter

Type

Description

errCode

String

Service error code

externalMessage

String

Error message

Example Request

PUT https://{endpoint}/v1/{project_id}/instances/{instance_id}/users/{username}

{
  "user" : {
    "base_authority" : [ "SELECT" ],
    "description" : "test11",
    "databases" : [ {
      "name" : "db_7350"
    } ]
  }
}

Example Response

Status code: 200

OK

{
  "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: DDM Accounts