Updated on 2024-04-18 GMT+08:00

Modifying User Information

Function

This API is used to modify information about a specified user.

Call Method

For details, see Calling APIs.

URI

POST /v1/{project_id}/clusters/{cluster_id}/db-manager/users/{name}
Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain the ID, see Obtaining Project ID.

cluster_id

Yes

String

Cluster ID. For details about how to obtain the ID, see Obtaining the Cluster ID.

name

Yes

String

Username

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

login

No

Boolean

Permission to log in to the database

createrole

No

Boolean

Permission to create roles

createdb

No

Boolean

Permission to create databases

systemadmin

No

Boolean

System administrator

auditadmin

No

Boolean

Audit administrator

inherit

No

Boolean

Whether a user can inherit the permissions of the group to which it belongs

useft

No

Boolean

Permission to access foreign tables.

conn_limit

No

Integer

Maximum number of connections.

replication

No

Boolean

Whether streaming replication is allowed

valid_begin

No

String

Role effective time, in yyyy-MM-ddTHH:mm:ssZ format.

valid_until

No

String

Role expiration time, in yyyy-MM-ddTHH:mm:ssZ format.

lock

No

Boolean

Whether a user is locked

Response Parameters

None

Example Request

Modify information about user1 in the cluster whose ID is a89aea88-7ea2-40bd-8ac8-8b93e169e5d6 so that user1 can log in to the database and have the permissions to create roles, create databases, and access foreign tables. However, do not grant user1 the system administrator and audit administrator permissions, and do not limit the number of connections.

POST https://{Endpoint}/v1/0536cdee2200d5912f7cc00b877980f1/clusters/a89aea88-7ea2-40bd-8ac8-8b93e169e5d6/db-manager/users/user1

{
  "login" : true,
  "createrole" : true,
  "createdb" : true,
  "systemadmin" : false,
  "auditadmin" : false,
  "inherit" : false,
  "useft" : true,
  "conn_limit" : -1,
  "replication" : false,
  "valid_begin" : "2023-04-03T12:23:01",
  "valid_until" : "2023-04-18T12:23:01",
  "lock" : false
}

Example Response

Status code: 200

None

SDK Sample Code

The sample code is as follows:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.dws.v2.region.DwsRegion;
import com.huaweicloud.sdk.dws.v2.*;
import com.huaweicloud.sdk.dws.v2.model.*;


public class UpdateDatabaseUserInfoSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");

        ICredential auth = new BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        DwsClient client = DwsClient.newBuilder()
                .withCredential(auth)
                .withRegion(DwsRegion.valueOf("cn-north-4"))
                .build();
        UpdateDatabaseUserInfoRequest request = new UpdateDatabaseUserInfoRequest();
        DatabaseUserInfoReq body = new DatabaseUserInfoReq();
        body.withLock(false);
        body.withValidUntil("2023-04-18T12:23:01");
        body.withValidBegin("2023-04-03T12:23:01");
        body.withReplication(false);
        body.withConnLimit(-1);
        body.withUseft(true);
        body.withInherit(false);
        body.withAuditadmin(false);
        body.withSystemadmin(false);
        body.withCreatedb(true);
        body.withCreaterole(true);
        body.withLogin(true);
        request.withBody(body);
        try {
            UpdateDatabaseUserInfoResponse response = client.updateDatabaseUserInfo(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
# coding: utf-8

from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkdws.v2.region.dws_region import DwsRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkdws.v2 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.getenv("CLOUD_SDK_AK")
    sk = os.getenv("CLOUD_SDK_SK")

    credentials = BasicCredentials(ak, sk) \

    client = DwsClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(DwsRegion.value_of("cn-north-4")) \
        .build()

    try:
        request = UpdateDatabaseUserInfoRequest()
        request.body = DatabaseUserInfoReq(
            lock=False,
            valid_until="2023-04-18T12:23:01",
            valid_begin="2023-04-03T12:23:01",
            replication=False,
            conn_limit=-1,
            useft=True,
            inherit=False,
            auditadmin=False,
            systemadmin=False,
            createdb=True,
            createrole=True,
            login=True
        )
        response = client.update_database_user_info(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    dws "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dws/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dws/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dws/v2/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := dws.NewDwsClient(
        dws.DwsClientBuilder().
            WithRegion(region.ValueOf("cn-north-4")).
            WithCredential(auth).
            Build())

    request := &model.UpdateDatabaseUserInfoRequest{}
	lockDatabaseUserInfoReq:= false
	validUntilDatabaseUserInfoReq:= "2023-04-18T12:23:01"
	validBeginDatabaseUserInfoReq:= "2023-04-03T12:23:01"
	replicationDatabaseUserInfoReq:= false
	connLimitDatabaseUserInfoReq:= int32(-1)
	useftDatabaseUserInfoReq:= true
	inheritDatabaseUserInfoReq:= false
	auditadminDatabaseUserInfoReq:= false
	systemadminDatabaseUserInfoReq:= false
	createdbDatabaseUserInfoReq:= true
	createroleDatabaseUserInfoReq:= true
	loginDatabaseUserInfoReq:= true
	request.Body = &model.DatabaseUserInfoReq{
		Lock: &lockDatabaseUserInfoReq,
		ValidUntil: &validUntilDatabaseUserInfoReq,
		ValidBegin: &validBeginDatabaseUserInfoReq,
		Replication: &replicationDatabaseUserInfoReq,
		ConnLimit: &connLimitDatabaseUserInfoReq,
		Useft: &useftDatabaseUserInfoReq,
		Inherit: &inheritDatabaseUserInfoReq,
		Auditadmin: &auditadminDatabaseUserInfoReq,
		Systemadmin: &systemadminDatabaseUserInfoReq,
		Createdb: &createdbDatabaseUserInfoReq,
		Createrole: &createroleDatabaseUserInfoReq,
		Login: &loginDatabaseUserInfoReq,
	}
	response, err := client.UpdateDatabaseUserInfo(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For more SDK sample codes of programming languages, visit API Explorer and click the Sample Code tab. Example codes can be automatically generated.

Status Code

Status Code

Description

200

User information details

400

Request error.

401

Authentication failed.

403

You do not have required permissions.

404

No resources found.

500

Internal server error.

503

The service was unavailable.