You need to enable JavaScript to run this app.
导航
客户数据平台（私有化）
  • 文档首页
    • /客户数据平台（私有化）/开放能力/OpenAPI/数据档案/注册数据源 - RegisterSetOriginSource
注册数据源 - RegisterSetOriginSource
最近更新时间：2025.01.15 11:34:32首次发布时间：2024.07.10 15:50:10
我的收藏

请求说明

  • 请求方式：GET
  • 接口名称：RegisterSetOriginSource
  • 请求地址：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

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

X-Tenant

Int

是

1

项目ID

Query

参数

类型

是否必选

示例值

描述

ApiAction

String

是

RegisterSetOriginSource

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

ApiVersion

String

是

2024-05-22

固定值，版本号： 2024-05-22

Body

参数

类型

是否必选

示例值

描述

appId

Int

是

1

CDP项目ID

dataSourceName

String

是

xxx

注册数据源的名称

prepSetId

Int

是

2

来源数据集ID

entityType

String

否

baseid

主体类型

entityIdField

String

否

base_id

基准ID选择列

dataSourceType

Int

否

3

数据源类型

eventSource

String

否

USERDEFINED

事件类型

eventField

String

否

event

行为事件字段

timeField

String

否

event_time

行为时间字段

registerSource

String

否

cdp_gmp

Api创建来源

owner

String

否

admin

创建人

eventParams

Array

否

[click]

事件参数

返回参数

参数

类型

示例值

描述

msg

String

成功

接口返回信息

code

Number

0

状态码，0表示正常

data

RegisterSetOriginSourceResp

{}

接口返回

RegisterSetOriginSourceResp

参数

类型

示例值

描述

result

Boolean

true

是否成功

id

Int

55

数据源id

errorMsg

String

""

报错信息

请求示例

{
    "appId": 1,
    "dataSourceName": "openapiGmp2024-12-03T16:53:19.853",
    "prepSetId": 41,
    "entityType": "baseid",
    "entityIdField": "base_id",
    "dataSourceType": 3,
    "eventSource": "USERDEFINED",
    "eventField": "event",
    "timeField": "event_time",
    "registerSource": "cdp_gmp",
    "owner": "admin",
    "eventParams": []
}

返回示例

{
    "code": 0,
    "msg": "成功",
    "data": {
        "result": true,
        "errorMsg": null,
        "id": 55
    }
}

错误码

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

HTTP 状态码

错误码

错误信息

说明

400

invalidParameter

PARAMETER INVALID

参数非法，检查入参。