腾讯云 BI 创建云数据源

接口请求域名: bi.tencentcloudapi.com 。推荐使用 API Explorer 点击调试 API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。可以查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

相关产品
腾讯云 BI 产品页,含版本规格、价格与购买入口。

一、1. 接口描述

创建云数据库

默认接口请求频率限制:20次/秒。

二、2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数,本接口取值:CreateDatasourceCloud。
Version 是 String 公共参数,本接口取值:2022-01-05。
Region 否 String 公共参数,此参数为可选参数。
ServiceType 是 String 后端提供字典:域类型,1、腾讯云,2、本地示例值:{"Type":"Own","IsDefault":true}
DbType 是 String 驱动枚举值:MYSQL: MySQL数据库PRESTO: PRESTO数据库POSTGRE: PostgreSQL数据库DLC: DLC数据库MSSQL: 微软SQL Server数据库示例值:MYSQL
Charset 是 String 数据库编码示例值:utf8
DbUser 是 String 用户名示例值:root
DbPwd 是 String 密码示例值:**
DbName 是 String 数据库名称示例值:bi_demo
SourceName 是 String 数据库别名示例值:腾讯云BI示例数据源
ProjectId 是 String 项目ID示例值:1180
Vip 否 String 公有云内网ip示例值:1
Vport 否 String 公有云内网端口示例值:1
VpcId 否 String vpc标识示例值:1
UniqVpcId 否 String 统一vpc标识示例值:1
RegionId 否 String 区域标识(gz,bj)示例值:33
ExtraParam 否 String 扩展参数示例值:1
InstanceId 否 String 实例Id示例值:112
ProdDbName 否 String 数据源产品名示例值:bi_demo
DataOrigin 否 String 第三方数据源标识示例值:1
DataOriginProjectId 否 String 第三方项目id示例值:112
DataOriginDatasourceId 否 String 第三方数据源id示例值:11011
ClusterId 否 String 集群id示例值:1
Schema 否 String 数据库schema示例值:DB2INST1
DbVersion 否 String 数据库版本示例值:11.5

三、3. 输出参数

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

四、示例1 创建云数据库示例

创建云数据库示例

五、输入示例

POST / HTTP/1.1
Host: bi.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateDatasourceCloud
<公共请求参数>
{ "ServiceType": "ServiceType", "DbType": "DbType", "Charset": "Charset", "DbUser": "DbUser", "DbPwd": "DbPwd", "DbName": "DbName", "SourceName": "SourceName", "ProjectId": "ProjectId", "Vip": "Vip", "Vport": "Vport", "VpcId": "VpcId", "UniqVpcId": "UniqVpcId", "RegionId": "RegionId", "ExtraParam": "ExtraParam", "InstanceId": "InstanceId", "ProdDbName": "ProdDbName", "DataOrigin": "DataOrigin", "DataOriginProjectId": "DataOriginProjectId", "DataOriginDatasourceId": "DataOriginDatasourceId", "ClusterId": "ClusterId"
}

六、输出示例

{ "Response": { "Data": { "Id": 0, "AccessKey": "AccessKey***AccessKey", "ProjectId": 1, "TranId": "jgvk213439", "TranStatus": 0 }, "Extra": "", "Msg": "成功", "RequestId": "RequestId-123" }
}

七、腾讯云 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 操作被拒绝。
UnauthorizedOperation 未授权操作。
UnauthorizedOperation.Authorize 权限错误。
UnknownParameter 未知参数错误。
UnsupportedOperation 操作不支持。
UnsupportedOperation.BIError 默认业务异常。
赞 (0)
上一篇 4天前
下一篇 4天前