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

内容状态同步

最近更新时间2023.11.30 14:32:13

首次发布时间2021.08.17 20:03:22

概述

文章在成功导入到内容管理平台后,会被执行异步质检任务。若要获取文章的状态信息,需要调用内容状态同步接口。

说明

  • 接口请求时间: 间隔至少需超过 2s
  • 接口查询范围: 仅支持 7日 内的数据查询,因无穷回溯影响性能;
状态同步

调前准备

  1. 该接口可按需对接
  2. 接口鉴权
    详见:接口鉴权
  3. 调用接口
    注意参数 是否必填,并确保 ServiceName、Action、Version 等url信息正确
    详见:下方接口信息

请求接口

请求方式

post

请求url

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

请求header

ServiceName: volc_content_platform

url组成:

Host: https://cms.volcengineapi.com

Action: ArticleEventNotify

Version: 2021-01-01

请求参数

字段名字段类型是否必填说明
GenerateTypestring查询指定Api来源的内容的同步状态,不传则不进行筛选查询,取值路径:控制台 - 内容引入 - 内容源管理 - Api源标识
EventTypestring事件类型,固定值"ArticleStatusUpdate"
SubEventTypestring保留字段,兼容已有客户,支持单个状态查询,详见SubEventTypeEnum
SubEventTypeListlist新增字段,支持集合状态查询,推荐使用,详见SubEventTypeEnum

CursorTime

int64

时间锚

CursorTime使用方式:首次请求传 0,根据时间排序,返回前100条有关的数据;返回结果包含下次请求的 CursorTime 值,循环上述操作;若返回无数据,则继续使用上次请求的 CursorTime 值,直到有数据返回,再使用返回的 CursorTime 值。

相关字段取值

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

响应字段

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

EventDetail

EventDetail类型为字符串,由以下结构JsonEncode得到。

{
    "article_origin_id": "xxx", // 文章原始id,即内容引入接口文章OpenId
    "origin_status": "xxx", // 原状态
    "current_status": "xxx" // 现状态
}

EventDetail中 origin_status 和 current_status枚举值

_status描述
import导入中
import_failed导入失败
online已上线
wait_audit等待审核
reject_audit审核不通过
offline已下线
delete已删除

请求示例

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

响应示例

正常响应示例

{
    "ResponseMetadata": {
        "RequestId": "202112011546350102112091310000907F",
        "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\\\"}\""
            },
            {
                "EventType": "ArticleStatusUpdate",
                "SubEventType": "AuditWait",
                "EventTime": 1638282480,
                "ArticleId": 1717862878965774,
                "GenerateType": "zhihu",
                "EventDetail": "\"{\\\"article_origin_id\\\":\\\"\\\",\\\"origin_status\\\":\\\"init\\\",\\\"current_status\\\":\\\"wait_audit\\\"}\""
            }
        ],
        "CursorTime": 1638283523
    }
}

异常响应示例

参数错误

{
    "ResponseMetadata": {
        "RequestId": "20210817172205010225243147030tt4A8",
        "Action": "ArticleEventNotify",
        "Version": "2021-01-01",
        "Service": "volc_content_platform",
        "Region": "cn-north-1",
        "Error": {
            "CodeN": 600400,
            "Code": "600400",
            "Message": "参数错误"
        }
    },
    "Result": null
}

请求频率超过限制

{
    "ResponseMetadata": {
        "RequestId": "20211201155037010211209131000091F6",
        "Action": "ArticleEventNotify",
        "Version": "2021-01-01",
        "Service": "volc_content_platform",
        "Region": "cn-north-1",
        "Error": {
            "CodeN": 100027,
            "Code": "AccountFlowLimitExceeded",
            "Message": "Request was rejected because the request speed of this openAPI is beyond the current flow control limit."
        }
    }
}

错误代码

详见:错误代码表 - volc_content_platform

注意

若需排查日志,请提供接口返回的 RequestId