tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeAccountPrivileges

Last updated: 2024-01-30 10:26:37

    1. API Description

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

    This API (DescribeAccountPrivileges) is used to query the information of TencentDB account permissions.

    A maximum of 10 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: 2017-03-20.
    Region No String Common Params. This parameter is not required for this API.
    InstanceId Yes String Instance ID in the format of cdb-c1nl9rpv. It is the same as the instance ID displayed on the TencentDB Console page.
    User Yes String Database user account.
    Host Yes String Database account domain name.

    3. Output Parameters

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

    4. Example

    Example1 Querying the permission information of a TencentDB account

    Input Example

    POST / HTTP/1.1
Host: cdb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAccountPrivileges
<Common request parameters>

{
    "InstanceId": "cdb-f35wr6wj",
    "Host": "127.0.0.1",
    "User": "ajnnw"
}

    Output Example

    {
    "Response": {
        "RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7",
        "TablePrivileges": [
            {
                "Table": "user",
                "Privileges": [
                    "SELECT",
                    "INSERT"
                ],
                "Database": "mysql"
            }
        ],
        "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"
        ],
        "ColumnPrivileges": [
            {
                "Column": "Host",
                "Table": "user",
                "Privileges": [
                    "SELECT",
                    "INSERT"
                ],
                "Database": "mysql"
            }
        ],
        "DatabasePrivileges": [
            {
                "Privileges": [
                    "CREATE",
                    "DROP"
                ],
                "Database": "jersey_test"
            }
        ]
    }
}

    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
    CdbError Backend or process error.
    FailedOperation.CreateAccountError Creation failed. Please check whether the user already exists.
    FailedOperation.GetPrivilegeError An error occurred while obtaining permissions.
    FailedOperation.PrivilegeDataIllegal The executed operation to modify permissions is invalid. You can refer to product documentation for more information about permissions that can be modified for this instance. If you have any questions, please contact customer service.
    FailedOperation.ResponseValueError Exception with the backend request for the service. Please contact customer service.
    FailedOperation.StartFlowError Failed to initiate the operation. Please try again later. If the operation remains unsuccessful, please contact customer service.
    FailedOperation.SubmitAsyncTaskError Failed to submit the task. Please try again later. If the submission remains unsuccessful, please contact customer service.
    InternalError.CdbError System error.
    InternalError.HttpError Exceptional HTTP request
    InternalError.InternalAssertError Internal service error. Please contact customer service.
    InternalError.InternalHttpServerError An exception occurred while executing the request.
    InternalError.InternalRequestError The backend failed to request the service. Please contact customer service.
    InternalError.RegexpCompileError Regular expression compilation error.
    InternalError.UndefinedError Unknown error
    InternalError.UnknownError Unknown error
    InvalidParameter Parameter error.
    InvalidParameterValue.AccountDescriptionCharacterError The account description contains special characters.
    InvalidParameterValue.AccountDescriptionLengthError The account description should not exceed 255 characters.
    InvalidParameterValue.AccountHostRuleError Incorrect format of the host parameter in the account.
    InvalidParameterValue.AccountPasswordCharacterError The account password contains invalid characters.
    InvalidParameterValue.AccountPasswordLengthError The account password is too long or too short.
    InvalidParameterValue.AccountPasswordRuleError The password format is incorrect. It should contain 8 to 64 characters and must contain at least two character sets of the following: letters, digits, and special symbols (_+-&=!@#$%^*()).
    InvalidParameterValue.UserNameRuleError Incorrect format of the account username.
    InvalidParameterValue.UserNotExistError The account does not exist.
    InvalidParameterValue.VerifyAccountNoRootError No root account found.
    InvalidParameterValue.VerifyAccountPasswordError Invalid account password.
    InvalidParameterValue.VerifyAccountPrivError The account does not have the GRANT permission.
    MissingParameter.AccountMissingParameterError Account-related parameters are missing.
    OperationDenied.DeleteRootAccountError The root account cannot be deleted.
    OperationDenied.InstanceStatusError Exceptional instance status
    OperationDenied.NotSupportModifyLocalRootHostError The host information of the local root account cannot be modified.
    ResourceNotFound.CdbInstanceNotFoundError The instance cannot be found. Please check whether your instance status is normal.
    ResourceNotFound.InstanceNotFundError The instance does not exist.
    UnsupportedOperation.PrivilegesUnsupportedError Unsupported permission.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy