有奖捉虫:云通信与企业服务文档专题,速来> HOT

1. 接口描述

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

创建子用户

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:AddUser。
Version String 公共参数,本接口取值:2019-01-16。
Region String 公共参数,本接口不需要传递此参数。
Name String 子用户用户名
示例值:test124
Remark String 子用户备注
示例值:test
ConsoleLogin Integer 子用户是否可以登录控制台。传0子用户无法登录控制台,传1子用户可以登录控制台。
示例值:1
UseApi Integer 是否生成子用户密钥。传0不生成子用户密钥,传1生成子用户密钥。
示例值:1
Password String 子用户控制台登录密码,若未进行密码规则设置则默认密码规则为8位以上同时包含大小写字母、数字和特殊字符。只有可以登录控制台时才有效,如果传空并且上面指定允许登录控制台,则自动生成随机密码,随机密码规则为32位包含大小写字母、数字和特殊字符。
示例值:test123456
NeedResetPassword Integer 子用户是否要在下次登录时重置密码。传0子用户下次登录控制台不需重置密码,传1子用户下次登录控制台需要重置密码。
示例值:0
PhoneNum String 手机号
示例值:10086
CountryCode String 区号
示例值:86
Email String 邮箱
示例值:12340qq.com

3. 输出参数

参数名称 类型 描述
Uin Integer 子用户 UIN
示例值:100000546533
Name String 子用户用户名
示例值:test124
Password String 如果输入参数组合为自动生成随机密码,则返回生成的密码
示例值:test123456
SecretId String 子用户密钥 ID
示例值:faweffewagwaegawe
SecretKey String 子用户密钥 Key
示例值:fawef23rjhiuaefhuaifhiuawef
Uid Integer 子用户 UID
示例值:5648765
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 添加子用户

创建子账号

输入示例

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

{
    "Remark": "test",
    "Name": "test124",
    "CountryCode": "86",
    "NeedResetPassword": "0",
    "PhoneNum": "10086",
    "UseApi": "1",
    "ConsoleLogin": "1",
    "Password": "test123456",
    "Email": "123%40qq.com"
}

输出示例

{
    "Response": {
        "Uid": 5648765,
        "Uin": 100000546533,
        "Name": "test124",
        "Password": "test123456",
        "SecretId": "faweffewagwaegawe",
        "SecretKey": "fawef23rjhiuaefhuaifhiuawef",
        "RequestId": "b46d2afe-6893-4529-bc96-2c82d9214957"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
AuthFailure.UnauthorizedOperation 没有权限。
FailedOperation 操作失败。
InvalidParameter.ParamError 非法入参。
InvalidParameter.PasswordViolatedRules 密码不符合用户安全设置。
InvalidParameter.SubUserFull 子账号数量达到上限。
InvalidParameter.SubUserNameInUse 子用户名称重复。
InvalidParameter.UserNameIllegal 用户名不合法。
RequestLimitExceeded.CreateUser 创建子用户频率超过限制。