创建账号

最近更新时间:2018-09-28 14:59:57

1. 接口描述

接口请求域名: dcdb.tencentcloudapi.com 。

本接口(CreateAccount)用于创建云数据库账号。一个实例可以创建多个不同的账号,相同的用户名+不同的host是不同的账号。

默认接口请求频率限制:20次/每秒。

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi )时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:dcdb.ap-shanghai-fsi.tencentcloudapi.com 。

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateAccount
Version String 公共参数,本接口取值:2018-04-11
Region String 公共参数,详见产品支持的地域列表
InstanceId String 实例 ID,形如:dcdbt-ow728lmc,可以通过 DescribeDCDBInstances 查询实例详情获得。
UserName String AccountName
Host String 可以登录的主机,与mysql 账号的 host 格式一致,可以支持通配符,例如 %,10.%,10.20.%。
Password String 账号密码,由字母、数字或常见符号组成,不能包含分号、单引号和双引号,长度为6~32位。
ReadOnly Integer 是否创建为只读账号,0:否, 1:该账号的sql请求优先选择备机执行,备机不可用时选择主机执行,2:优先选择备机执行,备机不可用时操作失败,3:只从备机读取。
Description String 账号备注,可以包含中文、英文字符、常见符号和数字,长度为0~256字符
DelayThresh Integer 如果备机延迟超过本参数设置值,系统将认为备机发生故障
建议该参数值大于10。当ReadOnly选择1、2时该参数生效。

3. 输出参数

参数名称 类型 描述
InstanceId String 实例Id,透传入参。
UserName String 用户名,透传入参。
Host String 允许访问的 host,透传入参。
ReadOnly Integer 透传入参。
RequestId String 唯一请求ID,每次请求都会返回。定位问题时需要提供该次请求的RequestId。

4. 示例

示例1 为云数据库实例创建访问账号

输入示例

https://dcdb.tencentcloudapi.com/?Action=CreateAccount
&InstanceId=dcdbt-fdpjf5zh
&UserName=testuser1
&Host=172.17.%
&Password=1234qweri#
&Description=测试帐号
&<公共请求参数>

输出示例

{
  "Response": {
    "CdbInstanceId": "dcdbt-fdpjf5zh",
    "Host": "172.17.%",
    "Readonly": 0,
    "RequestId": "2cc4e4dc-c3e9-4858-ab80-03e3526cf24d",
    "UserName": "testuser1"
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、 SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.CreateUserFailed 创建账号失败。
FailedOperation.OssOperationFailed 请求后端接口失败。
InternalError.CamAuthFailed CAM鉴权请求失败。
InternalError.DbOperationFailed 查询数据库失败。
InternalError.GetUserListFailed 获取账号列表失败。
InvalidParameter.CharacterError 密码包含了非法字符。
InvalidParameter.GenericParameterError 参数合法性校验错误。
InvalidParameterValue.AccountAlreadyExists 想要创建的账号已经存在。
InvalidParameterValue.SuperUserForbidden 系统用户不允许操作。
ResourceUnavailable.InstanceAlreadyDeleted 数据库实例已被删除。
ResourceUnavailable.InstanceHasBeenLocked 数据库实例已经被锁定,当前无法操作。
ResourceUnavailable.InstanceStatusAbnormal 数据库实例状态不正确,当前无法操作。
UnauthorizedOperation.PermissionDenied 没有权限操作该接口或资源。
UnsupportedOperation.OldProxyVersion Proxy软件版本太旧,请联系客服升级到新版本后再试。