更新时间:2022-01-25 GMT+08:00

批量添加删除资源标签

功能介绍

为指定实例批量添加或删除标签。

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

此接口为幂等接口:

  • 创建时,如果请求体中存在重复key,则报错。

    如果创建的标签已经存在(key相同),则覆盖。

  • 删除时,如果删除的标签不存在,默认处理成功,不对标签字符集范围做校验。

URI

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

参数说明请参见表1
表1 URI格式的参数说明

名称

是否必选

参数类型

说明

project_id

String

项目ID。通过获取项目ID获取。

resource_type

String

资源的类型:DNS-public_zone,DNS-private_zone,DNS-public_recordset,DNS-private_recordset,DNS-ptr_record。

resource_id

String

资源id。

请求

  • 参数说明
    表2 请求样例的参数说明

    名称

    是否必选

    参数类型

    说明

    tags

    Array of object

    标签列表。删除时tags结构体不能缺失。详细内容请参见表3

    action

    String

    操作标识(区分大小写):create(创建)、delete(删除)。

    表3 tags参数数据结构说明

    名称

    是否必选

    参数类型

    说明

    key

    String

    键。key不能为空,或者空字符串。不能包含“=”、“*”、“<”、“>”、“\”、“,”、“|”、“/”,且首尾字符不能为空格。

    • 操作标识为create时:最大长度36个unicode字符。
    • 操作标识为delete时:最大长度127个unicode字符。

    value

    String

    值。可以为空字符串。 不能包含“=”、“*”、“<”、“>”、“\”、“,”、“|”、“/”,且首尾字符不能为空格。

    • 操作标识为create时:该值为必选项,最大长度43个unicode字符。
    • 操作标识为delete时:该值为可选项。当不填时,根据key进行删除。最大长度255个unicode字符。
  • 请求样例
    为Zone ID为“ff8080825b8fc86c015b94bc6f8712c3”的内网域名批量添加/删除标签。
    POST https://{DNS_Endpoint}/v2/{project_id}/DNS-private_zone/ff8080825b8fc86c015b94bc6f8712c3/tags/action
    {
        "action": "create",
        "tags": [
            {
                "key": "key1",
                "value": "value1"
            },
            {
                "key": "key2",
                "value": "value2"
            }
        ]
    }
    或
    {
        "action": "delete",
        "tags": [
            {
                "key": "key1",
                "value": "value1"
            },
            {
                "key": "key2",
                "value": "value2"
            }
        ]
    }

响应

返回值

接口正常的返回值为2xx,例如200、202或者204。

返回值含义以及更多返回值请参考状态码