产品概述
产品优势
产品功能
应用场景
Domain name for API request: bi.intl.tencentcloudapi.com.
This API is used to create a data source.
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: CreateDatasource. |
| Version | Yes | String | Common Params. The value used for this API: 2022-01-05. |
| Region | No | String | Common Params. This parameter is not required. |
| DbHost | Yes | String | HOST |
| DbPort | Yes | Integer | Port. |
| ServiceType | Yes | String | The backend provides dictionaries: domain type. 1. Tencent Cloud, 2. local. |
| DbType | Yes | String | Drive. Value range:. MYSQL: MYSQL database. PRESTO: presto database. POSTGRE: PostgreSQL database. DLC: dlc database. MSSQL: microsoft SQL Server database. |
| Charset | Yes | String | Database encoding. |
| DbUser | Yes | String | Username. |
| DbPwd | Yes | String | Password. |
| DbName | Yes | String | Database name. |
| SourceName | Yes | String | Database alias. |
| ProjectId | Yes | Integer | Project ID. |
| Catalog | No | String | Catalog value. |
| DataOrigin | No | String | Third-party data source identifier. |
| DataOriginProjectId | No | String | Third-party project ID. |
| DataOriginDatasourceId | No | String | Third-party data source ID. |
| ExtraParam | No | String | Extension parameter. |
| UniqVpcId | No | String | Unified identifier of the Tencent Cloud VPC. |
| Vip | No | String | VPC IP address. |
| Vport | No | String | VPC port. |
| VpcId | No | String | Tencent Cloud VPC identifier. |
| OperationAuthLimit.N | No | Array of String | Operation permission limitation. |
| UseVPC | No | Boolean | Enables VPC. |
| RegionId | No | String | Region. |
| Schema | No | String | Database schema. |
| DbVersion | No | String | Database version. |
| 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 | Data source ID. 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 | 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. |
This example shows you how to create a data source.
POST / HTTP/1.1
Host: bi.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateDatasource
<Common request parameters>
{
"DbHost": "DbHost",
"DbPort": 1982493789748932,
"ServiceType": "ServiceType",
"DbType": "DbType",
"Charset": "Charset",
"DbUser": "DbUser",
"DbPwd": "DbPwd",
"DbName": "DbName",
"SourceName": "SourceName",
"ProjectId": 1982493789748932,
"Catalog": "Catalog",
"DataOrigin": "DataOrigin",
"DataOriginProjectId": "DataOriginProjectId",
"DataOriginDatasourceId": "DataOriginDatasourceId",
"ExtraParam": "ExtraParam",
"UniqVpcId": "UniqVpcId",
"Vip": "Vip",
"Vport": "Vport",
"VpcId": "VpcId",
"OperationAuthLimit": [
"OperationAuthLimit"
],
"UseVPC": false,
"RegionId": "RegionId"
}
{
"Response": {
"Msg": "Internal server error",
"RequestId": "xxx-xx-x",
"Extra": "",
"Data": null,
"ErrorInfo": {
"ErrorTip": "Internal server error",
"ErrorMessage": "Internal server error",
"ErrorLevel": "ERROR"
}
}
}
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. |
| LimitExceeded | The quota limit is exceeded. |
| 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. |
| UnknownParameter | Unknown parameter error. |
| UnsupportedOperation | The operation is not supported. |
| UnsupportedOperation.BIError | Default business exception. |
文档反馈