更新时间:2024-09-12 GMT+08:00
分享

创建数据库用户

功能介绍

创建云数据库GaussDB(for MySQL)实例数据库用户。

调用方法

请参见如何调用API

URI

POST /v3/{project_id}/instances/{instance_id}/db-users

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

租户在某一Region下的project ID。

获取方法请参见获取项目ID

约束限制

不涉及。

取值范围

只能由英文字母、数字组成,且长度为32个字符。

默认值

不涉及。

instance_id

String

参数解释

实例ID,此参数是实例的唯一标识。

约束限制

不涉及。

取值范围

只能由英文字母、数字组成,后缀为in07,长度为36个字符。

默认取值

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释

用户Token。

通过调用IAM服务获取用户Token接口获取。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

约束限制

不涉及。

取值范围

不涉及。

默认值

不涉及。

X-Language

String

参数解释

请求语言类型。

约束限制

不涉及。

取值范围

  • en-us

  • zh-cn

默认值

en-us。

表3 请求Body参数

参数

是否必选

参数类型

描述

users

Array of CreateDatabaseUserList objects

参数解释

数据库用户列表,列表最大长度为50。

表4 CreateDatabaseUserList

参数

是否必选

参数类型

描述

name

String

参数解释:

数据库用户名称。

约束限制

不涉及。

取值范围

数据库用户名称在1到32个字符之间,由字母、数字、下划线组成,不能包含其他特殊字符。

默认取值

不涉及。

password

String

参数解释:

数据库用户密码。

约束限制

不能同用户名称相同,非空。建议您输入高强度密码,以提高安全性,防止出现密码被暴力破解等安全风险。

取值范围

至少包含以下字符中的三种:大写字母、小写字母、数字和特殊符号|.~!@#$%^*-_=+?,()&组成,长度8~32个字符。

默认取值

不涉及。

comment

String

参数解释:

数据库备注。

约束限制

该字段只针对新版本的实例生效,必须大于等于指定的内核版本-2.0.13.0,如果不符合内核版本要求,参考内核版本升级至最新。

取值范围

长度不能超过512个字符,不能包含回车和特殊字符!<"='>&。

默认取值

不涉及。

hosts

Array of strings

参数解释:

主机IP地址,即允许数据库用户在当前主机连接数据库。

约束限制

一次最多创建50个。

取值范围

%和IP地址,若IP地址为“10.10.10.%”,则表示10.10.10.X的IP地址都可以访问该GaussDB(for MySQL)实例。若您需要添加多个IP地址,请用英文逗号隔开(逗号前后都不能加空格),例如192.168.0.1,172.16.213.9。

默认取值

默认IP地址为%,表示允许所有地址访问GaussDB(for MySQL)实例。

databases

Array of CreateDatabaseList objects

参数解释:

数据库名称列表,即创建数据库用户时同步将列表中的数据库授权给用户,列表最大长度为50。列表可以为空,在需要给该用户授权某数据库时,调用数据库用户授权接口即可。

表5 CreateDatabaseList

参数

是否必选

参数类型

描述

name

String

参数解释:

数据库名称。

约束限制

当前已存在的数据库。

取值范围

数据库名称长度可在1~64个字符之间,由字母、数字、下划线、中划线组成,中划线的累计总长度小于等于10个字符,且不能包含其他特殊字符。

默认值

不涉及。

readonly

Boolean

参数解释:

是否为只读权限。

约束限制

不涉及。

取值范围

  • true:表示只读。

  • false:表示可读写。

默认值

不涉及。

响应参数

状态码: 201

表6 响应Body参数

参数

参数类型

描述

job_id

String

参数解释:

创建数据库用户的任务ID。

取值范围

符合UUID规则。

状态码: 400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码: 500

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

创建数据库用户,读写权限,主机IP地址是127.0.0.1。

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

{
  "users" : [ {
    "name" : "gaussdb_mysql_user1",
    "password" : "***",
    "hosts" : [ "127.0.0.1" ],
    "comment" : "database_user_comment",
    "databases" : [ {
      "name" : "test",
      "readonly" : false
    } ]
  } ]
}

