GrantAccountPrivileges

Recent Pages

Last updated: 2021-04-08 11:48:55

1. API Description

Domain name for API request: dcdb.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.

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: dcdb.ap-shanghai-fsi.tencentcloudapi.com

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 parameter. The value used for this API: GrantAccountPrivileges.
Version	Yes	String	Common parameter. The value used for this API: 2018-04-11.
Region	Yes	String	Common parameter. For more information, please see the list of regions supported by the product.
InstanceId	Yes	String	Instance ID in the format of dcdbt-ow728lmc.
UserName	Yes	String	Login username.
Host	Yes	String	Access host allowed for a user. An account is uniquely identified by username and host.
DbName	Yes	String	Database name. `\` indicates that global permissions will be queried (i.e., `\.\*`), in which case the `Type` and `Object` parameters will be ignored
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 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` = 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://dcdb.tencentcloudapi.com/?Action=GrantAccountPrivileges
&InstanceId=dcdbt-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

Tencent Cloud CLI 3.0

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 permissions of the account.
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 parameter
InvalidParameterValue.SuperUserForbidden	Operations by a system user are not allowed.
ResourceUnavailable.InstanceAlreadyDeleted	The database instance has been dropped.
ResourceUnavailable.InstanceStatusAbnormal	Incorrect database instance status. Operations are not allowed.
UnauthorizedOperation.PermissionDenied	You have no permission to manipulate this API or resource.

Recent Pages