文档首页/ 虚拟私有云 VPC/ API参考 (巴黎区域) / API/ 弹性IP资源标签管理/ 批量创建和删除弹性IP资源标签
更新时间：2024-03-05 GMT+08:00
查看PDF
分享

批量创建和删除弹性IP资源标签

功能介绍

为指定的弹性IP资源实例批量添加或删除标签。

此接口为幂等接口：

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

创建时，不允许设置重复key数据，如果数据库已存在该key，就覆盖value的值。

删除时，如果删除的标签不存在，默认处理成功，删除时不对标签字符集范围做校验。删除时tags结构体不能缺失，key不能为空，或者空字符串。

URI

POST /v2.0/{project_id}/publicips/{publicip_id}/tags/action

参数说明请参见表1。

表1 参数说明

名称

是否必选

说明

project_id

是

项目ID，请参见获取项目ID。

publicip_id

是

EIP唯一标识

请求消息

  • 请求参数
    表2 请求参数

    参数名称

    类型

    是否必选

    说明

    tags

    Array of tag objects

    是

    tag对象列表，请参见表3。

    action

    String

    是

    操作标识：

    • create：创建
    • delete：删除
    表3 tag对象

    属性

    类型

    必选

    说明

    key

    String

    是
    • 标签名称
    • 不能为空。
    • 长度不超过36个字符。
    • 由英文字母、数字、下划线、中划线、中文字符组成。
    • 同一资源的key值不能重复。

    value

    String

    是
    • 标签值
    • 长度不超过43个字符。
    • 由英文字母、数字、下划线、点、中划线、中文字符组成。
  • 请求样例1：批量创建标签 
    POST https://{Endpoint}/v2.0/{project_id}/publicips/{publicip_id}/tags/action

{
    "action": "create",
    "tags": [
        {
            "key": "key1",
            "value": "value1"
        },
        {
            "key": "key2",
            "value": "value3"
        }
    ]
}
  • 请求样例2：批量删除标签 
    POST https://{Endpoint}/v2.0/{project_id}/publicips/{publicip_id}/tags/action

{
    "action": "delete",
    "tags": [
        {
            "key": "key1",
            "value": "value1"
        },
        {
            "key": "key2",
            "value": "value3"
        }
    ]
}

响应消息

  • 响应参数

    无

  • 响应样例

    无

    或

    {
       "code":"xxx",
       "message":"xxxxx"
}

状态码

请参见状态码。

错误码

请参考错误码。