响应示例

状态码: 201

Success.

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

SDK代码示例

SDK代码示例如下。

创建数据库用户,读写权限,主机IP地址是127.0.0.1。

 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
66
67
68
69
70
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.gaussdb.v3.region.GaussDBRegion;
import com.huaweicloud.sdk.gaussdb.v3.*;
import com.huaweicloud.sdk.gaussdb.v3.model.*;

import java.util.List;
import java.util.ArrayList;

public class CreateGaussMySqlDatabaseUserSolution {

    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);

        GaussDBClient client = GaussDBClient.newBuilder()
                .withCredential(auth)
                .withRegion(GaussDBRegion.valueOf("<YOUR REGION>"))
                .build();
        CreateGaussMySqlDatabaseUserRequest request = new CreateGaussMySqlDatabaseUserRequest();
        request.withInstanceId("{instance_id}");
        CreateDatabaseUserRequest body = new CreateDatabaseUserRequest();
        List<CreateDatabaseList> listUsersDatabases = new ArrayList<>();
        listUsersDatabases.add(
            new CreateDatabaseList()
                .withName("test")
                .withReadonly(false)
        );
        List<String> listUsersHosts = new ArrayList<>();
        listUsersHosts.add("127.0.0.1");
        List<CreateDatabaseUserList> listbodyUsers = new ArrayList<>();
        listbodyUsers.add(
            new CreateDatabaseUserList()
                .withName("gaussdb_mysql_user1")
                .withComment("database_user_comment")
                .withPassword("***")
                .withHosts(listUsersHosts)
                .withDatabases(listUsersDatabases)
        );
        body.withUsers(listbodyUsers);
        request.withBody(body);
        try {
            CreateGaussMySqlDatabaseUserResponse response = client.createGaussMySqlDatabaseUser(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());
        }
    }
}

创建数据库用户,读写权限,主机IP地址是127.0.0.1。

 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
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkgaussdb.v3.region.gaussdb_region import GaussDBRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkgaussdb.v3 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 = GaussDBClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(GaussDBRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = CreateGaussMySqlDatabaseUserRequest()
        request.instance_id = "{instance_id}"
        listDatabasesUsers = [
            CreateDatabaseList(
                name="test",
                readonly=False
            )
        ]
        listHostsUsers = [
            "127.0.0.1"
        ]
        listUsersbody = [
            CreateDatabaseUserList(
                name="gaussdb_mysql_user1",
                comment="database_user_comment",
                password="***",
                hosts=listHostsUsers,
                databases=listDatabasesUsers
            )
        ]
        request.body = CreateDatabaseUserRequest(
            users=listUsersbody
        )
        response = client.create_gauss_my_sql_database_user(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

创建数据库用户,读写权限,主机IP地址是127.0.0.1。

 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
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    gaussdb "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/gaussdb/v3"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/gaussdb/v3/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/gaussdb/v3/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 := gaussdb.NewGaussDBClient(
        gaussdb.GaussDBClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.CreateGaussMySqlDatabaseUserRequest{}
	request.InstanceId = "{instance_id}"
	var listDatabasesUsers = []model.CreateDatabaseList{
        {
            Name: "test",
            Readonly: false,
        },
    }
	var listHostsUsers = []string{
        "127.0.0.1",
    }
	commentUsers:= "database_user_comment"
	var listUsersbody = []model.CreateDatabaseUserList{
        {
            Name: "gaussdb_mysql_user1",
            Comment: &commentUsers,
            Password: "***",
            Hosts: &listHostsUsers,
            Databases: &listDatabasesUsers,
        },
    }
	request.Body = &model.CreateDatabaseUserRequest{
		Users: listUsersbody,
	}
	response, err := client.CreateGaussMySqlDatabaseUser(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

201

Success.

400

Client error.

500

Server error.

错误码

请参见错误码

相关文档