1. 接口描述
接口请求域名： wedata.tencentcloudapi.com 。
创建数据源
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：CreateDataSource。 |
| Version | 是 | String | 公共参数，本接口取值：2021-08-20。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| Name | 是 | String | 数据源名称，在相同SpaceName下，数据源名称不能为空 示例值：mysql_test |
| Category | 是 | String | 数据源类别：绑定引擎、绑定数据库 示例值：DB |
| Type | 是 | String | 数据源类型:枚举值 示例值：MYSQL |
| OwnerProjectId | 是 | String | 归属项目ID 示例值：10000434223 |
| OwnerProjectName | 是 | String | 归属项目Name 示例值：project_name |
| OwnerProjectIdent | 是 | String | 归属项目Name中文 示例值：xx项目 |
| BizParams | 否 | String | 业务侧数据源的配置信息扩展 示例值：{"key":"value"} |
| Params | 否 | String | 数据源的配置信息，以JSON KV存储，根据每个数据源类型不同，而KV存储信息不同 示例值：{"key":"value"} |
| Description | 否 | String | 数据源描述信息 示例值：desc |
| Display | 否 | String | 数据源展示名，为了可视化查看 示例值：test |
| DatabaseName | 否 | String | 若数据源列表为绑定数据库，则为db名称 示例值：default |
| Instance | 否 | String | 数据源引擎的实例ID，如CDB实例ID 示例值：cdb-3p3medhuc |
| Status | 否 | Integer | 数据源数据源的可见性，1为可见、0为不可见。默认为1 示例值：1 |
| ClusterId | 否 | String | 数据源所属的业务空间名称 示例值：test |
| Collect | 否 | String | 是否采集 示例值：true |
| COSBucket | 否 | String | cos桶信息 示例值：123 |
| COSRegion | 否 | String | cos region 示例值：app-guangzhou |
| ConnectResult | 否 | String | 连接测试结果 |
| DevelopmentParams | 否 | String | 开发环境数据源配置 示例值：{"key":"value"} |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Data | Integer | 主键ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 样例
输入示例
POST / HTTP/1.1
Host: wedata.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateDataSource
<公共请求参数>
{
"BizParams": "string",
"Category": "DB",
"DatabaseName": "db",
"Description": "string",
"Display": "saga",
"Name": "striaasdgng",
"Params": "string",
"ClusterId": "cdb-xxasfsdg6d",
"Status": 1,
"Type": "CLICKHOUSE",
"Collect": "1",
"OwnerProjectId": "100265651",
"OwnerProjectName": "pprasf",
"OwnerProjectIdent": "striasdgang",
"COSBucket": "string",
"COSRegion": "string"
}输出示例
{
"Response": {
"RequestId": "123",
"Data": "1"
}
}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: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |