tencent cloud

APIs

ModifyAccountDescription

下载
聚焦模式
字号
最后更新时间: 2026-10-23 11:27:16

1. API Description

Domain name for API request: cynosdb.intl.tencentcloudapi.com.

This API is used to modify database account description information.

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: 2019-01-07.
Region Yes String Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-nanjing, ap-seoul, ap-shanghai, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, sa-saopaulo.
AccountName Yes String Database account name
Description Yes String Database account description information
ClusterId Yes String Cluster ID
Host No String Host. Default value: %.

3. Output Parameters

Parameter Name Type Description
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 Description of a Database Account

Modify the description of a database account

Input Example

https://cynosdb.intl.tencentcloudapi.com/?Action=ModifyAccountDescription
&ClusterId=cynosdbpg-on5xw0ni
&AccountName=admin
&Description=admin
&<Common request parameters>

Output Example

{
    "Response": {
        "RequestId": "128046"
    }
}

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.DatabaseAccessError Database access failed. Try again later. If the issue persists, contact customer service.
InternalError.DbOperationFailed Query database failed.
InvalidParameterValue.AccountNotExistError The instance does not have an account.
InvalidParameterValue.InstanceNotFound The instance does not exist.
InvalidParameterValue.InvalidParameterValueError Parameter value is invalid.
InvalidParameterValue.ParamError Parameter error.
OperationDenied.ServerlessInstanceStatusDenied Operation not allowed in the current status of the serverless instance.
ResourceNotFound.ClusterNotFoundError The cluster does not exist.
UnauthorizedOperation.PermissionDenied CAM authentication failed.

帮助和支持

本页内容是否解决了您的问题?

填写满意度调查问卷,共创更好文档体验。

文档反馈