主要用于客户侧获取内容的标签元数据信息列表。
通过OpenId获取内容标签信息,OpenId是外部业务主键ID。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必填 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | TagListArticleTagByOpenId | 要执行的操作,取值:TagListArticleTagByOpenId |
Version | String | 是 | 2021-01-01 | API的版本,取值:2021-01-01 |
参数 | 类型 | 是否必填 | 示例值 | 描述 |
---|---|---|---|---|
OpenId | String | 是 | 外部业务主键ID。 | |
GenerateType | String | 是 | Api源标识,详见:Api源标识。 | |
TagType | String | 否 | 标签类型,支持系统标签/自定义标签/全部类型标签的查询。 |
下表仅列出本接口特有的返回参数。更多信息请参见返回结构
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Result | ListArticleTagByOpenIdResult | 请求结果。 |
{ "OpenId": "7128331636910900780", "GenerateType": "zhihu", "TagType": "system" }
{ "ResponseMetadata": { "RequestId": "20230925180624DC5F4A459E4AD01EF***", "Action": "TagListArticleTagByOpenId", "Version": "2021-01-01", "Service": "volc_content_platform", "Region": "cn-north-1" }, "Result": { "ArticleHierarchyTagInfo": [ { "TagId": 1738773994801230, "TagName": "通用模型", "TagIdentity": "", "TagLevel": 1, "ParentTagId": 0, "ParentTagIdentity": "", "TagType": "system", "TagScore": 1 }, { "TagId": 1738774021485607, "TagName": "文本情感", "TagIdentity": "", "TagLevel": 2, "ParentTagId": 1738773994801230, "ParentTagIdentity": "", "TagType": "system", "TagScore": 1 }, { "TagId": 1738774021656718, "TagName": "情感偏正向", "TagIdentity": "", "TagLevel": 3, "ParentTagId": 1738774021485607, "ParentTagIdentity": "", "TagType": "system", "TagScore": 0.97824 } ] } }
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。
状态码 | 错误码 | 错误信息 | 说明 |
---|---|---|---|
200 | 600400 | 参数错误 | 内容为空,或者是入参的类型是否与文档中不一致 |
200 | 600450 | 文章不存在 | 文章不存在 |
200 | 600497 | 账户已失效 | 账户已失效、请联系商务 |
200 | 600498 | 账号POC已结束 | 检查账户的poc用量情况和使用时长情况 |
200 | 600499 | 账户信息不可用 | 检查是否在内容管理平台开户,请联系商务开户 |
200 | 600500 | 服务未知错误 | 服务内部异常,请联系商务 |