更新时间:2024-11-11 GMT+08:00

批量添加或删除单个实例的标签

功能介绍

批量添加或删除单个实例的标签。

接口约束

使用策略授权用户时,需要包含apig:instances:get、apig:instanceTags:create、apig:instanceTags:delete的授权项才允许调用此接口

调用方法

请参见如何调用API

URI

POST /v2/{project_id}/apigw/instances/{instance_id}/instance-tags/action

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

instance_id

String

实例ID,在API网关控制台的“实例信息”中获取。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

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

表3 请求Body参数

参数

是否必选

参数类型

描述

action

String

操作标识:create(创建),delete(删除)

tags

Array of TmsKeyValue objects

标签列表。

一个实例默认最多支持创建20个标签。

数组长度:0 - 20

表4 TmsKeyValue

参数

是否必选

参数类型

描述

key

String

键。

支持可用 UTF-8 格式表示的字母(包含中文)、数字和空格,以及以下字符: _ . : = + - @;

_sys_开头属于系统标签,租户不能输入

最小长度:1

最大长度:128

value

String

值。

支持可用 UTF-8 格式表示的字母(包含中文)、数字和空格,以及以下字符: _ . : / = + - @

最小长度:0

最大长度:255

响应参数

状态码: 401

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码: 403

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码: 500

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

  • 批量添加实例的标签

    {
      "action" : "create",
      "tags" : [ {
        "key" : "test-key",
        "value" : "test-value"
      } ]
    }
  • 批量删除实例的标签

    {
      "action" : "delete",
      "tags" : [ {
        "key" : "test-key1",
        "value" : "test-value"
      }, {
        "key" : "test-key2"
      } ]
    }

响应示例

状态码: 401

Unauthorized

{
  "error_code" : "APIC.7102",
  "error_msg" : "Incorrect token or token resolution failed"
}

状态码: 403

Forbidden

{
  "error_code" : "APIC.7106",
  "error_msg" : "No permissions to request for the method"
}

状态码: 500

Internal Server Error

{
  "error_code" : "APIC.9000"
}

状态码

状态码

描述

204

No Content

401

Unauthorized

403

Forbidden

500

Internal Server Error

错误码

请参见错误码