ModifyDBAccountDescription--云数据库 MySQL 版-火山引擎

文档中心

立即注册

导航

ModifyDBAccountDescription

最近更新时间：2024.11.05 16:00:07首次发布时间：2023.05.23 18:46:16

调用 ModifyDBAccountDescription 接口修改账号的描述信息。

请求类型

同步请求。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

参数	类型	是否必选	示例值	描述
InstanceId	String	是	mysql-r3xq0zdl****	实例 ID。
AccountName	String	是	user1	数据库账号名称。
Host	String	否	%	指定账号访问数据库的 IP 地址。默认值为 `%`。若指定 Host 为 `%`，允许该账号从任意 IP 地址访问数据库。支持使用通配符设定可访问数据库的 IP 地址段。如指定 Host 为 `192.10.10.%`，则表示该账号可从 `192.10.10.0`~`192.10.10.255` 之间的 IP 地址访问数据库。指定的 Host 需要添加在实例所绑定的白名单中，否则无法正常访问实例。可调用 ModifyAllowList 接口将 Host 添加到白名单。说明如创建的账号类型为高权限账号，主机 IP 只能指定为 `%`。即 AccountType 取值为 `Super` 时，Host 的取值只能为 `%`。
AccountDesc	String	否	这是一段账号 tester 新的描述。	数据库账号的描述信息，长度不超过 256 个字符。该字段可选，如果不设置该字段，或者设置了该字段但传入空字符串（即长度为 0），则会清空原有备注。

返回参数

null

示例

请求示例

POST /?Action=ModifyDBAccountDescription&Version=2022-01-01 HTTP/1.1
Content-Type: application/json
Host: rds.volcengineapi.com
X-Date: 20211202T101010Z
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20211202/cn-beijing/rds_mysql/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c6458****
{
    "InstanceId": "mysql-603e30e6****",
    "AccountName": "tester",
    "AccountDesc": "这是一段账号 tester 新的描述。"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202305061623384D02C7118C817025707A",
        "Action": "ModifyDBAccountDescription",
        "Version": "2022-01-01",
        "Service": "rds_mysql",
        "Region": "cn-beijing"
    },
    "Result": null
}

错误码

更多详情，请参见错误码。