You need to enable JavaScript to run this app.
导航
创建资产输出任务结构预览 - AssetTablePreview
最近更新时间:2024.12.06 13:07:31首次发布时间:2024.07.10 15:50:11

请求说明

  • 请求方式:POST
  • 接口名称:AssetTablePreview
  • 请求地址: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

AssetTablePreview

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

ApiVersion

String

2023-08-08

固定值,版本号: 2023-08-08

Body

参数

类型

是否必选

示例值

描述

segIds

Array

分群列表

tagIds

Array

标签列表

idTypeId

Array

IdType列表

subjectId

Number

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

properties

Array

属性列表

Propertiem

参数

类型

是否必选

示例值

描述

propertyId

Number

123

属性ID

datasourceId

Number

123

数据档案ID

返回参数

参数

类型

示例值

描述

msg

String

成功

接口返回信息

code

Number

0

状态码,0表示正常

data

Array

[
    {
      "assetId": "1",
      "assetName": "baseid",
      "assetType": "BASEID",
      "assetTypeName": "基准Id",
      "colName": "base_id",
      "colType": "string",
      "disabled": false,
      "dependable": false,
      "dependEditEnable": false
    }
]

接口返回

TableSchemaPreview

参数

类型

示例值

描述

assetId

String

资产ID

colName

String

输出列名

colType

String

输出类型

disabled

Boolean

是否可用

assetName

String

资产名称

assetType

String

TAG
TAGV2
PROPERTY
SEGMENT
DATASET
BASEID
TARGETID
CDATE

资产类型

dependable

Boolean

是否依赖

assetTypeName

String

资产类型中文名称

dependEditEnable

Boolean

是否可编辑

请求示例

{
    "subjectId": 1,
    "segIds": [
        1000538,
        1000537
    ],
    "idTypeId": [
        123
    ],
    "tagIds": [
        1232,
        123
    ],
    "properties": [
        {
            "datasourceId": 123,
            "propertyId": 123
        }
    ]
}

返回示例

{
    "data": [
        {
            "assetId": "1",
            "assetName": "baseid",
            "assetType": "BASEID",
            "assetTypeName": "基准Id",
            "colName": "base_id",
            "colType": "string",
            "disabled": false,
            "dependable": false,
            "dependEditEnable": false
        },
        {
            "assetId": "1000537",
            "assetName": "上架的分群被下架了会怎么样",
            "assetType": "SEGMENT",
            "assetTypeName": "分群",
            "colName": "上架的分群被下架了会怎么样",
            "colType": "string",
            "disabled": false,
            "dependable": false,
            "dependEditEnable": false
        },
        {
            "assetId": "1000538",
            "assetName": "基准",
            "assetType": "SEGMENT",
            "assetTypeName": "分群",
            "colName": "基准",
            "colType": "string",
            "disabled": false,
            "dependable": false,
            "dependEditEnable": false
        },
        {
            "assetId": null,
            "assetName": "c_date",
            "assetType": "CDATE",
            "assetTypeName": "CDP业务日期",
            "colName": "c_date",
            "colType": "date",
            "disabled": false,
            "dependable": false,
            "dependEditEnable": false
        }
    ],
    "code": 0
}

错误码

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

HTTP 状态码

错误码

错误信息

说明

400

invalidParameter

PARAMETER INVALID

参数非法,检查入参。