DescribeAccountPrivileges

Last updated: 2018-10-12 16:09:08

PDF

1. API Description

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

This API (DescribeAccountPrivileges) is used to query the permissions of a database account.

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

Note: This API supports Finance regions. Since Finance regions and non-Finance regions are isolated and not interconnected. If the common parameter Region is a Finance region (such as ap-shanghai-fsi), you need to specify a domain name containing the Finance region that should be identical to the value of Region field, for example: cdb.ap-shanghai-fsi.tencentcloudapi.com.

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: DescribeAccountPrivileges
Version Yes String Common parameter. The value used for this API: 2017-03-20
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
InstanceId Yes String Instance ID, such as cdb-c1nl9rpv. It is identical to the instance ID displayed in the database console page.
User Yes String Name of the database account.
Host Yes String Domain name of the database account.

3. Output Parameters

Parameter Name Type Description
GlobalPrivileges Array of String Global permissions.
DatabasePrivileges Array of DatabasePrivilege Array of global permissions of the database.
TablePrivileges Array of TablePrivilege Array of table permissions of the database.
ColumnPrivileges Array of ColumnPrivilege Array of column permissions of the database.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Error Codes

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

Error Code Description
InvalidParameter Parameter error.

5. Example

Example 1 Query the permissions of a database account

Input example

https://cdb.tencentcloudapi.com/?Action=DescribeAccountPrivileges
&InstanceId=cdb-f35wr6wj
&User=ajnnw
&Host=127.0.0.1
&<Common request parameters>

Output example

{
  "Response": {
    "ColumnPrivileges": [
      {
        "Column": "Host",
        "Database": "mysql",
        "Privileges": [
          "SELECT",
          "INSERT"
        ],
        "Table": "user"
      }
    ],
    "DatabasePrivileges": [
      {
        "Database": "jersey_test",
        "Privileges": [
          "CREATE",
          "DROP"
        ]
      }
    ],
    "GlobalPrivileges": [
      "SELECT",
      "INSERT",
      "UPDATE",
      "DELETE",
      "CREATE",
      "DROP",
      "REFERENCES",
      "INDEX",
      "ALTER",
      "SHOW DATABASES",
      "CREATE TEMPORARY TABLES",
      "LOCK TABLES",
      "EXECUTE",
      "CREATE VIEW",
      "SHOW VIEW",
      "CREATE ROUTINE",
      "ALTER ROUTINE",
      "EVENT",
      "TRIGGER"
    ],
    "RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7",
    "TablePrivileges": [
      {
        "Database": "mysql",
        "Privileges": [
          "SELECT",
          "INSERT"
        ],
        "Table": "user"
      }
    ]
  }
}

6. Other Resources

Cloud API 3.0 comes with the following development tools to make it easier to call the API.