创建标签 - CreateLabel
功能介绍
创建标签。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。
URI
POST /v1/{project_id}/system/labels
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
project_id | 是 | String | 参数解释: 项目ID,您可以从获取项目ID中获取。 约束限制: 不涉及 取值范围: 仅支持字母、数字、中划线和下划线,长度为[1-128]个字符。 默认取值: 不涉及 |
请求参数
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
X-Auth-Token | 是 | String | 参数解释: 用户Token。 Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。 约束限制: 不涉及 取值范围: 长度为[1-32768]个字符。 默认取值: 不涉及 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
name | 是 | String | 参数解释: 标签名称,用于标识标签。 约束限制: 不涉及 取值范围: 仅支持中文、字母、数字、中划线和下划线,长度为[1-32]个字符。 默认取值: 不涉及 |
description | 否 | String | 参数解释: 标签描述,用于描述标签的用途或含义。 约束限制: 不涉及 取值范围: 长度为[0-1024]个字符。 默认取值: 不涉及 |
level | 否 | Integer | 参数解释: 标签级别,用于前端颜色展示。 约束限制: 不涉及 取值范围: 整数,取值范围[1-6] 默认取值: 1 |
响应参数
状态码:201
参数 | 参数类型 | 描述 |
|---|---|---|
id | String | 参数解释: 标签ID,用于标识唯一标签。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
请求示例
创建标签,设置名称和描述。
https://{endpoint}/v1/{project_id}/system/labels
{
"name" : "labelA",
"description" : "脑科学。",
"level" : 4
} 响应示例
状态码:201
CREATED
{
"id" : "id"
} 状态码
状态码 | 描述 |
|---|---|
201 | CREATED |
错误码
请参见错误码。

