Help Center/ Distributed Database Middleware/ API Reference (Kuala Lumpur Region)/ Account Management/ Creating an Account
Updated on 2022-12-07 GMT+08:00
View PDF
Share

Creating an Account

Function

This API is used to create a DDM account. DDM accounts are used to connect to and manage schemas. A maximum of 100 DDM accounts can be created for each DDM instance, and one DDM account can be associated with multiple schemas.

Constraints

None

URI

POST /v1/{project_id}/instances/{instance_id}/users

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID of a tenant in a region

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

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

users

Yes

Array of CreateDDMUsersInfo objects

DDM account information
Table 4 Parameters for creating an account

Parameter

Mandatory

Type

Description

name

Yes

String

Name of the DDM account, which:

  • Consists of 6 to 32 characters.
  • Must start with a letter.
  • Contains only letters, digits, and underscores (_).

Minimum length: 6

Maximum length: 32

password

Yes

String

DDM account password

base_authority

Yes

Array of strings

Basic permissions of the DDM account.

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

Possible values are as follows:

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

extend_authority

No

Array of strings

Extended permissions of the DDM account. This parameter is left blank by default.

The value can be fulltableDelete, fulltableSelect, or fulltableUpdate.

When configuring permissions, select at least one basic permission. The mappings between basic permissions and extended permissions are as follows:

  • If base_authority is set to SELECT, set extend_authority to fulltableSelect.
  • If base_authority is set to DELETE, set extend_authority to fulltableDelete.
  • If base_authority is set to UPDATE, set extend_authority to fulltableUpdate.

Possible values are as follows:

  • fulltableSelect
  • fulltableDelete
  • fulltableUpdate

description

No

String

Description of the DDM account, which cannot exceed 256 characters. It is left blank by default.

Maximum length: 256

databases

No

Array of CreateDDMUsersDatabases objects

Associated schemas The databases field is optional. You can create a DDM account without associating it with any schema.
Table 5 Parameters for creating an account

Parameter

Mandatory

Type

Description

name

Yes

String

Name of the associated schema

Response Parameters

Status code: 200

Table 6 Response body parameters

Parameter

Type

Description

users

Array of CreateDDMUsersDetailResponses objects

DDM account information
Table 7 Parameters for creating an account

Parameter

Type

Description

name

String

Name of the DDM account

Status code: 400

Table 8 Response body parameters

Parameter

Type

Description

errCode

String

Service error code

externalMessage

String

Error message

Status code: 500

Table 9 Response body parameters

Parameter

Type

Description

errCode

String

Service error code

externalMessage

String

Error message

Example Request

POST https://{endpoint}/v1/{project_id}/instances/{instance_id}/users

{
  "users" : [ {
    "name" : "DDMuser1",
    "password" : "Axejs@98a",
    "base_authority" : [ "CREATE", "DROP", "ALTER", "INDEX", "INSERT", "DELETE", "UPDATE", "SELECT" ],
    "extend_authority" : [ "fulltableSelect", "fulltableDelete", "fulltableUpdate" ],
    "description" : "",
    "databases" : [ {
      "name" : "DDMdb1"
    } ]
  } ]
}

Example Response

Status code: 200

OK

{
  "users" : [ {
    "name" : "DDMuser1"
  } ]
}

Status code: 400

bad request

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

Status code: 500

server error

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

Status Codes

For details, see Status Codes.

Error Codes

For details, see Error Codes.

Parent topic: Account Management