文档首页> 云堡垒机 CBH> API参考> API说明> 标签管理> 操作堡垒机实例资源标签
更新时间:2024-06-13 GMT+08:00
分享

操作堡垒机实例资源标签

功能介绍

操作堡垒机实例资源标签。

调用方法

请参见如何调用API

URI

POST /v2/{project_id}/cbs/instance/{resource_id}/tags/action

表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"获取

表3 请求Body参数

参数

是否必选

参数类型

描述

action

String

执行动作。

  • create,创建

  • delete,删除

tags

Array of ResourceTag objects

标签列表

租户权限时该字段必选,op_service权限时和sys_tags二选一。

sys_tags

Array of ResourceTag objects

系统标签列表

op_service权限可以访问,和tags二选一。

目前TMS调用时只包含一个resource_tag结构体 ,key固定为:_sys_enterprise_project_id

value是UUID或0,value为0表示默认企业项目。

现在仅支持create操作。

表4 ResourceTag

参数

是否必选

参数类型

描述

key

String

键。最大长度128个字符。

key需要满足3.1 KEY字符集规范。

value

String

值。每个值最大长度255个字符, value需要满足3.2 VALUE字符集规范。

响应参数

状态码: 401

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_description

String

校验TOKEN失败。

状态码: 403

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_description

String

租户无权限操作。

状态码: 404

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_description

String

没有找到CBH资源。

请求示例

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

响应示例

状态码

状态码

描述

204

No Content。

400

标签等参数非法

401

Unauthorized

403

Forbidden

404

Not Found

500

系统异常

错误码

请参见错误码

分享:

    相关文档

    相关产品