You need to enable JavaScript to run this app.
导航
ArticleEventNotify - 内容状态同步
最近更新时间:2024.06.11 16:20:23首次发布时间:2021.08.17 20:03:22

内容在成功导入到内容管理平台后,会被执行异步质检任务。客户侧可通过本接口获取内容的状态信息。

注意事项

  • 使用限制:
    • 接口查询范围: 无穷回溯影响性能,因此接口仅支持7日内的数据查询;
  • 请求频率:
    • 接口请求时间:间隔至少需超过 2s

请求说明

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

调试

请求参数

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

Query

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

ArticleEventNotify

要执行的操作,取值:ArticleEventNotify。

Version
String

2021-01-01

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

Body

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

toutiao_api

查询指定Api来源的内容的同步状态,不传则不进行筛选查询,取值路径:控制台 - 内容引入 - 内容源管理 - Api源标识。

EventType
String

ArticleStatusUpdate

事件类型,固定值"ArticleStatusUpdate"。

CursorTime
Long

1638283523

时间锚。

说明

CursorTime使用方式:

  • 首次请求传 0,根据时间排序,返回前100条有关的数据;
  • 返回结果包含下次请求的 CursorTime 值,循环上述操作;
  • 当返回结果数据量不足100条时,说明已没有更多数据。

注意

  • CursorTime的初次请求传0或其他值,也会计算为一次请求,下一次请间隔至少2s再请求。
SubEventTypeList
Array of String

子事件类型列表。
枚举值:

SubEventType描述
AuditWait等待审核
AuditReject审核不通过
SetOnline审核通过上线
SetOffline内容下线
SetDelete内容删除
ImportFailed导入失败

返回参数

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

参数
类型
示例值
描述
Result
ArticleEventNotifyResult

请求结果。

请求示例

{
    "CursorTime": 0,
    "EventType": "ArticleStatusUpdate",
    "GenerateType": "zhihu"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2021120115463501021120913100009***",
        "Action": "ArticleEventNotify",
        "Version": "2021-01-01",
        "Service": "volc_content_platform",
        "Region": "cn-north-1"
    },
    "Result": {
        "Items": [
            {
                "EventType": "ArticleStatusUpdate",
                "SubEventType": "ImportFailed",
                "EventTime": 1638282300,
                "ArticleId": 1717862299702350,
                "GenerateType": "zhihu",
                "EventDetail": "\"{\\\"article_origin_id\\\":\\\"\\\",\\\"origin_status\\\":\\\"import\\\",\\\"current_status\\\":\\\"import_failed\\\"}\""
            },
          ...
        ],
        "CursorTime": 1638283523
    }
}

错误码

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

状态码
错误码
错误信息
说明
200
600500
服务未知错误

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

200
600400
参数错误

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