Domain name for API request: bi.intl.tencentcloudapi.com.
API information for raw data table fields
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: DescribeSourceFieldList. |
| Version | Yes | String | Common Params. The value used for this API: 2022-01-05. |
| Region | No | String | Common Params. This parameter is not required. |
| DataSourceId | No | Integer | data source Id |
| TableName | No | String | Table name |
| Sql | No | String | sql content |
| ProjectId | No | Integer | Project ID. |
| AsyncRequest | No | Boolean | whether |
| TranId | No | String | async transaction id |
| ParamList.N | No | Array of ParamCreateDTO | 11 |
| DlcExtInfo | No | String | DLC extension parameter |
| QueryDbData | No | String | Query database required or not |
| TableId | No | String | Data table Id |
| TableType | No | 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. |
| Parameter Name | Type | Description |
|---|---|---|
| ErrorInfo | ErrorInfo | Custom error information object 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 | Information. Note: This field may return null, indicating that no valid values can be obtained. |
| Data | TableColumnListData | List of fields in the table |
| 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. |
raw data table field interface
POST / HTTP/1.1
Host: bi.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeSourceFieldList
<Common request parameters>
{
"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"
}
}
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 |
|---|---|
| InternalError.Internal | Internal error. |
| MissingParameter.MissingParam | The required parameter is missing. |
| UnauthorizedOperation.Authorize | Permission error. |
| UnsupportedOperation.BIError | Default business exception. |
피드백