ModifyAccountDescription

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-20.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product.
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	TencentDB account
Description	No	String	Database account remarks

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, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Modifying the remarks of a TencentDB instance account

Input Example

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

{
    "InstanceId": "xx",
    "Accounts": [
        {
            "Host": "192.168.1.1",
            "User": "user1"
        }
    ],
    "Description": "test"
}

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

Tencent Cloud CLI 3.0

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.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.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.
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.InvalidParameterValueError	Invalid parameter value
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.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

tencent cloud

Sign Up

Log in

Compute

Microservice

Data Migration

Database SaaS Tool

Data Security

Application Security

Big Data

Voice Technology

Internet of Things

Stream Services

Cloud Real-time Rendering

Management and Audit Tools

Edge Computing

Serverless

Relational Database

Networking

Business Security

Domains & Websites

Face Recognition

AI Platform Service

Middleware

Media On-Demand

Game Services

Developer Tools

Container

Essential Storage Service

Enterprise Distributed DBMS

CDN and Acceleration

Security Services

Enterprise Applications

Tencent Big Model

Natural Language Processing

Communication

Media Process Services

Education Sevices

Monitor and Operation

Distributed cloud

Data Process and Analysis

NoSQL Database

Network Security

Cloud Security

Office Collaboration

Image Creation

Optical Character Recognition

Interactive Video Services

Media SDK

Cloud Resource Management

More

1. API Description