参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
Authorization | String | 是 | HMAC-SHA256 Credential=BDPP2952f97532xxxxxx/20240716/cn/openPlatform/request, SignedHeaders=host;x-content-sha256;x-date, Signature=131f3d297eb22a7xxxxxx | 详细介绍请查阅调用方式文档 |
X-Tenant | Int | 是 | 1 | 项目ID |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
ApiAction | String | 是 | batchOperateEvent | 固定值，对应“请求说明”中的“接口名称” |
ApiVersion | String | 是 | 2024-05-22 | 固定值，版本号： 2024-05-22 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
projectId | Integer | 否 | 1 | 项目ID |
dataSourceId | Integer | 否 | baseid | 数据源ID |
operationType | Integer | 否 | 1 | 操作类型 |
operator | String | 否 | admin | 操作人 |
options | Option | 否 | {} | 选项 |
events | Array | 否 | [] | 事件列表 |
Option
参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
ignoreCheck | Boolean | 是 | false | 是否跳过检查 |
UpsertEventRequest
参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
name | String | 否 | click | 事件名 |
desc | String | 否 | 点击 | 事件描述 |
params | Array< | 否 | [] | 关联属性列表，新增时有效 |
groupId | Number | 否 | 1 | 事件分类ID，可选，默认未分类 |
originId | Number | 否 | 1 | 事件ID |
showName | String | 否 | 点击 | 事件展示名 |
UpsertEventPropertyRequest
参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
name | String | 否 | xx | 属性名字段 |
desc | String | 否 | 描述 | 属性描述 |
expr | String | 否 | xx | 属性名表达式 |
type | Number | 否 | 1 | 属性类型，1=普通属性，2=公共属性 |
events | Array< | 否 | [] | 关联事件列表，新增时有效 |
originId | Number | 否 | 1 | 属性ID |
showName | String | 否 | 展示名 | 属性名展示名 |
valueType | String | 否 | string | 中间类型： |
realtimeExpr | String | 否 | string | 实时表达式，仅虚拟事件属性使用 |
storeLocation | String | 否 | xx | clickhouse/hive底表存储列 |
storeValueType | String | 否 | xx | clickhouse/hive底表真实值类型 |
参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
msg | String | "" | 接口返回信息 |
code | Number | 0 | 状态码，0表示正常 |
data | Boolean | true | 响应数据 |
{ "projectId": 1, "dataSourceId": 18, "operationType": 1, "operator": "admin" }
{ "code": 0, "msg": "成功", "data": true }
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。
HTTP 状态码 | 错误码 | 错误信息 | 说明 |
|---|---|---|---|
400 | invalidParameter | PARAMETER INVALID | 参数非法，检查入参。 |