Domain name for API request: bi.intl.tencentcloudapi.com.
Add a data table
A maximum of 100 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: CreateDataTable. |
| Version | Yes | String | Common Params. The value used for this API: 2022-01-05. |
| Region | No | String | Common Params. This parameter is not required. |
| Type | Yes | Integer | The backend provides a dictionary: table type, 1. database table creation, 2. SQL table creation, 3. Excel upload, 4. API connection, 5. Tencent documentation, 6. cloud database, 7. manually enter, 8. join query. |
| Name | Yes | String | Data table name |
| ProjectId | Yes | Integer | None. |
| FoldId | No | Integer | folder |
| DatasourceId | No | String | data source Id |
| TableName | No | String | physical table name |
| Sql | No | String | sql statement |
| ExcelUrl | No | String | excel address |
| Fields.N | No | Array of TableField | configure field |
| TableNodeType | No | Integer | Multi-table join usage: 1: Data source original table, 2: Local table, 3: Excel table, 4: API table |
| Tables.N | No | Array of JoinSourceTable | Original table information for multi-table join |
| Joins.N | No | Array of JoinRelation | Multi-table join association information |
| ExtInfo | No | String | Additional info, such as api data source info and Tencent document access info |
| AsyncRequest | No | Boolean | whether |
| ParentTranId | No | String | dependent async transaction id |
| ApiDatasourceConfig | No | ApiDatasourceConfig | API data source configuration |
| ParamList.N | No | Array of ParamCreateDTO | 1 |
| DlcExtInfo | No | String | dlc advanced parameter |
| QueryDbData | No | String | Query database required or not |
| TableComment | No | String | Table remark |
| QueryFieldRemark | No | Integer | Whether to query field remarks |
| FieldRemarkList.N | No | Array of FieldRemarkDTO | Field remarks list |
| Parameter Name | Type | Description |
|---|---|---|
| ErrorInfo | ErrorInfo | Custom error information object Note: This field may return null, indicating that no valid values can be obtained. |
| Data | IdDTO | Returned data table id on success Note: This field may return null, indicating that no valid values can be obtained. |
| Extra | String | Additional Information Note: This field may return null, indicating that no valid values can be obtained. |
| Msg | String | Error prompt Note: This field may return null, indicating that no valid values can be obtained. |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
Create a data table
POST / HTTP/1.1
Host: bi.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateDataTable
<Common request parameters>
{
"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"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| AuthFailure | CAM signature/authentication error. |
| FailedOperation | Operation failed. |
| InternalError | Internal error. |
| InternalError.Internal | Internal error. |
| InvalidParameter | Parameter error. |
| InvalidParameterValue | Parameter value error. |
| MissingParameter | Parameters are missing. |
| MissingParameter.MissingParam | The required parameter is missing. |
| OperationDenied | Operation denied. |
| RequestLimitExceeded | Too many and frequent requests. |
| UnauthorizedOperation | Unauthorized operation. |
| UnauthorizedOperation.Authorize | Permission error. |
| UnauthorizedOperation.UserNotExist | The user does not exist. |
| UnknownParameter | Unknown parameter error. |
| UnsupportedOperation | The operation is not supported. |
| UnsupportedOperation.BIError | Default business exception. |
Apakah halaman ini membantu?
Anda juga dapat Menghubungi Penjualan atau Mengirimkan Tiket untuk meminta bantuan.
masukan