tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

GrantAccountPrivileges

Last updated: 2023-06-21 15:55:42

1. API Description

Domain name for API request: mariadb.tencentcloudapi.com.

This API is used to grant permissions to a TencentDB account.
Note: accounts with the same username but different hosts are different accounts.

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: GrantAccountPrivileges.
Version Yes String Common Params. The value used for this API: 2017-03-12.
Region No String Common Params. This parameter is not required for this API.
InstanceId Yes String Instance ID, which is in the format of tdsql-ow728lmc and can be obtained through the DescribeDBInstances API.
UserName Yes String Login username.
Host Yes String Access host allowed for user. An account is uniquely identified by username and host.
DbName Yes String Database name. \* indicates that global permissions will be set (i.e., \*.\*), in which case the Type and Object parameters will be ignored. If DbName is not \*, the input parameter Type is required.
Privileges.N Yes Array of String Global permission. Valid values: SELECT, INSERT, UPDATE, DELETE, CREATE, DROP, REFERENCES, INDEX, ALTER, CREATE TEMPORARY TABLES, LOCK TABLES, EXECUTE, CREATE VIEW, SHOW VIEW, CREATE ROUTINE, ALTER ROUTINE, EVENT, TRIGGER, SHOW DATABASES, REPLICATION CLIENT, REPLICATION SLAVE.
Database permission. Valid values: SELECT, INSERT, UPDATE, DELETE, CREATE, DROP, REFERENCES, INDEX, ALTER, CREATE TEMPORARY TABLES, LOCK TABLES, EXECUTE, CREATE VIEW, SHOW VIEW, CREATE ROUTINE, ALTER ROUTINE, EVENT, TRIGGER.
Table/View permission. Valid values: SELECT, INSERT, UPDATE, DELETE, CREATE, DROP, REFERENCES, INDEX, ALTER, CREATE VIEW, SHOW VIEW, TRIGGER.
Stored procedure/function permission. Valid values: ALTER ROUTINE, EXECUTE.
Field permission. Valid values: INSERT, REFERENCES, SELECT, UPDATE.
Type No String Type. Valid values: table, view, proc, func, *. If DbName is a specific database name and Type is \*, the permissions of the database will be set (i.e., db.\*), in which case the Object parameter will be ignored
Object No String Type name. For example, if Type is table, Object indicates a specific table name; if both DbName and Type are specific names, it indicates a specific object name and cannot be \* or empty
ColName No String If Type is table and ColName is \*, the permissions will be granted to the table; if ColName is a specific field name, the permissions will be granted to the field

3. Output Parameters

Parameter Name Type Description
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Granting permissions to a TencentDB account

Input Example

https://mariadb.tencentcloudapi.com/?Action=GrantAccountPrivileges
&InstanceId=tdsql-fdpjf5zh
&UserName=testuser1
&Host=172.17.%
&DbName=*
&Type=*
&Privileges.0=select
&Privileges.1=update
&<Common request parameters>

Output Example

{
    "Response": {
        "RequestId": "87201772-351f-4fb5-9164-fe757fbadb79"
    }
}

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
FailedOperation.ModifyRightFailed Failed to modify account permissions.
FailedOperation.OssOperationFailed Failed to request the backend API.
InternalError.CamAuthFailed CAM authentication request failed.
InternalError.DbOperationFailed Failed to query the database.
InternalError.GetRightFailed Failed to get the current account permissions.
InternalError.InnerSystemError Internal system error.
InvalidParameter.GenericParameterError An error occurred while verifying parameter validity.
InvalidParameterValue.BadUserRight The specified permission could not be granted to this account.
InvalidParameterValue.IllegalRightParam Incorrect permission parameters
InvalidParameterValue.SuperUserForbidden Operations by a system user are not allowed.
ResourceUnavailable.InstanceAlreadyDeleted The database instance has been deleted.
ResourceUnavailable.InstanceStatusAbnormal Incorrect database instance status. Operations are not allowed.
UnauthorizedOperation.PermissionDenied You have no permission to manipulate this API or resource.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy