数据开发治理平台 WeData 更新数据源

1. 接口描述

接口请求域名： wedata.tencentcloudapi.com 。

该接口用于更新数据源

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

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：UpdateDataSource。
Version	是	String	公共参数，本接口取值：2025-08-06。
Region	是	String	公共参数，详见产品支持的地域列表。
Id	是	Integer	数据源id 示例值：62266
ProjectId	是	String	项目id 示例值：146094787944777296
ProdConProperties	否	String	数据源的配置信息，以JSON KV存储，根据每个数据源类型不同，而KV存储信息不同 > deployType: CONNSTR_PUBLICDB(公网实例) CONNSTR_CVMDB(自建实例) INSTANCE(云实例) <br/>mysql: 自建实例<br/>{<br/> "deployType": "CONNSTR_CVMDB",<br/> "url": "jdbc:mysql://1.1.1.1:1111/database",<br/> "username": "root",<br/> "password": "root",<br/> "region": "ap-shanghai",<br/> "vpcId": "vpc-kprq42yo",<br/> "type": "MYSQL"<br/>}<br/>mysql: 云实例<br/>{<br/> "instanceid": "cdb-12uxdo5e",<br/> "db": "db",<br/> "region": "ap-shanghai",<br/> "username": "msyql",<br/> "password": "mysql",<br/> "deployType": "INSTANCE",<br/> "type": "TENCENT_MYSQL"<br/>}<br/>sql_server: <br/>{<br/> "deployType": "CONNSTR_PUBLICDB",<br/> "url": "jdbc:sqlserver://1.1.1.1:223;DatabaseName=database",<br/> "username": "user_1",<br/> "password": "pass_2",<br/> "type": "SQLSERVER"<br/>}<br/>redis:<br/> redisType:<br/> -NO_ACCOUT(免账号)<br/> -SELF_ACCOUNT(自定义账号)<br/>{<br/> "deployType": "CONNSTR_PUBLICDB",<br/> "username":""<br/> "password": "pass",<br/> "ip": "1.1.1.1",<br/> "port": "6379",<br/> "redisType": "NO_ACCOUT",<br/> "type": "REDIS"<br/>}<br/>oracle: <br/>{<br/> "deployType": "CONNSTR_CVMDB",<br/> "url": "jdbc:oracle:thin:@1.1.1.1:1521:prod",<br/> "username": "oracle",<br/> "password": "pass",<br/> "region": "ap-shanghai",<br/> "vpcId": "vpc-kprq42yo",<br/> "type": "ORACLE"<br/>}<br/>mongodb:<br/> advanceParams(自定义参数，会拼接至url后)<br/>{<br/> "advanceParams": [<br/> {<br/> "key": "authSource",<br/> "value": "auth"<br/> }<br/> ],<br/> "db": "admin",<br/> "deployType": "CONNSTR_PUBLICDB",<br/> "username": "user",<br/> "password": "pass",<br/> "type": "MONGODB",<br/> "host": "1.1.1.1:9200"<br/>}<br/>postgresql:<br/>{<br/> "deployType": "CONNSTR_PUBLICDB",<br/> "url": "jdbc:postgresql://1.1.1.1:1921/database",<br/> "username": "user",<br/> "password": "pass",<br/> "type": "POSTGRE"<br/>}<br/>kafka:<br/> authType:<br/> - sasl<br/> - jaas<br/> - sasl_plaintext<br/> - sasl_ssl<br/> - GSSAPI<br/> ssl:<br/> -PLAIN<br/> -GSSAPI<br/>{<br/> "deployType": "CONNSTR_PUBLICDB",<br/> "host": "1.1.1.1:9092",<br/> "ssl": "GSSAPI",<br/> "authType": "sasl",<br/> "type": "KAFKA",<br/> "principal": "aaaa",<br/> "serviceName": "kafka"<br/>}<br/><br/>cos:<br/>{<br/> "region": "ap-shanghai",<br/> "deployType": "INSTANCE",<br/> "secretId": "aaaaa",<br/> "secretKey": "sssssss",<br/> "bucket": "aaa",<br/> "type": "COS"<br/>}<br/><br/> 示例值：{ "deployType": "CONNSTR_PUBLICDB", "url": "jdbc:mysql://1.1.1.1:1111/database", "username": "root", "password": "root" }
DevConProperties	否	String	若项目为标准模式，则此字段必填示例值：{ "deployType": "CONNSTR_PUBLICDB", "url": "jdbc:mysql://1.1.1.1:1111/database", "username": "root", "password": "root" }
ProdFileUpload	否	DataSourceFileUpload	生产环境数据源文件上传
DevFileUpload	否	DataSourceFileUpload	开发环境数据源文件上传
DisplayName	否	String	数据源展示名，为了可视化查看示例值：mysql_22_33
Description	否	String	数据源描述信息示例值：description

3. 输出参数

参数名称	类型	描述
Data	DataSourceStatus	操作是否成功
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 修改数据源

输入示例

POST / HTTP/1.1
Host: wedata.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpdateDataSource
<公共请求参数>

{
    "Id": 62266,
    "ProjectId": "1460947878944567296",
    "ProdConProperties": null,
    "DevConProperties": null,
    "ProdFileUpload": {
        "TrustStore": null,
        "KeyStore": null,
        "CoreSite": null,
        "HdfsSite": null,
        "HiveSite": null,
        "HBASESite": null,
        "KeyTab": null,
        "KRB5Conf": null,
        "PrivateKey": null,
        "PublicKey": null
    },
    "DevFileUpload": {
        "TrustStore": null,
        "KeyStore": null,
        "CoreSite": null,
        "HdfsSite": null,
        "HiveSite": null,
        "HBASESite": null,
        "KeyTab": null,
        "KRB5Conf": null,
        "PrivateKey": null,
        "PublicKey": null
    },
    "DisplayName": "mysql_22_33",
    "Description": null
}

输出示例

{
    "Response": {
        "Data": {
            "Status": true
        },
        "RequestId": "7468019d-ac08-43db-a4d4-9b04be755f78"
    }
}

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: 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. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
FailedOperation	操作失败。

更新数据源

本页目录：