You need to enable JavaScript to run this app.
导航
注册数据源 - RegisterSetOriginSource
最近更新时间:2024.12.06 13:08:26首次发布时间:2024.07.12 14:50:49

请求说明

  • 请求方式: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

CDP项目ID

dataSourceName

String

注册数据源的名称

prepSetId

Int

来源数据集ID

entityType

String

主体类型

entityIdField

String

基准ID选择列

dataSourceType

Int

数据源类型

eventSource

String

事件类型

eventField

String

行为事件字段

timeField

String

行为时间字段

registerSource

String

Api创建来源

owner

String

创建人

eventParams

Array

事件参数

返回参数

参数

类型

示例值

描述

msg

String

成功

接口返回信息

code

Number

0

状态码,0表示正常

data

Object

接口返回

data字段内容

参数

类型

示例值

描述

result

Boolean

是否成功

id

Int

数据源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

参数非法,检查入参。