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

标签树信息获取接口

最近更新时间2023.02.01 11:01:03

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

概述

该接口主要用于客户侧查询标签树信息。

调前准备

  1. 接口鉴权
    详见:接口鉴权
  2. 调用接口
    注意参数 是否必填,使用正确的ServiceName、Action、Version 等url信息
    详见:下方接口信息

请求接口

请求方式

post

请求url:

https://cms.volcengineapi.com?Action=TagListTagTree&Version=2021-01-01

请求header:

ServiceName: volc_content_platform

url组成:

Host: https://cms.volcengineapi.com

Action: TagListTagTree

Version: 2021-01-01

请求参数

字段名字段类型是否必填说明可选值

RootId

string

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

Offset

number

偏移量,默认为0

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

TagType

string

标签类型,支持系统标签/自定义标签/全部类型标签的查询

注意

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

"system"/"custom"/""

响应字段

字段名
字段类型
是否必填
说明
ResponseMetadata
ResponseMetadata
Result
ListTagTreeResult
请求结果

请求示例

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

响应示例

正常响应示例

{
    "ResponseMetadata": {
        "RequestId": "20221208201933010211199080023838A0",
        "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
    }
}

异常响应示例

{
    "ResponseMetadata": {
        "RequestId": "202212082037500102020860961032B07A",
        "Action": "TagListTagTree",
        "Version": "2021-01-01",
        "Service": "volc_content_platform",
        "Region": "cn-north-1",
        "Error": {
            "CodeN": 600400,
            "Code": "600400",
            "Message": "标签类型不合法"
        }
    },
    "Result": null
}