You need to enable JavaScript to run this app.
导航

TagListTagTree - 获取标签树信息

最近更新时间2024.03.01 10:48:25

首次发布时间2022.12.09 13:28:08

该接口主要用于客户侧查询所有标签树或者指定标签树的详细标签信息。

请求说明

  • 请求方式:POST
  • 请求地址:https://cms.volcengineapi.com?Action=TagListTagTree&Version=2021-01-01
  • 请求头:ServiceName: volc_content_platform

调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数

Query

参数
类型
是否必填
示例值
描述
Action
String

TagListTagTree

要执行的操作,取值:TagListTagTree

Version
String

2021-01-01

API的版本,取值:2021-01-01

Body

参数
类型
是否必填
示例值
描述
RootId
String

标签ID。

  • 不为空,表示获取该标签的下一层级子标签信息;
  • 为空时,表示按照标签创建时间降序获取标签信息。
Offset
Long

偏移量,默认为0。

Limit
Integer

分页大小,默认100,最大支持100条。

TagType
String

标签类型,枚举值:

标签类型
system系统标签
custom自定义标签
custom_read只读标签
custom_hide隐藏标签
""全部类型标签

注意

当RootId不为空时,必须传入正确的标签类型,不支持传"",否则会返回空数据

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构

参数
类型
示例值
描述
Result
ListTagTreeResult

请求结果

请求示例

{
   "RootId":"1739599599213646",
   "TagType":"system",
   "Limit":2,
   "Offset":0
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2022120820193301021119908002383***",
        "Action": "TagListTagTree",
        "Version": "2021-01-01",
        "Service": "volc_content_platform",
        "Region": "cn-north-1"
    },
    "Result": {
        "HierarchyTags": [
            {
                "TagId": 1739599654354973,
                "TagName": "文本情感",
                "TagIdentity": "",
                "TagLevel": 2,
                "ParentTagId": 1739599599213646,
                "ParentTagIdentity": ""
            },
            {
                "TagId": 1739653269661853,
                "TagName": "场景",
                "TagIdentity": "",
                "TagLevel": 2,
                "ParentTagId": 1739599599213646,
                "ParentTagIdentity": ""
            }
        ],
        "Total": 11
    }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码
错误码
错误信息
说明
200
600400
参数错误

内容为空,或者是入参的类型是否与文档中不一致

200
600500
服务未知错误

服务内部异常,请联系商务

200
600499
账户信息不可用

检查是否在内容管理平台开户,请联系商务开户

200
600498
账号POC已结束

检查账户的poc用量情况和使用时长情况

200
600497
账户已失效

账户已失效、请联系商务