接口请求域名： bi.intl.tencentcloudapi.com 。
原始数据表字段接口信息
默认接口请求频率限制：100次/秒。
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeSourceFieldList。 |
| Version | 是 | String | 公共参数，本接口取值：2022-01-05。 |
| Region | 否 | String | 公共参数，此参数为可选参数。 |
| DataSourceId | 否 | Integer | 数据源Id |
| TableName | 否 | String | 表名 |
| Sql | 否 | String | sql内容 |
| ProjectId | 否 | Integer | 项目id |
| AsyncRequest | 否 | Boolean | 是否是异步 |
| TranId | 否 | String | 异步事务id |
| ParamList.N | 否 | Array of ParamCreateDTO | 11 |
| DlcExtInfo | 否 | String | DLC扩展参数 |
| QueryDbData | 否 | String | 是否查询数据库 |
| TableId | 否 | String | 数据表 Id |
| TableType | 否 | Integer | 后端提供字典：数据表类型，1、数据库建表，2、SQL建表，3、Excel上传，4、API接入，5、腾讯文档，6、云数据库，7、手工输入，8、关联查询 |
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ErrorInfo | ErrorInfo | 自定义错误信息对象 注意：此字段可能返回 null，表示取不到有效值。 |
| Extra | String | 额外信息 注意：此字段可能返回 null，表示取不到有效值。 |
| Msg | String | 信息 注意：此字段可能返回 null，表示取不到有效值。 |
| Data | TableColumnListData | 表中字段的列表 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
原始数据表字段接口
POST / HTTP/1.1
Host: bi.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeSourceFieldList
<公共请求参数>
{
"DataSourceId": 0,
"TableName": "testdata",
"Sql": "testdata",
"ProjectId": 1,
"AsyncRequest": true,
"TranId": "testdata",
"DlcExtInfo": "testdata",
"ParamList": [
{
"ParamName": "testdata",
"DefaultValue": "testdata",
"ParamType": "testdata",
"FormatRule": "testdata",
"ComplexType": "testdata"
}
]
}
{
"Response": {
"Extra": "testdata",
"Msg": "testdata",
"Data": {
"List": [
{
"DbName": "testdata",
"AliasName": "testdata",
"DbType": "testdata",
"FieldType": "testdata",
"Mark": "testdata",
"ExcelName": "testdata",
"DictId": 0,
"DictName": "testdata",
"TableNodeId": "testdata",
"TableName": "testdata",
"FieldComplexType": "testdata",
"FormatRule": "testdata",
"IsFilter": true,
"CalcType": "testdata",
"CalcFormula": "testdata",
"CalcDesc": "testdata",
"JsonPathName": "testdata",
"Granularity": "testdata"
}
],
"TranId": "testdata",
"TranStatus": 0
},
"RequestId": "testdata"
}
}
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError.Internal | 内部错误。 |
| MissingParameter.MissingParam | 必填参数缺失。 |
| UnauthorizedOperation.Authorize | 权限错误。 |
| UnsupportedOperation.BIError | 默认业务异常。 |
文档反馈