1. 接口描述
接口请求域名: bi.tencentcloudapi.com 。
更新数据源
默认接口请求频率限制:100次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:ModifyDatasource。 |
Version | 是 | String | 公共参数,本接口取值:2022-01-05。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
DbHost | 是 | String | HOST 示例值:1 |
DbPort | 是 | Integer | 端口 示例值:1 |
ServiceType | 是 | String | 后端提供字典:域类型,1、腾讯云,2、本地 示例值:1 |
DbType | 是 | String | 驱动 示例值:1 |
Charset | 是 | String | 数据库编码 示例值:1 |
DbUser | 是 | String | 用户名 示例值:1 |
DbPwd | 是 | String | 密码 示例值:1 |
DbName | 是 | String | 数据库名称 示例值:1 |
SourceName | 是 | String | 数据库别名 示例值:1 |
Id | 是 | Integer | 数据源id 示例值:1 |
ProjectId | 是 | Integer | 项目ID 示例值:1 |
Catalog | 否 | String | catalog值 示例值:presto catalog |
DataOrigin | 否 | String | 第三方数据源标识 示例值:ssa |
DataOriginProjectId | 否 | String | 第三方项目id 示例值:1021 |
DataOriginDatasourceId | 否 | String | 第三方数据源id 示例值:2129 |
ExtraParam | 否 | String | 扩展参数 示例值:{"xx":"wq"} |
UniqVpcId | 否 | String | 腾讯云私有网络统一标识 示例值:1 |
Vip | 否 | String | 私有网络ip 示例值:1 |
Vport | 否 | String | 私有网络端口 示例值:920 |
VpcId | 否 | String | 腾讯云私有网络标识 示例值:1 |
UseVPC | 否 | Boolean | 开启vpc 示例值:true |
RegionId | 否 | String | 地域 示例值:gz |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
ErrorInfo | ErrorInfo | 自定义错误信息对象 注意:此字段可能返回 null,表示取不到有效值。 |
Data | String | 无 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
Extra | String | 额外信息 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
Msg | String | 提示 注意:此字段可能返回 null,表示取不到有效值。 示例值:成功 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 更新数据源
输入示例
POST / HTTP/1.1
Host: bi.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyDatasource
<公共请求参数>
{
"DbHost": "0.0.0.0",
"DbPort": "3307",
"ServiceType": "{\"Type\":\"Own\"}",
"DbType": "MONGODB",
"DataOrigin": "",
"Charset": "utf8",
"Catalog": "",
"DbUser": "username",
"DbName": "name",
"DbPwd": "password",
"SourceName": "测试vpc",
"VpcId": "vpcid",
"UniqVpcId": "vpc-",
"Vip": "",
"Vport": "",
"ExtraParam": "",
"DataOriginProjectId": "",
"DataOriginDatasourceId": "",
"UseVPC": true,
"RegionId": "gz",
"ProjectId": 517,
"Id": 134
}
输出示例
{
"Response": {
"Msg": "服务器内部错误",
"RequestId": "xxx-xx-x",
"Extra": "",
"Data": null,
"ErrorInfo": {
"ErrorTip": "服务器内部错误",
"ErrorMessage": "服务器内部错误",
"ErrorLevel": "ERROR"
}
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
AuthFailure | CAM签名/鉴权错误。 |
FailedOperation | 操作失败。 |
InternalError | 内部错误。 |
InternalError.Internal | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |
LimitExceeded | 超过配额限制。 |
MissingParameter | 缺少参数错误。 |
MissingParameter.MissingParam | 必填参数缺失。 |
OperationDenied | 操作被拒绝。 |
RequestLimitExceeded | 请求的次数超过了频率限制。 |
UnauthorizedOperation | 未授权操作。 |
UnauthorizedOperation.Authorize | 权限错误。 |
UnknownParameter | 未知参数错误。 |
UnsupportedOperation | 操作不支持。 |
UnsupportedOperation.BIError | 默认业务异常。 |