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

UpdateSourceArticle - 更新内容属性

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

首次发布时间2023.08.04 16:56:19

该接口主要用于客户侧更新内容相关属性信息。

请求说明

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

调试

请求参数

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

Query

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

UpdateSourceArticle

要执行的操作,取值:UpdateSourceArticle

Version
String

2021-01-01

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

Body

参数
类型
是否必填
示例值
描述
Article
UpdateArticleDTO

内容

OverrideTagType
Map

{
"custom": true,
"custom_hide":false
}

Map<String,Boolean>,需要覆盖的标签的类型。

  • 标签类型:
    • custom:通用标签;
    • custom_read:只读标签;
    • custom_hide:隐藏标签。
  • 是否覆盖:
    • true:覆盖更新;
    • false:忽略标签,不覆盖更新。

返回参数

本接口无特有的返回参数。更多信息请见返回结构

请求示例

{
    "Article": {
        "Id": 1762855026600974,
        "PublishTime": 1678947745,
        "Extra": "test extra",
        "HierarchyTags": [
            {
                "TagName": "testTagName",
                "TagIdentity": "testTagIdentity",
                "ParentTagIdentity": "testParentTagIdentity",
                "TagType": "custom"
            }
        ]
    }
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202304181422553F7DB494CFE0CA3DF***",
        "Action": "UpdateSourceArticle",
        "Version": "2021-01-01",
        "Service": "volc_content_platform",
        "Region": "cn-north-1"
    },
    "Result": {}
}

错误码

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

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

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

200
600450
文章不存在

文章不存在

200
600497
账户已失效

账户已失效、请联系商务

200
600498
账号POC已结束

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

200
600499
账户信息不可用

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

200
600500
服务未知错误

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