You need to enable JavaScript to run this app.
导航
客户数据平台
  • 文档首页
    • /客户数据平台/开放能力/OpenAPI/数据档案/ 按数据源id获取CDP数据源字段列表 - QuerypropertyList
按数据源id获取CDP数据源字段列表 - QuerypropertyList
最近更新时间：2024.12.06 13:08:26首次发布时间：2024.07.12 14:50:50
我的收藏

请求说明

  • 请求方式：GET
  • 接口名称：QuerypropertyList
  • 请求地址：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

是

QuerypropertyList

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

ApiVersion

String

是

2023-02-10

固定值，版本号：2023-02-10

dataSourceId

Int

是

数据源id

Body

无

返回参数

data 字段内容

参数

类型

示例值

描述

id

Int

0

字段id

dataSourceId

Int

0

数据源id

fieldName

String

string

字段名

filedType

String

string

字段类型

fieldDesc

String

string

字段简要描述

expr

String

string

字段表达式

showName

String

string

展示名

display

Int

0

是否展示

请求示例

无

返回示例

{
    "code": 0,
    "msg": "成功",
    "data": [
        {
            "id": 277,
            "dataSourceId": 18,
            "fieldName": "base_id",
            "filedType": "int",
            "fieldDesc": "",
            "isPartitionField": false,
            "expr": "base_id",
            "showName": "",
            "display": 1,
            "status": 1
        }
    ]
}

错误码

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

HTTP 状态码

错误码

错误信息

说明

400

invalidParameter

PARAMETER INVALID

参数非法，检查入参。