文档首页/API网关 APIG/API参考/专享版API（V2）/专享版-实例标签管理/查询项目下所有实例标签 - ListProjectInstanceTags
更新时间：2025-12-26 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询项目下所有实例标签 - ListProjectInstanceTags

功能介绍

查询项目下所有实例标签。

接口约束

使用策略授权用户时，需要包含apig:instanceTags:list的授权项才允许调用此接口

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    apig::listTag

    List

    -

    -

    • apig:instanceTags:list

    apig:instance:get

URI

GET /v2/{project_id}/apigw/instance-tags

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

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

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

tags

Array of TmsKeyValues objects

项目下所有实例绑定的标签列表

表4 TmsKeyValues

参数

参数类型

描述

key

String

键。

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

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

最小长度：1

最大长度：128

values

Array of strings

值。

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

状态码：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

错误描述

请求示例

无

响应示例

状态码：200

OK

{
  "tags" : [ {
    "key" : "test-key",
    "values" : [ "test-value1", "test-value2" ]
  } ]
}

状态码：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",
  "error_msg" : "Failed to request internal service"
}

状态码

状态码

描述

200

OK

401

Unauthorized

403

Forbidden

500

Internal Server Error

错误码

请参见错误码。