Help Center/ TaurusDB/ API Reference/ APIs (Recommended)/ HTAP (Standard Edition)/ Changing Permissions of a Database Account for a StarRocks Instance
Updated on 2026-01-05 GMT+08:00

Changing Permissions of a Database Account for a StarRocks Instance

Function

This API is used to change permissions of a database account for a StarRocks instance. Before calling this API:

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependency

    gaussdbformysql:htapInstance:grantUser

    Permission_management

    instance *

    • g:EnterpriseProjectId

    • g:ResourceTag/<tag-key>

    gaussdb:user:grantPrivilege

    -

URI

PUT /v3/{project_id}/instances/{instance_id}/starrocks/users/permission

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID of a tenant in a region.

To obtain this value, see Obtaining a Project ID.

Constraints

N/A

Range

The value contains 32 characters. Only letters and digits are allowed.

Default Value

N/A

instance_id

Yes

String

Definition

StarRocks instance ID, which is compliant with the UUID format.

Constraints

N/A

Range

The value contains 36 characters with a suffix of in07. Only letters and digits are allowed.

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token. To obtain this value, call the IAM API for obtaining a user token.

The value of X-Subject-Token in the response header is the token value.

Constraints

N/A

Range

N/A

Default Value

N/A

X-Language

No

String

Definition

Request language type.

Constraints

N/A

Range

  • en-us

  • zh-cn

Default Value

en-us

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

user_name

Yes

String

Definition

Username of the database account.

Constraints

This parameter is mandatory.

Range

N/A

Default Value

N/A

databases

No

Array of strings

Definition

Database list.

Constraints

N/A

Range

N/A

Default Value

N/A

dml

No

Integer

Definition

DML permissions.

Constraints

N/A

Range

  • 0: read/write permission

  • 1: read-only permission

  • 2: read-only and configuration permissions

  • 3: read/write and configuration permissions

Default Value

N/A

ddl

No

Integer

Definition

Whether DDL permissions are granted.

Constraints

N/A

Range

  • 0: No

  • 1: Yes

Default Value

N/A

Response Parameters

Status code: 200

Table 4 Response body parameter

Parameter

Type

Description

result

String

Definition

Request results.

Range

N/A

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Request

Changing permissions of a database account

PUT https://{endpoint}/v3/23a50154cf494ec9ad6883979a12db0a/instances/86fd60a5256a4592b957e8e6bb2d1b59in07/starrocks/users/permission

{
  "user_name" : "user_test",
  "dml" : 2,
  "databases" : [ "*" ]
}

Example Response

Status code: 200

Success.

{
  "result" : "SUCCESS"
}

SDK Sample Code

The SDK sample code is as follows.

Changing permissions of a database account

 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
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 UpdateStarRocksDatabaseUserPermissionSolution {

    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();
        UpdateStarRocksDatabaseUserPermissionRequest request = new UpdateStarRocksDatabaseUserPermissionRequest();
        request.withInstanceId("{instance_id}");
        StarRocksDatabaseUserPSinfo body = new StarRocksDatabaseUserPSinfo();
        List<String> listbodyDatabases = new ArrayList<>();
        listbodyDatabases.add("*");
        body.withDml(2);
        body.withDatabases(listbodyDatabases);
        body.withUserName("user_test");
        request.withBody(body);
        try {
            UpdateStarRocksDatabaseUserPermissionResponse response = client.updateStarRocksDatabaseUserPermission(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());
        }
    }
}

Changing permissions of a database account

 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
# 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 = UpdateStarRocksDatabaseUserPermissionRequest()
        request.instance_id = "{instance_id}"
        listDatabasesbody = [
            "*"
        ]
        request.body = StarRocksDatabaseUserPSinfo(
            dml=2,
            databases=listDatabasesbody,
            user_name="user_test"
        )
        response = client.update_star_rocks_database_user_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)

Changing permissions of a database account

 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
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.UpdateStarRocksDatabaseUserPermissionRequest{}
	request.InstanceId = "{instance_id}"
	var listDatabasesbody = []string{
        "*",
    }
	dmlStarRocksDatabaseUserPSinfo:= int32(2)
	request.Body = &model.StarRocksDatabaseUserPSinfo{
		Dml: &dmlStarRocksDatabaseUserPSinfo,
		Databases: &listDatabasesbody,
		UserName: "user_test",
	}
	response, err := client.UpdateStarRocksDatabaseUserPermission(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 Code

For details, see Status Codes.

Error Code

For details, see Error Codes.