You need to enable JavaScript to run this app.
导航
按数据源id获取CDP数据源字段列表 - QuerypropertyList
最近更新时间:2025.01.15 11:35:30首次发布时间: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

3

数据源id

Body

返回参数

参数

类型

示例值

描述

code

Number

0

状态码,0表示正常

msg

String

""

接口返回信息

data

Array

[]

数据源字段列表

CdpPropertyVo

参数

类型

示例值

描述

id

Int

277

字段id

dataSourceId

Int

18

数据源id

fieldName

String

base_id

字段名

filedType

String

int

字段类型

fieldDesc

String

描述

字段简要描述

expr

String

base_id

字段表达式

showName

String

baseId

展示名

display

Int

1

是否展示

请求示例

GET /?ApiAction=QuerypropertyList&ApiVersion=2023-02-10&dataSourceId=3

返回示例

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

错误码

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

HTTP 状态码

错误码

错误信息

说明

400

invalidParameter

PARAMETER INVALID

参数非法,检查入参。