tencent cloud



Last updated: 2023-06-26 15:13:08

1. API Description

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

This API is used to query the permissions of a TencentDB account.
Note: Accounts with the same username but different hosts are considered as 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: DescribeAccountPrivileges.
Version Yes String Common Params. The value used for this API: 2018-04-11.
Region No String Common Params. This parameter is not required for this API.
InstanceId Yes String Instance ID in the format of dcdbt-ow7t8lmc.
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.
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 queried (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 of the table will be queried; if ColName is a specific field name, the permissions of the corresponding field will be queried.

3. Output Parameters

Parameter Name Type Description
InstanceId String Instance ID
Privileges Array of String Permission list
UserName String Database account username
Host String Database account host
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying the global permissions of TencentDB account

Input Example

&<Common request parameters>

Output Example

    "Response": {
        "RequestId": "3381c9e9-d87f-4e21-ba1d-596d6f697a7e",
        "InstanceId": "dcdbt-fdpjf5zh",
        "UserName": "testuser1",
        "Host": "172.17.%",
        "Privileges": [

5. Developer Resources


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
InternalError.CamAuthFailed CAM authentication request failed.
InternalError.DbOperationFailed Failed to query the database.
InternalError.GetRightFailed Failed to get the current permissions of the account.
InvalidParameter.GenericParameterError An error occurred while verifying parameter validity.
InvalidParameter.InstanceNotFound Failed to find the requested instance.
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.
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support