文档首页/ 智能边缘平台 IEF/ API参考/ API/ 标签管理/ 批量添加删除资源标签
更新时间:2024-04-22 GMT+08:00

批量添加删除资源标签

功能介绍

该API用于为指定实例批量添加或删除标签。

一个资源上最多有20个标签。

  • 此接口为幂等接口,创建时如果请求体中存在重复key则报错。
  • 创建时不允许设置重复key数据,如果数据库已存在该key,就覆盖value的值。
  • 删除时不对标签字符集范围做校验,如果删除的标签不存在,默认处理成功。删除时tags结构体不能缺失,key不能为空,或者空字符串。

URI

POST /v2/{project_id}/{resource_type}/{resource_id}/tags/action

表1 Path参数

名称

参数类型

说明

project_id

String

项目ID,获取方法请参见获取项目ID

resource_type

String

资源类型

  • ief-edge_node
  • ief-deployment
  • ief-application
  • ief-device

resource_id

String

资源ID

请求消息

请求参数

表2 请求Header参数

参数

是否必选

类型

描述

Content-Type

String

消息体的类型(格式)

推荐您使用默认值application/json。

X-Auth-Token

String

用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

ief-instance-id

String

铂金版实例ID,专业版实例为空值

表3 请求Body参数

名称

是否必选

参数类型

说明

tags

Array of resource_tag objects

标签列表

action

String

操作标识:仅限于create(创建)、delete(删除)

表4 resource_tag

名称

是否必选

参数类型

说明

key

String

键。最大长度36个unicode字符。

不能为空,只能包含大小写字母、数字、中划线-、下划线_。

value

String

(action为create时必选;action为delete时非必选)

值。每个值最大长度43个unicode字符,删除时如果value有值按照key/value删除,如果value没值,则按照key删除。

不能为空,只能包含大小写字母、数字、中划线-、下划线_。

请求示例

{
    "action": "create",
    "tags": [
        {
            "key": "key0",
            "value": "value1_new1"
        },
        {
            "key": "key1",
            "value": "value3_new"
        },
        {
            "key": "key2",
            "value": "value1_new1"
        },
        {
            "key": "key3",
            "value": "value3_new"
        },
        {
            "key": "key4",
            "value": "value1_new1"
        },
        {
            "key": "key5",
            "value": "value3_new"
        },
        {
            "key": "key6",
            "value": "value1_new1"
        },
        {
            "key": "key7",
            "value": "value3_new"
        },
        {
            "key": "key8",
            "value": ""
        }
    ]
}

响应消息

错误码

请参见错误码