# 授予数据库用户数据库权限 - AddDatabasePermission #### 功能介绍 授予云数据库 TaurusDB实例数据库用户数据库权限。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-taurusdb/taurusdb_03_0000.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-taurusdb/taurusdb_06_0000.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | gaussdbformysql:user:grantPrivilege | Write | instance \* | - g:EnterpriseProjectId - g:ResourceTag/\ | gaussdb:user:grantPrivilege | - | #### URI POST /v3/{project_id}/instances/{instance_id}/db-users/privilege 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**： 租户在某一Region下的project ID。 获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-taurusdb/taurusdb_10_0004.html)。 **约束限制**： 不涉及。 **取值范围**： 只能由英文字母、数字组成，且长度为32个字符。 **默认取值**： 不涉及。 | | instance_id | 是 | String | **参数解释**： 实例ID，此参数是实例的唯一标识。 获取方法请参见[查询实例列表](https://support.huaweicloud.com/api-taurusdb/ListGaussMySqlInstancesUnifyStatus.html)。 **约束限制**： 不涉及。 **取值范围**： 只能由英文字母、数字组成，后缀为in07，长度为36个字符。 **默认取值**： 不涉及。 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释**： 用户Token。 通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取。 请求响应成功后在响应消息头中包含的"X-Subject-Token"的值即为Token值。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | X-Language | 否 | String | **参数解释**： 请求语言类型。 **约束限制**： 不涉及。 **取值范围**： - en-us：英文。 - zh-cn：中文。 **默认取值**： en-us。 | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | users | 是 | Array of [GrantDatabasePermission] objects | **参数解释**： 数据库用户列表。 **约束限制**： 列表最大长度为50。 | 表4GrantDatabasePermission | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | name | 是 | String | **参数解释**： 数据库用户名。 **约束限制**： 必须是当前实例下的用户名。 **取值范围**： 名称在1到32个字符之间，由字母、数字、下划线组成，不能包含其他特殊字符。 **默认取值**： 不涉及。 | | host | 是 | String | **参数解释**： 主机地址。 **约束限制**： 不涉及。 **取值范围**： - 若IP地址为%，则表示允许所有地址访问TaurusDB实例。 - 若IP地址为"10.10.10.%"，则表示10.10.10.X的IP地址都可以访问该TaurusDB实例。 - 若您需要添加多个IP地址，请用英文逗号隔开（逗号前后都不能加空格），例如192.168.0.1,172.16.213.9。 **默认取值**： 不涉及。 | | databases | 是 | Array of [DatabasePermission] objects | **参数解释**： 数据库权限列表。 **约束限制**： 列表最大长度为50。 | 表5DatabasePermission | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | name | 是 | String | **参数解释**： 数据库名称。 **约束限制**： 不涉及。 **取值范围**： 数据库用户名称在1到32个字符之间，由字母、数字、下划线组成，不能包含其他特殊字符。 若取值为"\*"，则表示对全部数据库授权。 **默认取值**： 不涉及。 | | readonly | 是 | Boolean | **参数解释**： 是否为只读权限。 **约束限制**： 不涉及。 **取值范围**： - true：表示只读。 - false：表示可读写。 **默认取值**： 不涉及。 | #### 响应参数 **状态码：201** 表6响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | job_id | String | **参数解释**： 授予用户权限的任务ID。 **取值范围**： 不涉及。 | **状态码：400** 表7响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码。 | | error_msg | String | 错误消息。 | **状态码：500** 表8响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码。 | | error_msg | String | 错误消息。 | #### 请求示例 - 授予数据库用户数据库读写权限。 ``` POST https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/a23fb62bd61e4e9e9636fd2225f395bein07/db-users/privilege { "users" : [ { "name" : "gaussdb_mysql_user1", "host" : "127.0.0.1", "databases" : [ { "name" : "test", "readonly" : false } ] } ] } ``` - 授予数据库用户数据库只读权限。 ``` POST https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/a23fb62bd61e4e9e9636fd2225f395bein07/db-users/privilege { "users" : [ { "name" : "gaussdb_mysql_user1", "host" : "127.0.0.1", "databases" : [ { "name" : "test", "readonly" : true } ] } ] } ``` #### 响应示例 **状态码：201** ``` { "job_id" : "dff1d289-4d03-4942-8b9f-463ea07c000d" } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] - 授予数据库用户数据库读写权限。 ``` 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 AddDatabasePermissionSolution { 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("")) .build(); AddDatabasePermissionRequest request = new AddDatabasePermissionRequest(); request.withInstanceId("{instance_id}"); GrantDatabasePermissionRequestBody body = new GrantDatabasePermissionRequestBody(); List listUsersDatabases = new ArrayList<>(); listUsersDatabases.add( new DatabasePermission() .withName("test") .withReadonly(false) ); List listbodyUsers = new ArrayList<>(); listbodyUsers.add( new GrantDatabasePermission() .withName("gaussdb_mysql_user1") .withHost("127.0.0.1") .withDatabases(listUsersDatabases) ); body.withUsers(listbodyUsers); request.withBody(body); try { AddDatabasePermissionResponse response = client.addDatabasePermission(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()); } } } ``` - 授予数据库用户数据库只读权限。 ``` 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 AddDatabasePermissionSolution { 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("")) .build(); AddDatabasePermissionRequest request = new AddDatabasePermissionRequest(); request.withInstanceId("{instance_id}"); GrantDatabasePermissionRequestBody body = new GrantDatabasePermissionRequestBody(); List listUsersDatabases = new ArrayList<>(); listUsersDatabases.add( new DatabasePermission() .withName("test") .withReadonly(true) ); List listbodyUsers = new ArrayList<>(); listbodyUsers.add( new GrantDatabasePermission() .withName("gaussdb_mysql_user1") .withHost("127.0.0.1") .withDatabases(listUsersDatabases) ); body.withUsers(listbodyUsers); request.withBody(body); try { AddDatabasePermissionResponse response = client.addDatabasePermission(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()); } } } ``` - [Python] - 授予数据库用户数据库读写权限。 ``` # 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("")) \ .build() try: request = AddDatabasePermissionRequest() request.instance_id = "{instance_id}" listDatabasesUsers = [ DatabasePermission( name="test", readonly=False ) ] listUsersbody = [ GrantDatabasePermission( name="gaussdb_mysql_user1", host="127.0.0.1", databases=listDatabasesUsers ) ] request.body = GrantDatabasePermissionRequestBody( users=listUsersbody ) response = client.add_database_permission(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) ``` - 授予数据库用户数据库只读权限。 ``` # 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("")) \ .build() try: request = AddDatabasePermissionRequest() request.instance_id = "{instance_id}" listDatabasesUsers = [ DatabasePermission( name="test", readonly=True ) ] listUsersbody = [ GrantDatabasePermission( name="gaussdb_mysql_user1", host="127.0.0.1", databases=listDatabasesUsers ) ] request.body = GrantDatabasePermissionRequestBody( users=listUsersbody ) response = client.add_database_permission(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) ``` - [Go] - 授予数据库用户数据库读写权限。 ``` 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, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := gaussdb.GaussDBClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := gaussdb.NewGaussDBClient(hcClient) request := &model.AddDatabasePermissionRequest{} request.InstanceId = "{instance_id}" var listDatabasesUsers = []model.DatabasePermission{ { Name: "test", Readonly: false, }, } var listUsersbody = []model.GrantDatabasePermission{ { Name: "gaussdb_mysql_user1", Host: "127.0.0.1", Databases: listDatabasesUsers, }, } request.Body = &model.GrantDatabasePermissionRequestBody{ Users: listUsersbody, } response, err := client.AddDatabasePermission(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - 授予数据库用户数据库只读权限。 ``` 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, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := gaussdb.GaussDBClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := gaussdb.NewGaussDBClient(hcClient) request := &model.AddDatabasePermissionRequest{} request.InstanceId = "{instance_id}" var listDatabasesUsers = []model.DatabasePermission{ { Name: "test", Readonly: true, }, } var listUsersbody = []model.GrantDatabasePermission{ { Name: "gaussdb_mysql_user1", Host: "127.0.0.1", Databases: listDatabasesUsers, }, } request.Body = &model.GrantDatabasePermissionRequestBody{ Users: listUsersbody, } response, err := client.AddDatabasePermission(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/GaussDB/sdk?api=AddDatabasePermission)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 201 | Success. | | 400 | Client error. | | 500 | Server error. | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-taurusdb/ErrorCode.html)。