You need to enable JavaScript to run this app.
导航
创建资产输出任务到oss存储 - AssetTaskCreate
最近更新时间:2024.12.06 13:07:31首次发布时间:2024.07.10 15:50:11

请求说明

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

channelId

Int

subjectId

Int

主体ID,参考附录-主体ID获取方式

outputType

String

目前只支持ThirdChannel

dataAssetConf

Object

输出资产配置

dataAssetConf.dataAssetType

String

dataAssetConf.dataAssetType

Object

dataAssetConf.dataAssetType.showIdm

Bool

expireTime

Object

expireTime.start

String

expireTime.end

String

outputConf

Object

输出终端配置,没有明确字段要求,建议先自己手动建一个任务,然后参照任务作为模板来填写下面的参数

outputConf字段内容

参数

类型

示例值

描述

folder

String

输出文件夹的名字

withTimeStamp

Bool

输出文件夹是否附带时间后缀,建议为true

columnSchema

Object

这个来自上个接口的请求,值得注意的是colName会作为输出文件的列名,我们的系统不允许使用中文做列名

返回参数

参数

类型

示例值

描述

msg

String

接口返回信息

code

Number

0

状态码,0表示正常

data

Object

{ }

接口返回

请求示例

{
    "tenantId": 1,
    "taskName": "openapi2024-12-03T17:44:13.001",
    "dataAssetConf": {
        "subjectId": 1,
        "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

参数非法,检查入参。