文档首页> 云堡垒机 CBH> API参考> API说明> 标签管理> 查询堡垒机实例资源的标签信息
更新时间：2024-06-13 GMT+08:00
在线调试
CLI示例
查看PDF

查询堡垒机实例资源的标签信息

功能介绍

查询堡垒机实例资源的标签信息。

调用方法

请参见如何调用API。

URI

GET /v2/{project_id}/cbs/instance/{resource_id}/tags

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。

获取方法详见API参考，附录"获取项目ID"

resource_id

是

String

资源ID。(list接口获取)

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

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

可参考"IAM获取IAM用户Token"获取

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

tags

Array of Tags objects

标签列表。
表4 Tags

参数

参数类型

描述

key

String

键。

说明：

说明：

  • key不能为空，长度1~128个字符（中文也可以输入128个字符）

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

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

  • 建议正则：^((?!sys)[\p{L}\p{Z}\p{N}_.:=+\-@]*)$

values

Array of strings

值列表。

说明：

说明：

  • 长度0~255个字符（中文也可以输入255个字符）

  • 可用 UTF-8 格式表示的字母(包含中文)、数字和空格，以及以下字符： _ . : / = + - @ 建议正则：^([\p{L}\p{Z}\p{N}_.:/=+-@]*)$

  • 资源标签值可以为空（empty or null）

  • 预定义标签值不可以为空

状态码： 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_description

String

请求参数错误。

状态码： 401

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_description

String

校验TOKEN失败。

状态码： 403

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_description

String

租户无权限操作。

状态码： 404

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_description

String

没有找到CBH资源。

请求示例

无

响应示例

状态码： 200

Show ResourceIdTags Success

{
  "tags" : [ {
    "key" : "1",
    "value" : "2"
  } ],
  "sys_tags" : [ {
    "key" : "1",
    "value" : "2"
  } ]
}

状态码

状态码

描述

200

Show ResourceIdTags Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

错误码

请参见错误码。

父主题： 标签管理