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

TagListArticleTag - 通过内容ID获取内容标签信息

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

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

主要用于客户侧获取指定内容的标签元数据信息列表。
通过内容ID获取内容标签信息,内容ID是内容推荐接口返回的GroupId。

请求说明

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

调试

请求参数

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

Query

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

TagListArticleTag

要执行的操作,取值:TagListArticleTag

Version
String

2021-01-01

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

Body

参数
类型
是否必填
示例值
描述
GroupIds
Array of String

内容id列表,列表大小最大为100。

TagType
String

标签类型,支持系统标签/自定义标签/全部类型标签的查询。
可选值:"system"/"custom",若不填则获取全部标签信息。

返回参数

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

参数
类型
示例值
描述
Result
ListArticleTagResult

请求结果。

请求示例

{
    "GroupIds":["1751615521577047"],
    "TagType":""
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20221208210936010208165106043E6***",
        "Action": "TagListArticleTag",
        "Version": "2021-01-01",
        "Service": "volc_content_platform",
        "Region": "cn-north-1"
    },
    "Result": {
        "ArticleHierarchyTagInfos": {
            "1751615521577047": [
                {
                    "TagId": 1751640160012397,
                    "TagName": "test_levelN+1",
                    "TagIdentity": "test_N+1级标签",
                    "TagLevel": 3,
                    "ParentTagId": 1751639533756477,
                    "ParentTagIdentity": "test_子级标签",
                    "TagType": "system",
                    "TagScore": 0.8921681530836807
                    
                },
                {
                    "TagId": 1744738298126344,
                    "TagName": "custom.根标签",
                    "TagIdentity": "custom.rootid",
                    "TagLevel": 1,
                    "ParentTagId": 0,
                    "ParentTagIdentity": "",
                    "TagType": "system",
                    "TagScore": 1
                },
                {
                    "TagId": 1751639533756477,
                    "TagName": "test_levelN",
                    "TagIdentity": "test_子级标签",
                    "TagLevel": 2,
                    "ParentTagId": 1744738298126344,
                    "ParentTagIdentity": "custom.rootid",
                    "TagType": "system",
                    "TagScore": 1
                },
                ...
            ]
        }
    }
}

错误码

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

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

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

200
600450
文章不存在

文章不存在

200
600497
账户已失效

账户已失效、请联系商务

200
600498
账号POC已结束

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

200
600499
账户信息不可用

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

200
600500
服务未知错误

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

数据结构

  • ArticleHierarchyTagVO
名称类型描述
TagIdLong标签ID
TagNameString标签名称
TagIdentityString标签标识
TagLevelInteger标签层级
ParentTagIdLong父标签ID
ParentTagIdentityString父标签标识
TagTypeString标签类型
TagScoreFloat内容关联的标签分值