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

UpdateArticleStatusByOpenId - 通过OpenId上/下线内容

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

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

通过OpenId更新原始库内容状态,OpenId是外部业务主键ID,依赖客户引入。

使用场景

调用该API后,可通过内容信息获取接口,进一步验证内容状态。

请求说明

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

调试

请求参数

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

Query

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

UpdateArticleStatusByOpenId

要执行的操作,取值:UpdateArticleStatusByOpenId

Version
String

2021-01-01

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

Body

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

外部业务主键ID。

GenerateType
String

Api源标识,取值详见:Api源标识

GroupStatus
String

内容状态,枚举值:online、offline。

返回参数

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

请求示例

{
    "OpenId":"1234567890123456",
    "GroupStatus":"offline",
    "GenerateType":"test"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2024010314105719C420D563F12E95A***",
        "Action": "UpdateArticleStatusByOpenId",
        "Version": "2021-01-01",
        "Service": "volc_content_platform",
        "Region": "cn-north-1"
    },
    "Result": {}
}

错误码

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

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

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

200
600500
服务未知错误

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

200
600499
账户信息不可用

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

200
600498
账号POC已结束

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

200
600497
账户已失效

账户已失效、请联系商务

200
600450
文章不存在

文章不存在