创建标签-CreateTag
功能介绍
新建标签
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，需具备如下身份策略权限。
授权项
访问级别
资源类型（*为必须）
条件键
别名
依赖的授权项
octopus:dataTag:create
Write
workspace *
-
-
-
URI
POST /v1.0/{project_id}/data/tags
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释： 项目ID，获取方法请参见获取项目ID。 约束限制： 不涉及 取值范围： 不涉及 默认取值： 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释： 用户Token，通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） 约束限制： 不涉及 取值范围： 不涉及 默认取值： 不涉及 |
| Content-Type | 是 | String | 参数解释： 内容类型。填application/json 约束限制： 不涉及 取值范围： 不涉及 默认取值： 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| name | 是 | String | 参数解释： 标签名称 约束限制： 不涉及 取值范围： 不涉及 默认取值： 不涉及 |
| description | 否 | String | 参数解释： 标签描述 约束限制： 不涉及 取值范围： 不涉及 默认取值： 不涉及 |
| parent_id | 否 | Integer | 参数解释： 节点父标签 约束限制： 不涉及 取值范围： 不涉及 默认取值： 15000000 |
| is_tag | 否 | Boolean | 参数解释： 是否是标签 约束限制： 不涉及 取值范围： 默认取值： true |
| simulation_tags | 否 | Array of longs | 参数解释： 仿真标签 约束限制： 最多50个 |
| workspace_id | 是 | String | 参数解释： 工作空间ID 约束限制： 不涉及 取值范围： 不涉及 默认取值： 不涉及 |
响应参数
状态码：201
| 参数 | 参数类型 | 描述 |
|---|---|---|
| payload | payloadWithSingleNumber object | 参数解释： 实际返回信息 |
| meta_info | RespMetaInfo object | 参数解释： 元数据 |
请求示例
-
POST https://{endpoint}/v1.0/{project_id}/data/tags { "name" : "tag", "description" : "remark", "parent_id" : 0, "is_tag" : true, "simulation_tags" : [ 10 ], "workspace_id" : "0" } -
POST https://{endpoint}/v1.0/{project_id}/data/tags { "name" : "432341", "is_tag" : false, "parent_id" : 0, "workspace_id" : "0" }
响应示例
状态码：201
创建成功，返回标签id
{
"meta_info" : {
"current_time" : "2022-01-01T08:08:29Z"
},
"payload" : {
"item" : 1
}
} 状态码
| 状态码 | 描述 |
|---|---|
| 201 | 创建成功，返回标签id |
| 400 | 请求参数错误 |
| 403 | 权限校验失败 |
| 404 | 找不到请求的资源 |
| 409 | 存在重名标签或标签层级超出上限 |
| 500 | 系统内部错误 |
错误码
请参见错误码。
