Help Center/ Distributed Database Middleware/ API Reference/ APIs (Recommended)/ Accounts/ Modifying a DDM Account

Updated on 2024-08-02 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: base_authority, 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 To obtain this value, see Obtaining a 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 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
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

Modifying the account permission to SELECT and associating it with schema db_7350

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

{
  "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

Previous topic: Querying DDM Accounts

Next topic: Deleting a DDM Account

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot