tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

ModifyAccountPrivileges

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

    1. API Description

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

    This API is used to modify the permissions of a TencentDB instance account.

    Note that when modifying account permissions, you need to pass in the full permission information of the account. You can query the account permission information first before modifying 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: ModifyAccountPrivileges.
    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.
    Accounts.N Yes Array of Account Database account, including username and domain name.
    GlobalPrivileges.N No Array of String Global permission. Valid values: "SELECT", "INSERT", "UPDATE", "DELETE", "CREATE", "PROCESS", "DROP", "REFERENCES", "INDEX", "ALTER", "SHOW DATABASES", "CREATE TEMPORARY TABLES", "LOCK TABLES", "EXECUTE", "CREATE VIEW", "SHOW VIEW", "CREATE ROUTINE", "ALTER ROUTINE", "EVENT", "TRIGGER", "CREATE USER", "RELOAD", "REPLICATION CLIENT", "REPLICATION SLAVE".
    Note: When “ModifyAction” is empty, if GlobalPrivileges is not passed in, it indicates the global permission will become ineffective.
    DatabasePrivileges.N No Array of DatabasePrivilege 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".
    Note: When “ModifyAction” is empty, if DatabasePrivileges is not passed in, it indicates the permission of the database will become ineffective.
    TablePrivileges.N No Array of TablePrivilege Table permission in the database. Valid values: "SELECT", "INSERT", "UPDATE", "DELETE", "CREATE", "DROP", "REFERENCES", "INDEX", "ALTER", "CREATE VIEW", "SHOW VIEW", "TRIGGER".
    Note: When “ModifyAction” is empty, if TablePrivileges is not passed in, it indicates the permission of the table will become ineffective.
    ColumnPrivileges.N No Array of ColumnPrivilege Column permission in the table. Valid values: "SELECT", "INSERT", "UPDATE", "REFERENCES".
    Note: When “ModifyAction” is empty, if ColumnPrivileges is not passed in, it indicates the permission of the column will become ineffective.
    ModifyAction No String When this parameter is not empty, it indicates that the permission will be modified. Valid values: grant (grant permission), revoke (revoke permission)

    3. Output Parameters

    Parameter Name Type Description
    AsyncRequestId String Async task request ID, which can be used to query the execution result of an async task.
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Modifying the permissions of a TencentDB instance account

    Input Example

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

{
    "InstanceId": "cdb-f35wr6wj",
    "Accounts": [
        {
            "Host": "127.0.0.1",
            "User": "ajnnw"
        }
    ],
    "GlobalPrivileges": [
        "SELECT"
    ]
}

    Output Example

    {
    "Response": {
        "RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7",
        "AsyncRequestId": "256117ed-efa08b54-61784d44-91781bbd"
    }
}

    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
    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.StatusConflict Task status conflict.
    FailedOperation.SubmitAsyncTaskError Failed to submit the task. Please try again later. If the submission remains unsuccessful, please contact customer service.
    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.UnknownError Unknown error
    InvalidParameter Parameter error.
    InvalidParameter.InstanceNotFound The instance does not exist.
    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.DataConvertError Data conversion failed.
    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.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.
    UnsupportedOperation.PrivilegesUnsupportedError Unsupported permission.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy