云数据库 PostgreSQL 修改账号备注-API 文档-文档中心-腾讯云

1. 接口描述

接口请求域名： postgres.tencentcloudapi.com 。

本接口（ModifyAccountRemark）用于修改账号备注。

默认接口请求频率限制：100次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：ModifyAccountRemark。
Version	是	String	公共参数，本接口取值：2017-03-12。
Region	是	String	公共参数，详见产品支持的地域列表。
DBInstanceId	是	String	实例ID，形如postgres-4wdeb0zv 示例值：postgres-6bwgamo3
UserName	是	String	实例用户名示例值：test
Remark	是	String	用户UserName对应的新备注示例值：testModifyRemark

3. 输出参数

参数名称	类型	描述
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 修改账号备注

输入示例

POST / HTTP/1.1
Host: postgres.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyAccountRemark
<公共请求参数>

{
    "UserName": "test",
    "Remark": "testModifyRemark",
    "DBInstanceId": "postgres-6bwgamo3"
}

输出示例

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

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
AuthFailure.UnauthorizedOperation	鉴权失败。
FailedOperation.CamSigAndAuthError	鉴权失败，请稍后重试。如果持续不成功，请联系客服进行处理。
FailedOperation.DatabaseAccessError	管控元数据库访问失败，请稍后重试。如果持续不成功，请联系客服进行处理。
FailedOperation.FailedOperationError	操作失败，请稍后重试。
InternalError.InternalHttpServerError	请求执行异常。
InvalidParameter.ParameterCheckError	参数检查失败。
InvalidParameterValue.AccountNotExistError	账号不存在。
InvalidParameterValue.InstanceNotExist	当前实例不存在。
InvalidParameterValue.InvalidAccountFormat	账号格式不正确。
InvalidParameterValue.InvalidAccountNameError	账号设置无效，请遵循账号命名规则：账号名需要1-16个字符，只能由字母、数字或下划线组成；不能为postgres；不能由数字、pg_及tencentdb_开头；所有规则均不区分大小写。
InvalidParameterValue.InvalidAccountNameFormatError	账号无效，请遵循账号命名规则：由字母（a-z, A-Z）、数字（0-9）、下划线（）组成，以字母或（）开头，最多63个字符。不能使用系统保留关键字，不能为postgres，且不能由pg_或tencentdb_开头。
InvalidParameterValue.InvalidParameterValueError	参数值有误。
InvalidParameterValue.ParameterCharacterError	参数无效，只允许英文字母、数字、下划线、中划线，以及全体汉字。
InvalidParameterValue.ParameterHandleError	参数处理失败，请检参数值设置是否有效。
InvalidParameterValue.ParameterLengthLimitError	参数长度超过限制。
OperationDenied.CamDeniedError	当前操作被限制。
ResourceNotFound.InstanceNotFoundError	实例不存在。

修改账号备注

本页目录：