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

GetArticleBatchUploadDetail - 同步结果查询

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

首次发布时间2024.03.01 10:48:27

客户侧研发,通过该API查询内容同步的结果。

使用场景

  • 该API可按需对接,您也可以登录内容管理平台控制台-「内容引入」-「内容源管理」-「入库失败量」,查看内容入库失败记录。
  • 登录内容管理平台控制台-「内容引入」-「原始内容库」,查看已同步的内容详情。

注意事项

  • 使用限制:
    • 引入结果取决于引入队列长度和内容理解速度;内容理解速度受限于引入内容大小,快可至秒级;如有需求,可定时任务5秒查询一次,对于没有查到的,以递增延迟来做轮询。

请求说明

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

调试

请求参数

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

Query

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

GetArticleBatchUploadDetail

要执行的操作,取值:GetArticleBatchUploadDetail

Version
String

2021-01-01

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

Body

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

调用内容同步接口返回的BatchId。

返回参数

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

参数
类型
示例值
描述
Result
UploadResult

基本请求结果。

请求示例

{
"BatchId": "1707952822088727"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2021081316425701021121001820B79***",
        "Action": "GetArticleBatchUploadDetail",
        "Version": "2021-01-01",
        "Service": "volc_content_platform",
        "Region": "cn-north-1"
    },
    "Result": {
        "BatchId": "1707961755960349",
        "UploadVOList": [
            {
                "OpenId": "",
                "GroupId": "1707966728131629",
                "Reason": "[\"\"]",
                "CreateTime": 1628844120,
                "UploadStatus": "success",
                "FailedType": "",
                "ReqBody":"{\"OpenId\":\"\",\"Title\":\"今年可能是对房地产影响巨大的一年\",\"Abstract\":\"上次写了一篇文章讲1994年的改革,***。\",\"GroupType\":\"article\",\"GroupSource\":\"api\",\"Author\":{\"AuthorName\":\"某某作者\",\"AuthorAvatarUrl\":\"https://is3-ssl.mzstatic.com/image/thumb/Purple71/v4/ef/4b/75/ef4b754d-7969-65cf-fd25-9e734045a51e/source/***.jpg\",\"FollowerCount\":0,\"Description\":\"\",\"HomePageUrl\":\"\"},\"PublishTime\":1626334737,\"Content\":\"\<p data-track=\"121\"><span style=\"letter-spacing: 1px;\">1994年之前地方富,***。</span></p>\",\"CoverImages\":[{\"Url\":\"https://p1-tt.byteimg.com/origin/pgc-image/f8b99fb6d4d844988f352042f9f9efe2?from=pc\"}],\"GroupImages\":[{\"Url\":\"\"}],\"SourceName\":\"某某作者\",\"GenerateType\":\"moumouzhengqvan\",\"Link\":\"\",\"DiggCount\":0,\"CommentCount\":0,\"CommentUrl\":\"\"}",
                "SourceName": "某某作者",
                "GroupSource": "api",
                "GenerateType": "moumouzhengqvan",
                "RequestId": "1707966851821575"
            }
        ]
    }
}

错误码

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

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

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

200
600497
账户已失效

账户已失效、请联系商务

200
600500
服务未知错误

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

200
600499
账户信息不可用

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

200
600498
账号POC已结束

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