概述
该接口的功能是通过openapi对api上传的分群进行编辑
请求说明
- 请求方式：POST
- 接口名称：ModifyUploadSegment
- 请求地址：https://console.volcengine.com/cdp/open_platform/openapi
请求参数
Header
参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
Authorization | String | 是 | HMAC-SHA256 Credential=BDPP2952f97532xxxxxx/20240716/cn/openPlatform/request, SignedHeaders=host;x-content-sha256;x-date, Signature=131f3d297eb22a7xxxxxx | 详细介绍请查阅调用方式文档 |
Query
参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
ApiAction | String | 是 | ModifyUploadSegment | 固定值，对应“请求说明”中的“接口名称” |
ApiVersion | String | 是 | 2025-04-30 | 固定值，版本号：2025-04-30 |
tenantId | Int | 是 | 1 | 项目ID，参考附录-项目ID获取方式 |
segId | Int | 是 | 1 | 分群ID，用户分群页面获取需要修改的分群ID |
Body
参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
desc | String | 否 | 0 | 分群描述 |
name | String | 否 | ad | 分群名称 |
scheduleType | Enum String | 否 | Once | 更新方式，默认值是Once，取值及含义如下：
|
uploadTaskId | Number | 是 | 3 | 上传任务id，来源是上传人工人群包文件到hdfs - uploadSegFileToCh中的返回值 |
sourceIdTypeId | Number | 否 | 6 | 上传 ID 类型 id，来源是查看人群包详情V2 - getSegment中的返回结果 data: |
sourcePlatform | String | 否 | CDP2 | 来源平台 |
targetIdTypeId | Number | 否 | 6 | 目标 ID 类型 id，来源是是查看人群包详情V2 - getSegment中的返回结果condition |
idMappingFilterEnable | Boolean | 否 | 0 | 是否强制将上传分群中的ID与当前全量从CDP中识别到的ID做交集，剔除未识别的ID。取值含义如下： |
返回参数
参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
code | Int | 0 | 状态码：0 为成功。错误码见附录7.3 |
msg | String | "" | 状态信息 |
data | String | Success | 成功或失败信息 |
请求示例
{ "uploadTaskId": 3, "desc": "通过api上传的分群", "name": "segment", "scheduleType": "Once", //更新方式，Once/Daily/Trigger/Realtime/，默认一次性/0一次性/1按天/2按需/3实时 "sourceIdTypeId": 6, "targetIdTypeId": 6, "sourcePlatform": "CDP2", "idMappingFilterEnable": 0 }
返回示例
{ "data": "Success", "code": 0, "msg": "" }
错误码
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。
HTTP 状态码 | 错误码 | 错误信息 | 说明 |
|---|---|---|---|
400 | invalidParameter | PARAMETER INVALID | 参数非法，检查入参。 |