Modifying Information About a Specified User
Function
This API is used to modify the information about a specified user.
Calling Method
For details, see Calling APIs.
URI
POST /v1/{project_id}/clusters/{cluster_id}/db-manager/users/{name}
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String | Definition Project ID. To obtain the value, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A |
| cluster_id | Yes | String | Definition Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID. Constraints N/A Range N/A Default Value N/A |
| name | Yes | String | Definition Username or role name. Constraints N/A Range N/A Default Value N/A |
Request Parameters
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| login | No | Boolean | Definition Whether the login is allowed. Range N/A |
| createrole | No | Boolean | Definition Permission to create roles. Range N/A |
| createdb | No | Boolean | Definition Permission to create databases. Range N/A |
| systemadmin | No | Boolean | Definition System administrator. Range N/A |
| auditadmin | No | Boolean | Definition Audit administrator. Range N/A |
| inherit | No | Boolean | Definition Whether a user can inherit the permissions of the group to which it belongs. Range N/A |
| useft | No | Boolean | Definition Permission to access foreign tables. Range N/A |
| conn_limit | No | Integer | Definition Maximum number of connections. Range N/A |
| replication | No | Boolean | Definition Whether streaming replication is allowed. Range N/A |
| valid_begin | No | String | Definition Time when a role takes effect. The format is yyyy-MM-ddTHH:mm:ssZ. Range N/A |
| valid_until | No | String | Definition Time when a role expires. The format is yyyy-MM-ddTHH:mm:ssZ. Range N/A |
| lock | No | Boolean | Definition Whether the user is locked. Range N/A |
Response Parameters
Status code: 200
Modification succeeded.
None
Example Requests
Modify the information about user user1 in the cluster whose ID is a89aea88-7ea2-40bd-8ac8-8b93e169e5d6. The user can log in to a database, create roles, create databases, and access foreign tables. The system administrator and audit administrator permissions are not granted to the user, and the number of connections is not limited.
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 Responses
None
SDK Sample Code
The SDK sample code is as follows.
Modify the information about user user1 in the cluster whose ID is a89aea88-7ea2-40bd-8ac8-8b93e169e5d6. The user can log in to a database, create roles, create databases, and access foreign tables. The system administrator and audit administrator permissions are not granted to the user, and the number of connections is not limited.
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 62 63 | 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"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); DwsClient client = DwsClient.newBuilder() .withCredential(auth) .withRegion(DwsRegion.valueOf("<YOUR REGION>")) .build(); UpdateDatabaseUserInfoRequest request = new UpdateDatabaseUserInfoRequest(); request.withClusterId("{cluster_id}"); request.withName("{name}"); 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()); } } } |
Modify the information about user user1 in the cluster whose ID is a89aea88-7ea2-40bd-8ac8-8b93e169e5d6. The user can log in to a database, create roles, create databases, and access foreign tables. The system administrator and audit administrator permissions are not granted to the user, and the number of connections is not limited.
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 | # coding: utf-8 import os 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.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = DwsClient.new_builder() \ .with_credentials(credentials) \ .with_region(DwsRegion.value_of("<YOUR REGION>")) \ .build() try: request = UpdateDatabaseUserInfoRequest() request.cluster_id = "{cluster_id}" request.name = "{name}" 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) |
Modify the information about user user1 in the cluster whose ID is a89aea88-7ea2-40bd-8ac8-8b93e169e5d6. The user can log in to a database, create roles, create databases, and access foreign tables. The system administrator and audit administrator permissions are not granted to the user, and the number of connections is not limited.
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 62 63 64 65 | 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") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := dws.NewDwsClient( dws.DwsClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.UpdateDatabaseUserInfoRequest{} request.ClusterId = "{cluster_id}" request.Name = "{name}" 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 SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
| Status Code | Description |
|---|---|
| 200 | Modification succeeded. |
| 400 | Request error. |
| 401 | Authentication failed. |
| 403 | You do not have required permissions. |
| 404 | No resources found. |
| 500 | Internal server error. |
| 503 | Service unavailable. |
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot