腾讯云 BI 添加数据表

1. 接口描述

接口请求域名： bi.tencentcloudapi.com 。

添加数据表

默认接口请求频率限制：100次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：CreateDataTable。
Version	是	String	公共参数，本接口取值：2022-01-05。
Region	否	String	公共参数，此参数为可选参数。
Type	是	Integer	后端提供字典：数据表类型，1、数据库建表，2、SQL建表，3、Excel上传，4、API接入，5、腾讯文档，6、云数据库，7、手工输入，8、关联查询示例值：1
Name	是	String	数据表名称示例值：demo
ProjectId	是	Integer	无示例值：1
FoldId	否	Integer	所属文件夹示例值：1
DatasourceId	否	String	数据源Id 示例值：demo
TableName	否	String	物理表名示例值：demo
Sql	否	String	sql语句示例值：demo
ExcelUrl	否	String	excel地址示例值：demo
Fields.N	否	Array of TableField	字段配置
TableNodeType	否	Integer	多表关联使用: 1:数据源原表,2:本地表,3:Excel表,4:API表示例值：1
Tables.N	否	Array of JoinSourceTable	多表关联的原始表信息
Joins.N	否	Array of JoinRelation	多表关联的关联信息
ExtInfo	否	String	补充信息，如api数据源信息，腾讯文档接入信息等示例值：{"sheetId":"tyzxz9","fileId":"300000000$DVtDzHkKxxnq"}
AsyncRequest	否	Boolean	是否是异步示例值：true
ParentTranId	否	String	依赖的异步事务id 示例值："1"
ApiDatasourceConfig	否	ApiDatasourceConfig	API数据源配置
ParamList.N	否	Array of ParamCreateDTO	1
DlcExtInfo	否	String	dlc高级参数示例值：{"meg":"dlc高级参数"}
QueryDbData	否	String	是否查询数据库示例值：1
TableComment	否	String	数据表备注示例值：表备注
QueryFieldRemark	否	Integer	是否查询字段备注示例值：1
FieldRemarkList.N	否	Array of FieldRemarkDTO	字段备注列表

3. 输出参数

参数名称	类型	描述
ErrorInfo	ErrorInfo	自定义错误信息对象注意：此字段可能返回 null，表示取不到有效值。
Data	IdDTO	成功返回数据表的id 注意：此字段可能返回 null，表示取不到有效值。
Extra	String	额外信息注意：此字段可能返回 null，表示取不到有效值。示例值：demo
Msg	String	错误提示注意：此字段可能返回 null，表示取不到有效值。示例值：demo
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建数据表

创建数据表

输入示例

POST / HTTP/1.1
Host: bi.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateDataTable
<公共请求参数>

{
    "Type": 1,
    "Name": "testdata",
    "FoldId": 1,
    "DatasourceId": "testdata",
    "TableName": "testdata",
    "Sql": "testdata",
    "ExcelUrl": "testdata",
    "Fields": [
        {
            "DbName": "testdata",
            "AliasName": "testdata",
            "DbType": "testdata",
            "FieldType": "testdata",
            "FieldComplexType": "testdata",
            "Mark": "testdata",
            "FormatRule": "testdata",
            "IsFilter": true,
            "CalcType": "testdata",
            "CalcFormula": "testdata",
            "CalcDesc": "testdata",
            "DictId": 1,
            "DictName": "testdata",
            "TableNodeId": "testdata",
            "ExcelName": "testdata",
            "TableName": "testdata",
            "JsonPathName": "testdata",
            "Granularity": "testdata"
        }
    ],
    "ProjectId": 1,
    "TableNodeType": 1,
    "Tables": [
        {
            "TableNodeType": 1,
            "TableNodeId": "testdata",
            "ParentId": "testdata",
            "TableId": "testdata",
            "TableName": "testdata",
            "Fields": [
                {
                    "DbName": "testdata",
                    "AliasName": "testdata",
                    "DbType": "testdata",
                    "FieldType": "testdata",
                    "FieldComplexType": "testdata",
                    "Mark": "testdata",
                    "FormatRule": "testdata",
                    "IsFilter": true,
                    "CalcType": "testdata",
                    "CalcFormula": "testdata",
                    "CalcDesc": "testdata",
                    "DictId": 1,
                    "DictName": "testdata",
                    "TableNodeId": "testdata",
                    "ExcelName": "testdata",
                    "TableName": "testdata",
                    "JsonPathName": "testdata",
                    "Granularity": "testdata"
                }
            ],
            "DatasourceId": 1,
            "TableAlias": "testdata"
        }
    ],
    "Joins": [
        {
            "JoinId": "testdata",
            "SourceTableNodeId": "testdata",
            "TargetTableNodeId": "testdata",
            "JoinType": "testdata",
            "Fields": [
                {
                    "FieldJoinId": "testdata",
                    "SourceField": {
                        "DbName": "testdata",
                        "AliasName": "testdata",
                        "DbType": "testdata",
                        "FieldType": "testdata",
                        "FieldComplexType": "testdata",
                        "Mark": "testdata",
                        "FormatRule": "testdata",
                        "IsFilter": true,
                        "CalcType": "testdata",
                        "CalcFormula": "testdata",
                        "CalcDesc": "testdata",
                        "DictId": 1,
                        "DictName": "testdata",
                        "TableNodeId": "testdata",
                        "ExcelName": "testdata",
                        "TableName": "testdata",
                        "JsonPathName": "testdata",
                        "Granularity": "testdata"
                    }
                }
            ]
        }
    ],
    "ExtInfo": "testdata",
    "DlcExtInfo": "testdata",
    "AsyncRequest": true,
    "ParentTranId": "testdata",
    "ApiDatasourceConfig": {
        "FieldsJsonData": "testdata",
        "ConnectionType": 1,
        "FrequencyConfig": {
            "Frequency": "testdata",
            "Dates": [
                0
            ],
            "Time": "testdata",
            "IntervalTime": 1,
            "IntervalTimeUnit": 1,
            "Hours": [
                0
            ],
            "Minute": [
                0
            ]
        },
        "Url": "testdata",
        "RequestMethod": 1,
        "RequestHeader": "testdata",
        "RequestParams": "testdata",
        "RequestBody": "testdata",
        "UserName": "testdata",
        "Password": "testdata",
        "AuthorizationType": 1,
        "TableId": 1,
        "JsonPathDbNameMap": "testdata"
    },
    "ParamList": [
        {
            "ParamName": "testdata",
            "DefaultValue": "testdata",
            "ParamType": "testdata",
            "FormatRule": "testdata",
            "ComplexType": "testdata"
        }
    ]
}

输出示例

{
    "Response": {
        "Data": {
            "Id": 0,
            "AccessKey": "testdata",
            "ProjectId": 1,
            "TranId": "testdata",
            "TranStatus": 0
        },
        "Extra": "testdata",
        "Msg": "testdata",
        "RequestId": "testdata"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
AuthFailure	CAM签名/鉴权错误。
FailedOperation	操作失败。
InternalError	内部错误。
InternalError.Internal	内部错误。
InvalidParameter	参数错误。
InvalidParameterValue	参数取值错误。
MissingParameter	缺少参数错误。
MissingParameter.MissingParam	必填参数缺失。
OperationDenied	操作被拒绝。
RequestLimitExceeded	请求的次数超过了频率限制。
UnauthorizedOperation	未授权操作。
UnauthorizedOperation.Authorize	权限错误。
UnauthorizedOperation.UserNotExist	用户不存在。
UnknownParameter	未知参数错误。
UnsupportedOperation	操作不支持。
UnsupportedOperation.BIError	默认业务异常。