更新时间:2025-03-21 GMT+08:00

标签管理

功能介绍

该接口可以对某一种资源进行打标签

URI

POST /v1/{project_id}/{resource_type}/{resource_id}/tags/action

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,获取方式请参见:获取项目ID,获取账号ID,日志组ID、日志流ID

最小长度:32

最大长度:32

resource_type

String

资源类型,值为groups和topics。

resource_id

String

资源id

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

从IAM服务获取的用户Token,获取方式请参见:获取用户Token

最小长度:1

最大长度:10000

Content-Type

String

该字段填为:application/json;charset=UTF-8。

最小长度:30

最大长度:30

表3 请求Body参数

参数

是否必选

参数类型

描述

action

String

添加标签方式

is_open

Boolean

是否对外接口调用

tags

Array of tagsBody objects

标签字段信息,最大可以填20个

表4 tagsBody

参数

是否必选

参数类型

描述

key

String

标签Key:只支持输入UTF-8格式表示的字母(包含中文)、数字和空格,以及以下_ . : = + - @字符且不能以下划线开头。长度不能超过128个字符

value

String

标签Value:只支持输入UTF-8格式表示的字母(包含中文)、数字和空格,以及以下_ . : / = + - @字符,长度不能超过255个字符。

响应参数

状态码:200

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码:201

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码:400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码:500

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

  • 创建标签

    POST /v1/2a473356cca5487f8373be891bffc1cf/groups/0933a172-379e-44d0-9ed9-f491b1c528ea/tags/action
    
    {
      "action" : "create",
      "is_open" : true,
      "tags" : [ {
        "key" : "zzz",
        "value" : "zzz"
      }, {
        "key" : "sgq",
        "value" : "123"
      } ]
    }
  • 删除标签

    POST /v1/2a473356cca5487f8373be891bffc1cf/groups/0933a172-379e-44d0-9ed9-f491b1c528ea/tags/action
    
    {
      "action" : "delete",
      "is_open" : true,
      "tags" : [ {
        "key" : "zzz",
        "value" : "zzz"
      }, {
        "key" : "sgq",
        "value" : "123"
      } ]
    }

响应示例

状态码:200

成功

none

状态码:201

成功

none

状态码:400

BadRequest 非法请求建议根据error_msg直接修改该请求

{
  "error_code" : "LTS.1836",
  "error_msg" : "action is create or delete"
}

状态码:500

表明服务端能被请求访问到,但是服务内部出错

{
  "error_code" : "LTS.0203",
  "error_msg" : "Internal Server Error"
}

状态码

状态码

描述

200

成功

201

成功

400

BadRequest 非法请求建议根据error_msg直接修改该请求

500

表明服务端能被请求访问到,但是服务内部出错

错误码

请参见错误码