更新时间:2024-12-10 GMT+08:00

更新数据连接

功能介绍

更新数据连接

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

PUT /v2/{project_id}/data-connectors/{connector_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目编号。获取方法,请参见获取项目ID

约束限制:

不涉及

取值范围:

只能由英文字母和数字组成,且长度为[1-64]个字符。

默认取值:

不涉及

connector_id

String

参数解释:

数据连接ID。

约束限制:

不涉及

取值范围:

只能由英文字母、数字以及“_”和“-”组成,且长度为[0-64]个字符。

默认取值:

不涉及

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

data_connector

DataConnector object

参数解释:

数据连接,请参见表3

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表3 DataConnector

参数

是否必选

参数类型

描述

connector_name

String

参数解释:

数据连接名称。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

source_type

String

参数解释:

数据连接类型。

约束限制:

不涉及

取值范围:

  • RDS_POSTGRES:RDS服务PostgreSQL数据库
  • RDS_MYSQL:RDS服务MySQL数据库
  • gaussdb-mysql:云数据库GaussDB(for MySQL)

默认取值:

不涉及

source_info

String

参数解释:

数据源信息,为json格式。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

result

String

参数解释:

更新映射请求操作结果。

约束限制:

不涉及

取值范围:

  • succeeded:操作成功
  • failed:操作失败

默认取值:

不涉及

请求示例

/v2/274ee662a7e24cc99bfc858c4558dbf6/data-connector/7d169c6c-ab50-4a56-a5d2-240ca20aabda

{
  "data_connector" : {
    "connector_name" : "mrs-mysql-connector",
    "source_type" : "RDS_MYSQL",
    "source_info" : "{\"db_name\":\"default\",\"user_name\":\"mrs\",\"password\":\"*****\",\"rds_instance_id\":\"3aa55f1cb4c3491686936130f21e9f16in01\"}"
  }
}

响应示例

状态码:200

数据连接更新成功

{
  "result" : "succeed"
}

状态码

状态码请参见状态码

错误码

请参见错误码