更新时间:2025-07-08 GMT+08:00
分享

创建用户

功能介绍

创建用户。

URI

POST /v1/{project_id}/users

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

项目ID,您可以从获取项目ID中获取。

约束限制

不涉及

取值范围

仅支持字母、数字、中划线和下划线,长度为[1-128]个字符。

默认取值

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释

用户Token。

Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。

约束限制

不涉及

取值范围

长度为[1-32768]个字符。

默认取值

不涉及

表3 请求Body参数

参数

是否必选

参数类型

描述

name

String

参数解释

用户名,长度1~60之间,首位不能为数字,特殊字符只能包含下划线“_”、中划线“-”和空格。

约束限制

不涉及

取值范围

支持字母、数字、空格、下划线、中划线,长度为[1-60]个字符。

默认取值

不涉及

password

String

参数解释

用户密码,在8-32位之间支持用户自定义密码长度,至少包含以下四种字符中的两种: 大写字母、小写字母、数字和特殊字符。

约束限制

不涉及

取值范围

必须包含至少两类字符(大写字母、小写字母、数字、特殊字符),长度为[8-32]个字符。

默认取值

不涉及

role

String

参数解释

角色类型:管理员(ADMIN)、操作者(OPERATOR)。

约束限制

不涉及

取值范围

  • ADMIN:管理员

  • OPERATOR:操作者

默认取值

不涉及

email

String

参数解释

用户邮箱,需符合邮箱格式。

约束限制

不涉及

取值范围

邮箱格式(字母、数字、下划线、点、加号、@、点、域名),长度为[0-128]个字符。

默认取值

不涉及

phone

String

参数解释

用户手机号,纯数字,长度大于等于5位,小于等于32位。必须与国家码同时存在。

约束限制

必须与areacode同时存在

取值范围

仅支持纯数字,长度为[5-32]个字符。

默认取值

不涉及

areacode

String

参数解释

国家码。中国大陆为“0086”。

约束限制

必须与phone同时存在

取值范围

仅支持纯数字,长度为[1-10]个字符。

默认取值

不涉及

settings

UserSettingDto object

参数解释

用户设置。

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

表4 UserSettingDto

参数

是否必选

参数类型

描述

job_quota

Integer

参数解释

允许同时运行的作业数。

约束限制

不涉及

取值范围

1-100

默认取值

不涉及

job_timeout

Integer

参数解释

作业执行超时时长,单位天。

约束限制

不涉及

取值范围

1-60

默认取值

不涉及

cpu_quota

Integer

参数解释

作业的CPU资源配额,单位核。

约束限制

不涉及

取值范围

1-1024

默认取值

不涉及

mem_quota

Integer

参数解释

作业的内存资源配额,单位GB。

约束限制

不涉及

取值范围

1-1024

默认取值

不涉及

projects_per_user

Integer

参数解释

用户可创建项目数配额。

约束限制

不涉及

取值范围

0-20

默认取值

2

响应参数

状态码:201

表5 响应Body参数

参数

参数类型

描述

id

String

参数解释

用户ID。

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

请求示例

创建用户,用户名为example_user,密码为example,角色为ADMIN,邮箱为example@XXXX.com,电话为12345678910,作业配额为10,作业超时时长为1天,CPU的核数配额为50,内存的配额为128GB,用户可创建的项目数为2。

https://{endpoint}/v1/{project_id}/users

{
  "name" : "example_user",
  "password" : "example",
  "role" : "ADMIN",
  "email" : "example@XXXX.com",
  "phone" : "12345678910",
  "areacode" : "0086",
  "settings" : {
    "job_quota" : 10,
    "cpu_quota" : 50,
    "mem_quota" : 128,
    "job_timeout" : 1,
    "projects_per_user" : 2
  }
}

响应示例

状态码:201

CREATED

{
  "id" : "7116d09f88fa41908676fdd4b039..."
}

状态码

状态码

描述

201

CREATED

错误码

请参见错误码

相关文档