DescribeAccountPrivileges

Last updated: 2020-04-02 17:51:46

    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 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

    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: 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-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 = 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 List of permissions.
    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 Query the global Permission of the cloud database account

    Input Example

    https://dcdb.tencentcloudapi.com/?Action=DescribeAccountPrivileges
    &InstanceId=dcdbt-fdpjf5zh
    &UserName=testuser1
    &Host=172.17.%
    &DbName=*
    &Type=*
    &<common request parameters>

    Output Example

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

    5. Developer Resources

    API Explorer

    This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

    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
    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.
    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.

    Was this page helpful?

    Was this page helpful?

    • Not at all
    • Not very helpful
    • Somewhat helpful
    • Very helpful
    • Extremely helpful
    Send Feedback
    Help