创建账号

最近更新时间:2024-09-10 01:51:06

我的收藏

1. 接口描述

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

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

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateAccount。
Version String 公共参数,本接口取值:2017-03-12。
Region String 公共参数,详见产品支持的 地域列表
InstanceId String 实例 ID,形如:tdsql-ow728lmc,可以通过 DescribeDBInstances 查询实例详情获得。
示例值:tdsql-fdpjf5zh
UserName String 登录用户名,由字母、数字、下划线和连字符组成,长度为1~32位。
示例值:testuser1
Host String 可以登录的主机,与mysql 账号的 host 格式一致,可以支持通配符,例如 %,10.%,10.20.%。
示例值:172.17.%
Password String 账号密码,密码需要 8-32 个字符,不能以 '/' 开头,并且必须包含小写字母、大写字母、数字和符号()~!@#$%^&*-+=_|{}[]:<>,.?/。
示例值:1234qweri#
ReadOnly Integer 是否创建为只读账号,0:否; 1:只读账号,该账号的sql请求优先选择备机执行,备机延迟时选择主机执行;2:只读账号,优先选择备机执行,备机延迟时操作报错;3:只读账号,优先选择备机执行,忽略备机延迟只读备机;
示例值:0
Description String 账号备注,可以包含中文、英文字符、常见符号和数字,长度为0~256字符
示例值:测试账号
DelayThresh Integer 根据传入时间判断备机不可用
示例值:15
SlaveConst Integer 针对只读账号,设置策略是否固定备机,0:不固定备机,即备机不满足条件与客户端不断开连接,Proxy选择其他可用备机,1:备机不满足条件断开连接,确保一个连接固定备机。
示例值:0
MaxUserConnections Integer 用户最大连接数限制参数。不传或者传0表示为不限制,对应max_user_connections参数,目前10.1内核版本不支持设置。
示例值:0
EncryptedPassword String 使用GetPublicKey返回的RSA2048公钥加密后的密码
示例值:+5DzNPbJ5s6e/SkAFgMKQ4ezgmIyKqwHR/TtkwCQP5oFzYTpXJC6iEYVkAmlbreL8XX2I/YdNsqfy184B5sKt7LcfcvTCDspbQrDlRawvcWU0lLxvSpBgL4zXlixxOIR5UmC6lvSJFHOdMzoeK2UKGuV2EG3BMuvVthHAKaFDEQh5C5UP5FsN8G+Zsf27tofNm6KRFrQksNcYvFqMEnnGWV4luXISbJI0yK0m6kyKJSAgtHtDvsGBbJ1fA3RO1p5K/usvARNPB1jzjK5TJtG5eFDsPLXDHwiHh8clQpSLhYj531Ba1uXi9yL1Zkhoc0lf4y2xoJU3N+ce+6IAfJiaw==

3. 输出参数

参数名称 类型 描述
InstanceId String 实例ID,透传入参。
示例值:tdsql-fdpjf5zh
UserName String 用户名,透传入参。
示例值:testuser1
Host String 允许访问的 host,透传入参。
示例值:172.17.%
ReadOnly Integer 透传入参。
示例值:0
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

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

在tdsql-fdpjf5zh实例中创建可读写账号testuser1,密码为1234qweri#

输入示例

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

{
    "UserName": "testuser1",
    "Description": "测试帐号",
    "InstanceId": "tdsql-fdpjf5zh",
    "ReadOnly": "0",
    "Host": "172.17.%",
    "Password": "1234qweri#"
}

输出示例

{
    "Response": {
        "RequestId": "2cc4e4dc-c3e9-4858-ab80-03e3526cf24d",
        "InstanceId": "tdsql-fdpjf5zh",
        "UserName": "testuser1",
        "Host": "172.17.%",
        "ReadOnly": 0
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

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