创建资源标签

POST/zstack/v1/tags

Headers

Authorization: OAuth the-session-uuid

Body

{
  "params": {
    "name": "new-tag",
    "value": "new-tag",
    "description": "tag-for-volume",
    "color": "#FFFFFF",
    "type": "simple"
  },
  "systemTags": [],
  "userTags": []
}

上述示例中systemTags、userTags字段可以省略。列出是为了表示body中可以包含这两个字段。

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X POST -d '{"params":{"name":"new-tag","value":"new-tag","description":"tag-for-volume","color":"#FFFFFF","type":"simple"}}' http://localhost:8080/zstack/v1/tags

参数列表

名字	类型	位置	描述	可选值	起始版本
name	String	body(包含在params结构中)	资源名称		3.2.0
value	String	body(包含在params结构中)	标签的值		3.2.0
description (可选)	String	body(包含在params结构中)	资源的详细描述		3.2.0
color (可选)	String	body(包含在params结构中)	标签的颜色		3.2.0
type (可选)	String	body(包含在params结构中)	标签的类型	simple withToken	3.2.0
resourceUuid (可选)	String	body(包含在params结构中)			3.2.0
systemTags (可选)	List	body			3.2.0
userTags (可选)	List	body			3.2.0

API返回

该API成功时返回一个空的JSON结构{}，出错时返回的JSON结构包含一个error字段，例如：

{
  "error": {
    "code": "SYS.1001",
    "description": "A message or a operation timeout",
    "details": "Create VM on KVM timeout after 300s"
  }
}

SDK示例

Java SDK

CreateTagAction action = new CreateTagAction();
action.name = "new-tag";
action.value = "new-tag";
action.description = "tag-for-volume";
action.color = "#FFFFFF";
action.type = "simple";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
CreateTagAction.Result res = action.call();

Python SDK

CreateTagAction action = new CreateTagAction();
action.name = "new-tag";
action.value = "new-tag";
action.description = "tag-for-volume";
action.color = "#FFFFFF";
action.type = "simple";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
CreateTagAction.Result res = action.call();