Modifying Database Object Permissions
Function
This API is used to modify database object permissions.
Calling Method
For details, see Calling APIs.
URI
POST /v1/{project_id}/clusters/{cluster_id}/db-manager/authority
| 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 |
Request Parameters
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| type | Yes | String | Definition Object type. Range DATABASE, SCHEMA, TABLE, VIEW, COLUMN, FUNCTION, SEQUENCE, NODEGROUP, or ROLE. |
| is_grant | Yes | Boolean | Definition Whether to grant a permission. Range N/A |
| grant_list | No | Array of Grant objects | Definition List of granted permissions. This parameter is mandatory when is_grant is set to true. Range N/A |
| revoke_list | No | Array of Revoke objects | Definition List of revoked permissions. This parameter is mandatory when is_grant is set to false. Range N/A |
| role_list | Yes | Array of strings | Definition List of roles that a permission is granted. Range N/A |
| object_list | Yes | Array of strings | Definition List of objects to which a permission belongs. Range N/A |
| all_object | No | Boolean | Definition Permissions on all database objects in a schema. The default value is false. Range N/A |
| cascade | No | Boolean | Definition Whether a permission is revoked in cascading mode. The default value is true. Range N/A |
| database | Yes | String | Definition Database name. Range N/A |
| schema | No | String | Definition Schema name. Range N/A |
| table | No | String | Definition Table name. Range N/A |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| permission | Yes | String | Definition Permission name. The permission varies depending on the database object type. Range
|
| grant_with | Yes | Boolean | Definition Whether a permission is included in the grant options. Range N/A |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| permission | Yes | String | Definition Permission name. The permission varies depending on the database object type. Range
|
| revoke_with | Yes | Boolean | Definition Whether to remove a grant option. Range N/A |
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| view_sql | Array of strings | Definition SQL list. Range N/A |
Example Requests
Modify the database object permission of the cluster whose ID is a89aea88-7ea2-40bd-8ac8-8b93e169e5d6. Specifically, grant the SELECT permission of table1 and table2 in a GaussDB database to user1 and user2 in the schema public.
POST https://{Endpoint}/v1/0536cdee2200d5912f7cc00b877980f1/clusters/a89aea88-7ea2-40bd-8ac8-8b93e169e5d6/db-manager/authority
{
"type" : "table",
"is_grant" : true,
"grant_list" : [ {
"permission" : "SELECT",
"grant_with" : true
} ],
"role_list" : [ "user1", "user2" ],
"object_list" : [ "table1", "table2" ],
"database" : "gaussdb",
"schema" : "public"
} Example Responses
Status code: 200
Modification succeeded.
{
"view_sql" : [ "GRANT SELECT ON TABLE public.test_t1 TO user1 WITH GRANT OPTION;", "GRANT UPDATE ON TABLE public.test_t1 TO user1 ;" ]
} SDK Sample Code
The SDK sample code is as follows.
Modify the database object permission of the cluster whose ID is a89aea88-7ea2-40bd-8ac8-8b93e169e5d6. Specifically, grant the SELECT permission of table1 and table2 in a GaussDB database to user1 and user2 in the schema public.
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 71 | 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.*; import java.util.List; import java.util.ArrayList; public class UpdateDatabaseAuthoritySolution { 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(); UpdateDatabaseAuthorityRequest request = new UpdateDatabaseAuthorityRequest(); request.withClusterId("{cluster_id}"); DatabasePermissionReq body = new DatabasePermissionReq(); List<String> listbodyObjectList = new ArrayList<>(); listbodyObjectList.add("table1"); listbodyObjectList.add("table2"); List<String> listbodyRoleList = new ArrayList<>(); listbodyRoleList.add("user1"); listbodyRoleList.add("user2"); List<Grant> listbodyGrantList = new ArrayList<>(); listbodyGrantList.add( new Grant() .withPermission("SELECT") .withGrantWith(true) ); body.withSchema("public"); body.withDatabase("gaussdb"); body.withObjectList(listbodyObjectList); body.withRoleList(listbodyRoleList); body.withGrantList(listbodyGrantList); body.withIsGrant(true); body.withType("table"); request.withBody(body); try { UpdateDatabaseAuthorityResponse response = client.updateDatabaseAuthority(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 database object permission of the cluster whose ID is a89aea88-7ea2-40bd-8ac8-8b93e169e5d6. Specifically, grant the SELECT permission of table1 and table2 in a GaussDB database to user1 and user2 in the schema public.
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 | # 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 = UpdateDatabaseAuthorityRequest() request.cluster_id = "{cluster_id}" listObjectListbody = [ "table1", "table2" ] listRoleListbody = [ "user1", "user2" ] listGrantListbody = [ Grant( permission="SELECT", grant_with=True ) ] request.body = DatabasePermissionReq( schema="public", database="gaussdb", object_list=listObjectListbody, role_list=listRoleListbody, grant_list=listGrantListbody, is_grant=True, type="table" ) response = client.update_database_authority(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 database object permission of the cluster whose ID is a89aea88-7ea2-40bd-8ac8-8b93e169e5d6. Specifically, grant the SELECT permission of table1 and table2 in a GaussDB database to user1 and user2 in the schema public.
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 | 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.UpdateDatabaseAuthorityRequest{} request.ClusterId = "{cluster_id}" var listObjectListbody = []string{ "table1", "table2", } var listRoleListbody = []string{ "user1", "user2", } var listGrantListbody = []model.Grant{ { Permission: "SELECT", GrantWith: true, }, } schemaDatabasePermissionReq:= "public" request.Body = &model.DatabasePermissionReq{ Schema: &schemaDatabasePermissionReq, Database: "gaussdb", ObjectList: listObjectListbody, RoleList: listRoleListbody, GrantList: &listGrantListbody, IsGrant: true, Type: "table", } response, err := client.UpdateDatabaseAuthority(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