tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

ModifyAccountDescription

Last updated: 2023-06-21 15:55:42

1. API Description

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

This API is used to modify the remarks 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.

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: ModifyAccountDescription.
Version Yes String Common Params. The value used for this API: 2017-03-12.
Region No String Common Params. This parameter is not required for this API.
InstanceId Yes String Instance ID, which is in the format of tdsql-ow728lmc and can be obtained through the DescribeDBInstances API.
UserName Yes String Login username.
Host Yes String Access host allowed for user. An account is uniquely identified by username and host.
Description Yes String New account remarks, which can contain 0-256 characters.

3. Output Parameters

Parameter Name Type Description
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Modifying the remarks of a TencentDB account

Input Example

https://mariadb.tencentcloudapi.com/?Action=ModifyAccountDescription
&InstanceId=tdsql-fdpjf5zh
&UserName=testuser1
&Host=172.17.%
&Description=Test account
&<Common request parameters>

Output Example

{
    "Response": {
        "RequestId": "aef9be24-4d49-4358-8022-3405a361fd3b"
    }
}

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
InternalError.CamAuthFailed CAM authentication request failed.
InternalError.DbOperationFailed Failed to query the database.
InvalidParameter.GenericParameterError An error occurred while verifying parameter validity.
ResourceNotFound.AccountDoesNotExist The specified account does not exist.
UnauthorizedOperation.PermissionDenied You have no permission to manipulate this API or resource.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy