Documentation|Tencent Cloud

Recent Pages

ModifyAccountRemark

Last updated: 2020-07-17 11:07:48

1. API Description

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

This API is used to modify account remarks.

A maximum of 20 requests can be initiated per second for this API.

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: postgres.ap-shanghai-fsi.tencentcloudapi.com

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 parameter. The value used for this API: ModifyAccountRemark.
Version	Yes	String	Common parameter. The value used for this API: 2017-03-12.
Region	Yes	String	Common parameter. For more information, please see the list of regions supported by the product.
DBInstanceId	Yes	String	Instance ID in the format of postgres-4wdeb0zv
UserName	Yes	String	Instance username
Remark	Yes	String	New remarks corresponding to user `UserName`

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 account remarks

Input Example

https://postgres.tencentcloudapi.com/?Action=ModifyAccountRemark
&DBInstanceId=postgres-6bwgamo3
&UserName=test
&Remark=testModifyRemark
&<Common request parameters>

Output Example

{
  "Response": {
    "RequestId": "08fdf411-5d39-44f2-8e1d-a58ee60b237d"
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

API 3.0 Explorer

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
AuthFailure.UnauthorizedOperation	Authentication failed.
InternalError.DBError	Backend database execution error.
InternalError.SystemError	System error. When this error occurs, please contact customer service for assistance.
InvalidParameter	Invalid input parameter.
InvalidParameterValue.AccountNotExist	The current account does not exist.
InvalidParameterValue.InstanceNotExist	The current instance does not exist.
InvalidParameterValue.InvalidAccountFormat	Incorrect account format.