帮你快速理解、总结文档立即下载

更新数据源

最近更新时间:2026-09-01 04:41:19
我的收藏

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(云实例)

mysql: 自建实例{    "deployType": "CONNSTR_CVMDB",    "url": "jdbc:mysql://<host>:<port>/<database>",    "username": "<username>",    "password": "<password>",    "region": "ap-shanghai",    "vpcId": "<vpcId>",    "type": "MYSQL"}mysql: 云实例{    "instanceid": "<instanceId>",    "db": "<database>",    "region": "ap-shanghai",    "username": "<username>",    "password": "<password>",    "deployType": "INSTANCE",    "type": "TENCENT_MYSQL"}sql_server:{    "deployType": "CONNSTR_PUBLICDB",    "url": "jdbc:sqlserver://<host>:<port>;DatabaseName=<database>",    "username": "<username>",    "password": "<password>",    "type": "SQLSERVER"}redis:    redisType:    -NO_ACCOUT(免账号)    -SELF_ACCOUNT(自定义账号){    "deployType": "CONNSTR_PUBLICDB",    "username": "<username>",    "password": "<password>",    "ip": "<host>",    "port": "<port>",    "redisType": "NO_ACCOUT",    "type": "REDIS"}oracle:{    "deployType": "CONNSTR_CVMDB",    "url": "jdbc:oracle:thin:@<host>:<port>:<sid>",    "username": "<username>",    "password": "<password>",    "region": "ap-shanghai",    "vpcId": "<vpcId>",    "type": "ORACLE"}mongodb:    advanceParams(自定义参数,会拼接至url后){    "advanceParams": [        {            "key": "authSource",            "value": "admin"        }    ],    "db": "<database>",    "deployType": "CONNSTR_PUBLICDB",    "username": "<username>",    "password": "<password>",    "type": "MONGODB",    "host": "<host>:<port>"}postgresql:{    "deployType": "CONNSTR_PUBLICDB",    "url": "jdbc:postgresql://<host>:<port>/<database>",    "username": "<username>",    "password": "<password>",    "type": "POSTGRE"}kafka:    authType:    - sasl    - jaas    - sasl_plaintext    - sasl_ssl    - GSSAPI    ssl:    -PLAIN    -GSSAPI{    "deployType": "CONNSTR_PUBLICDB",    "host": "<host>:<port>",    "ssl": "GSSAPI",    "authType": "sasl",    "type": "KAFKA",    "principal": "<principal>",    "serviceName": "kafka"}cos:{    "region": "ap-shanghai",    "deployType": "INSTANCE",    "secretId": "<secretId>",    "secretKey": "<secretKey>",    "bucket": "<bucket>",    "type": "COS"}


示例值:{"deployType":"CONNSTR_CVMDB","url":"jdbc:mysql://<host>:<port>/<database>","username":"<username>","password":"<password>","region":"ap-guangzhou","vpcId":"<vpcId>"}
DevConProperties String

若项目为标准模式,则此字段必填


示例值:{"deployType":"CONNSTR_CVMDB","url":"jdbc:mysql://<host>:<port>/<database>","username":"<username>","password":"<password>","region":"ap-guangzhou","vpcId":"<vpcId>"}
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。

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败。