You need to enable JavaScript to run this app.
导航
客户数据平台
  • 文档首页
    • /客户数据平台/开放能力/OpenAPI/用户分群/创建人工分群包导入文件 - legacyCreateManualSegment
创建人工分群包导入文件 - legacyCreateManualSegment
最近更新时间：2024.12.06 13:08:25首次发布时间：2024.07.12 14:50:47
我的收藏

请求说明

  • 请求方式：POST
  • 接口名称：legacyCreateManualSegment
  • 请求地址：https://console.volcengine.com/cdp/open_platform/openapi

请求参数

参数

类型

是否必选

示例值

描述

Authorization

String

是

HMAC-SHA256 Credential=BDPP2952f97532xxxxxx/20240716/cn/openPlatform/request, SignedHeaders=host;x-content-sha256;x-date, Signature=131f3d297eb22a7xxxxxx

详细介绍请查阅调用方式文档

Query

参数

类型

是否必选

示例值

描述

ApiAction

String

是

legacyCreateManualSegment

固定值，对应“请求说明”中的“接口名称”

ApiVersion

String

是

2023-08-08

固定值，版本号：2023-08-08

tenantId

Int

是

1

项目ID，参考附录-项目ID获取方式

Body

参数

类型

是否必选

示例值

描述

name

String

是

测试分群

分群名称，长度128

description

String

否

分群描述

分群描述，长度255

sourceIdType

String

是

uid

源实体code，参考数据管理-ID图谱构建

targetIdType

String

是

baseid

目标实体code，参考数据管理-ID图谱构建

abaseEnabled

Boolean

否

false

是否开启分群在线服务

sourcePlatform

String

否

finder

来源平台

detail

Object

是

{
    "uploadTaskId": 1,//文件上传id，由上传分群文件接口获取
    "updateMode": "ADD"//更新模式：ADD-追加
}

上传分群规则，结构参考下文

{
    "uploadTaskId": 1,//文件上传id，由上传分群文件接口获取
    "updateMode": "ADD"//更新模式：ADD-追加
}
  • detail字段内容

参数

类型

是否必选

示例值

描述

uploadTaskId

Int

是

上传任务id

segmentId

Int

是

导入分群id

updateMode

String

是

更新模式：ADD=增加，OVERWRITE=覆盖

返回参数

data字段内容

参数

类型

示例值

描述

id

Int

1000152

分群包id

name

String

分群名称

名称

createdBy

String

amdin

创建人

idType

String

baseid

ID类型code

idTypeName

String

c2

ID类型

result

Json

result": {
            "count": null,
            "path": null,
            "targetPath": null,
            "exportAt": null,
            "segStatus": "Exporting"
        }

分群结果
count int 分群数量
path String 分群离线文件地址
targetPath String 分群离线文件地址,同path
exportAt String 分群最新文件导出时间
segStatus String 分群最新文件导出状态，Exporting

segType

String

ManualRealtime

分群类型 ：Conditional=规则，Uploaded=上传，ManualRealtime=手动实时等

abaseEnabled

Boolean

yes

分群是否开启了在线服务配置

detail

Json

null

分群详情

groupInf

Json

[ ]

分组信息
groupId int 分组id
groupName String 分组名

encryptionMethod

String

分群加密方法：SHA256，MD5（CDP1.23新增）

desc

String

分群描述（CDP1.24新增）

scheduleType

String

分群更新方式，默认一次性（CDP1.24新增）

dependencyResource

Array

分群依赖资源的类型列表（CDP1.24新增）

authRoleInfoList

Array

分群授权角色信息，仅在查询单个分群包生效（CDP1.24新增）

请求示例

{
    "name": "分群名称",
    "desc": "描述",
    "sourceIdType": "baseid",
    "targetIdType": "baseid",
    "detail": {
        "uploadTaskId": 1,
        "updateMode": "ADD"
    },
    "sourcePlatform": null
}

返回示例

{
    "code": 0,
    "msg": "成功",
    "data": {
        "id": 1000152,
        "name": "分群名称",
        "createdBy": "admin",
        "idType": "baseid",
        "idTypeName": "基准",
        "result": {
            "count": null,
            "path": null,
            "targetPath": null,
            "exportAt": null,
            "segStatus": "Exporting"
        },
        "segType": "ManualRealtime",
        "abaseEnabled": false,
        "detail": null,
        "groupInf": []
    }
}

错误码

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

HTTP 状态码

错误码

错误信息

说明

400

invalidParameter

PARAMETER INVALID

参数非法，检查入参。