Help Center/ TaurusDB/ API Reference/ APIs (Recommended)/ Database User Management/ Modifying the Description of a Database User
Updated on 2025-10-21 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Modifying the Description of a Database User

Function

This API is used to modify the description of a database user. Before calling this API:

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependency

    gaussdbformysql:user:modify

    Write

    instance *

    • g:EnterpriseProjectId

    • g:ResourceTag/<tag-key>

    gaussdb:user:modify

    -

URI

PUT /v3/{project_id}/instances/{instance_id}/db-users/comment

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID of a tenant in a region.

To obtain this value, see Obtaining a Project ID.

Constraints

N/A

Range

The value contains 32 characters. Only letters and digits are allowed.

Default Value

N/A

instance_id

Yes

String

Definition

Instance ID, which uniquely identifies an instance.

Constraints

N/A

Range

The value contains 36 characters with a suffix of in07. Only letters and digits are allowed.

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token. To obtain this value, call the IAM API for obtaining a user token.

The value of X-Subject-Token in the response header is the token value.

Constraints

N/A

Range

N/A

Default Value

N/A

X-Language

No

String

Definition

Request language type.

Constraints

N/A

Range

  • en-us

  • zh-cn

Default Value

en-us
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

users

Yes

Array of UpdateDatabaseUserComment objects

Definition

List of database users that you want to modify the description for.

Constraints

The list contains up to 50 database users.
Table 4 UpdateDatabaseUserComment

Parameter

Mandatory

Type

Description

name

Yes

String

Definition

Database username.

Constraints

N/A

Range

The username can consist of 1 to 32 characters. Only letters, digits, and underscores (_) are allowed.

Default Value

N/A

host

Yes

String

Definition

Host IP address.

Constraints

N/A

Range

  • If the value is %, all IP addresses are allowed to access your TaurusDB instance.

  • If the value is 10.10.10.%, all IP addresses in the subnet 10.10.10.X are allowed to access your TaurusDB instance.

  • To specify multiple IP addresses, separate them with commas (,), for example, 192.168.0.1,172.16.213.9 (no spaces before or after the comma).

Default Value

%

comment

Yes

String

Definition

Database user description.

Constraints

This parameter is only available for instances whose kernel version is 2.0.13.0 or later. To upgrade a kernel version, see Upgrading the Kernel Version of a DB Instance.

Range

The value can consist of up to 512 characters. It cannot contain carriage returns or any of the following special characters: !<"='>&

Default Value

N/A

Response Parameters

Status code: 202

Table 5 Response body parameters

Parameter

Type

Description

job_id

String

Definition

ID of the task for modifying the description of a database user.

Range

N/A

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Request

Modifying the description of a database user

PUT https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/a23fb62bd61e4e9e9636fd2225f395bein07/db-users/comment 

{ 
  "users" : [ { 
    "name" : "gaussdb_mysql_user1", 
    "host" : "127.0.0.1", 
    "comment" : "first_database_user" 
  } ] 
}

Example Response

Status code: 202

Success.

{ 
  "job_id" : "dff1d289-4d03-4942-8b9f-463ea07c000d" 
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent topic: Database User Management