tencent cloud

APIs

ModifyAccountPrivileges

Focus Mode
Font Size
Last updated: 2026-04-13 13:07:29

1. API Description

Domain name for API request: postgres.intl.tencentcloudapi.com.

This API is used to modify the permission of an account on a database object and modify the account type.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: ModifyAccountPrivileges.
Version Yes String Common Params. The value used for this API: 2017-03-12.
Region Yes String Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-nanjing, ap-seoul, ap-shanghai, ap-shanghai-fsi, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, sa-saopaulo.
DBInstanceId Yes String Instance ID. obtain through the api DescribeDBInstances.
UserName Yes String Modify the permission of this account for a database object. obtain through the DescribeAccounts api.
ModifyPrivilegeSet.N Yes Array of ModifyPrivilege Permission information to modify. supports batch modification. the maximum number of modifications per batch is 50.

3. Output Parameters

Parameter Name Type Description
RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Modifying Permissions in Batches

This example shows you how to batch modify permissions for the without_per account: grant CREATE permission on the user_schema mode under the user_database library and revoke the corresponding USAGE permission; grant SELECT permission on the users table belonging to the user_schema mode under the user_database library. Modify the type of the without_per account to tencentDBSuper.

Input Example

POST / HTTP/1.1
Host: postgres.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyAccountPrivileges
<Common request parameters>

{
    "DBInstanceId": "postgres-5cz25tr5",
    "UserName": "without_per",
    "ModifyPrivilegeSet": [
        {
            "DatabasePrivilege": {
                "Object": {
                    "ObjectType": "schema",
                    "ObjectName": "user_schema",
                    "DatabaseName": "user_database"
                },
                "PrivilegeSet": [
                    "USAGE"
                ]
            },
            "ModifyType": "revokeObject",
            "IsCascade": false
        },
        {
            "DatabasePrivilege": {
                "Object": {
                    "ObjectType": "schema",
                    "ObjectName": "user_schema",
                    "DatabaseName": "user_database"
                },
                "PrivilegeSet": [
                    "CREATE"
                ]
            },
            "ModifyType": "grantObject"
        },
        {
            "DatabasePrivilege": {
                "Object": {
                    "ObjectType": "table",
                    "ObjectName": "users",
                    "DatabaseName": "user_database",
                    "SchemaName": "user_schema"
                },
                "PrivilegeSet": [
                    "SELECT"
                ]
            },
            "ModifyType": "grantObject"
        },
        {
            "DatabasePrivilege": {
                "Object": {
                    "ObjectType": "account",
                    "ObjectName": "without_per"
                },
                "PrivilegeSet": [
                    "tencentDBSuper"
                ]
            },
            "ModifyType": "alterRole"
        }
    ]
}

Output Example

{
    "Response": {
        "RequestId": "73086328-bdfa-4bf9-8206-8a3d6b2438b1"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
DBError Backend database execution error.
FailedOperation.DatabaseAccessError Failed to access database management service. Please try again later. If the problem persists, please contact customer service.
FailedOperation.FailedOperationError Operation failed. Please try again later.
FailedOperation.PreCheckError Pre-check failed
InternalError.DBError Backend database execution error.
InvalidParameter.ParameterCheckError Failed to check the parameter.
InvalidParameterValue.InvalidAccountNameError The account setting is invalid. please follow the account naming rules: the account name must be 1-16 characters, can only consist of letters, digits, or underscores; cannot be postgres; cannot start with a digit, pg_, or tencentdb_; all rules are case-insensitive.
InvalidParameterValue.InvalidAccountNameFormatError The account is invalid. follow the account naming rules: it must consist of letters (a-z, a-z), digits (0-9), and underscores (_), start with a letter or underscore (_), and be no more than 63 characters. system reserved keywords cannot be used, 'postgres' is not allowed, and it cannot start with 'pg_' or 'tencentdb_'.
InvalidParameterValue.InvalidDatabaseObjectName Currently only support database objects with operation names composed of english, underscore, digits, and special symbols []. functions and stored procedures additionally support three special symbols (,).
InvalidParameterValue.ParameterOutOfRange Invalid parameter
OperationDenied.InstanceAccessDeniedError You do not have the permission to operate this resource.
OperationDenied.InstanceStatusLimitOpError This operation cannot be performed on an instance in this status.
OperationDenied.KernelVersionError The kernel version is too low, causing the instance to fail to create a tencentDBSuper account. if you want to use this feature, upgrade the kernel.
ResourceNotFound.InstanceNotFoundError The instance does not exist.

Help and Support

Was this page helpful?

Help us improve! Rate your documentation experience in 5 mins.

Feedback