创建资产输出任务到oss存储 - AssetTaskCreate--客户数据平台-火山引擎

文档中心

立即注册

导航

客户数据平台

创建资产输出任务到oss存储 - AssetTaskCreate

最近更新时间：2025.01.15 11:35:31首次发布时间：2024.07.12 14:50:52

请求说明

请求方式：POST
接口名称：AssetTaskCreate
请求地址：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	String	是	1	项目ID

Query

参数	类型	是否必选	示例值	描述
ApiAction	String	是	AssetTaskCreate	固定值，对应“请求说明”中的“接口名称”
ApiVersion	String	是	2023-08-08	固定值，版本号： 2023-08-08

Body

参数	类型	是否必选	示例值	描述
taskName	String	是	xxx	任务名称
channelId	Int	是	1	渠道ID，已废弃，建议使用authAccount
subjectId	Int	是	1	主体ID，参考附录-主体ID获取方式
outputType	String	是	ThirdChannel	目前只支持ThirdChannel
dataAssetConf	DataAssetConf	是	`{}`	输出资产配置
expireTime	ExpireTime	否	`{ }`	过期时间
outputConf	Object	是	`{ "outputFrequency": "single", "authAccount": "admin", "separator": "," }`	输出终端配置,没有明确字段要求，建议先自己手动建一个任务，然后参照任务作为模板来填写下面的参数
authAccount	String	否	admin	数据行权限帐号,1.22及以后版本建议使用,有channelId的时候以channnelId对应的user为准

DataAssetConf

参数	类型	是否必选	示例值	描述
dataAssetType	String	否	SegDetail	资产类型
dataAssetDetail	SegDetail	否	{}	资产对象

SegDetail

参数	类型	是否必选	示例值	描述
segIds	Array	否	[1,2]	segIds
showIdType	Boolean	否	true	展示ID
tagDetails	TagDetails	否	分群	分群名称
entityPropertyDetails	Array	否	[]	主体属性
eventPropertyDetails	Array	否	[]	事件属性
detailPropertyDetails	Array	否	[]	明细属性

TagDetails

参数	类型	是否必选	示例值	描述
tagIds	Array	否	[1,2]	标签ID列表

EntityPropertyDetails

参数	类型	是否必选	示例值	描述
dataSourceId	Int	否	1	数据源ID
entityProperties	Array	否	[click,share]	属性

ExpireTime

参数	类型	是否必选	示例值	描述
start	String	否	2020-01-01	开始时间
end	String	否	2020-02-01	结束时间

返回参数

参数	类型	示例值	描述
msg	String	success	接口返回信息
code	Number	0	状态码，0表示正常
data	OpenApiCreateTaskResult	{}	响应数据

OpenApiCreateTaskResult

参数	类型	示例值	描述
taskId	Int	1000064	任务ID

请求示例

{
    "tenantId": 1,
    "taskName": "openapi2024-12-03T17:44:13.001",
    "dataAssetConf": {
        "dataAssetType": "SEGMENT",
        "segsDetails": {
            "segIds": [
                1000147
            ],
            "showIdType": true,
            "tagDetails": {
                "tagIds": [
                    3
                ]
            }
        }
    },
    "outputConf": {
        "outputFrequency": "single",
        "authAccount": "admin",
        "separator": ","
    },
    "outputType": "inner_storage",
    "platform": "hdfs",
    "tableType": "TotalWideTable"
}

返回示例

{
    "data": {
        "taskId": 1000064
    },
    "code": 0
}

错误码

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

HTTP 状态码	错误码	错误信息	说明
400	invalidParameter	PARAMETER INVALID	参数非法，检查入参。