文档首页/ 标签管理服务 TMS/ API参考（安卡拉区域）/ API说明/ 预定义标签操作/ 创建预定义标签
更新时间：2025-03-31 GMT+08:00
在线调试
CLI示例
查看PDF
分享

创建预定义标签

功能介绍

用于创建预定义标签。用户创建预定义标签后，可以使用预定义标签来给资源创建标签。

该接口支持幂等特性和处理批量数据。

调用方法

详细信息请参见如何调用API。

URI

POST /v1.0/predefine_tags/action

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。说明：由于TMS是全局服务，因此调用IAM服务获取用户Token接口时需要注意作用域即scope字段应该设置为domain。响应消息头中X-Subject-Token的值即为用户Token。
表2 请求Body参数

参数

是否必选

参数类型

描述

action

是

String

操作标识（区分大小写）：create（创建）

tags

是

Array of PredefineTagRequest objects

标签列表
表3 PredefineTagRequest

参数

是否必选

参数类型

描述

key

是

String

键。

最大长度36个字符。 字符集：A-Z，a-z ， 0-9，‘-’，‘_’，UNICODE字符（\u4E00-\u9FFF）。

value

是

String

值。每个值最大长度43个字符，可以为空字符串。 字符集：A-Z，a-z ， 0-9，‘.’，‘-’，‘_’，UNICODE字符（\u4E00-\u9FFF）。

响应参数

状态码： 400

表4 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

响应错误信息
表5 RespErrorMessage

参数

参数类型

描述

error_code

String

请求错误码

error_msg

String

错误信息

状态码： 401

表6 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

响应错误信息
表7 RespErrorMessage

参数

参数类型

描述

error_code

String

请求错误码

error_msg

String

错误信息

状态码： 403

表8 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

响应错误信息
表9 RespErrorMessage

参数

参数类型

描述

error_code

String

请求错误码

error_msg

String

错误信息

状态码： 404

表10 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

响应错误信息
表11 RespErrorMessage

参数

参数类型

描述

error_code

String

请求错误码

error_msg

String

错误信息

状态码： 405

表12 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

响应错误信息
表13 RespErrorMessage

参数

参数类型

描述

error_code

String

请求错误码

error_msg

String

错误信息

状态码： 406

表14 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

响应错误信息
表15 RespErrorMessage

参数

参数类型

描述

error_code

String

请求错误码

error_msg

String

错误信息

状态码： 409

表16 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

响应错误信息
表17 RespErrorMessage

参数

参数类型

描述

error_code

String

请求错误码

error_msg

String

错误信息

状态码： 410

表18 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

响应错误信息
表19 RespErrorMessage

参数

参数类型

描述

error_code

String

请求错误码

error_msg

String

错误信息

状态码： 412

表20 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

响应错误信息
表21 RespErrorMessage

参数

参数类型

描述

error_code

String

请求错误码

error_msg

String

错误信息

状态码： 429

表22 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

响应错误信息
表23 RespErrorMessage

参数

参数类型

描述

error_code

String

请求错误码

error_msg

String

错误信息

状态码： 500

表24 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

响应错误信息
表25 RespErrorMessage

参数

参数类型

描述

error_code

String

请求错误码

error_msg

String

错误信息

状态码： 501

表26 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

响应错误信息
表27 RespErrorMessage

参数

参数类型

描述

error_code

String

请求错误码

error_msg

String

错误信息

状态码： 503

表28 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

响应错误信息
表29 RespErrorMessage

参数

参数类型

描述

error_code

String

请求错误码

error_msg

String

错误信息

请求示例

创建预定义标签

POST https://{Endpoint}/v1.0/predefine_tags/action

{
  "action" : "create",
  "tags" : [ {
    "key" : "ENV1",
    "value" : "DEV1"
  }, {
    "key" : "ENV2",
    "value" : "DEV2"
  } ]
}

响应示例

无

状态码

状态码

描述

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

405

Method Not Allowed

406

Not Acceptable

409

Conflict

410

Gone

412

Precondition Failed

429

Too Many Requests

500

Internal Server Error

501

Not Implemented

503

Service Unavailable

错误码

请参见错误码。

父主题： 预定义标签操作