云开发 CloudBase 创建tcb用户

1. 接口描述

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

创建tcb用户

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：CreateUser。
Version	是	String	公共参数，本接口取值：2018-06-08。
Region	否	String	公共参数，本接口不需要传递此参数。
EnvId	是	String	环境id 示例值：test-envId
Name	是	String	用户名，用户名规则：1. 长度1-64字符 2. 只能包含大小写英文字母、数字和符号 . _ - 3. 只能以字母或数字开头 4. 不能重复示例值：zhangsan
Uid	否	String	用户ID，最多64字符，如不传则系统自动生成示例值：1001
Type	否	String	用户类型：internalUser-内部用户、externalUser-外部用户，默认internalUser（内部用户）示例值：internalUser
Password	否	String	密码，传入Uid时密码可不传。密码规则：1. 长度8-32字符（推荐12位以上） 2. 不能以特殊字符开头 3. 至少包含以下四项中的三项：小写字母a-z、大写字母A-Z、数字0-9、特殊字符()!@#$%^&*\|?><_- 示例值：Abc@123456
UserStatus	否	String	用户状态：ACTIVE（激活）、BLOCKED（冻结），默认激活示例值：ACTIVE
NickName	否	String	用户昵称，长度2-64字符示例值：张三
Phone	否	String	手机号，不能重复示例值：13800138000
Email	否	String	邮箱地址，不能重复示例值：zhangsan@example.com
AvatarUrl	否	String	头像链接，可访问的公网URL 示例值：https://example.com/avatars/zhangsan.jpg
Description	否	String	用户描述，最多200字符示例值：用户描述

3. 输出参数

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

4. 示例

示例1 创建用户

输入示例

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

{
    "EnvId": "test-envId",
    "Name": "zhangsan",
    "Uid": "1001",
    "Type": "internalUser",
    "Password": "Abc@123456",
    "UserStatus": "ACTIVE",
    "NickName": "张三",
    "Phone": "13800138000",
    "Email": "zhangsan@example.com",
    "AvatarUrl": "https://example.com/avatars/zhangsan.jpg",
    "Description": "研发部门员工"
}

输出示例

{
    "Response": {
        "Data": {
            "Uid": "1001"
        },
        "RequestId": "af638232-4d1c-4e41-b959-ea3dbe5de0be"
    }
}

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: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
AuthFailure	CAM签名/鉴权错误。
FailedOperation	操作失败。
FailedOperation.DuplicatedData	FailedOperation.DuplicatedData
FailedOperation.FlexdbResourceOverdue	FailedOperation.FlexdbResourceOverdue
InternalError	内部错误。
ResourceNotFound	资源不存在。