根据数据源ID,修改指定的数据源。
接口说明
需要购买 DataWorks 基础版及以上版本才能使用。
需要在 DataWorks 项目空间中具有如下至少一种角色:
租户所有者、租户管理员、空间管理员、项目所有者、运维
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
dataworks:UpdateDataSource |
get |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| Id |
integer |
是 |
数据源 ID,数据源的唯一标识符。 |
16033 |
| ProjectId |
integer |
是 |
DataWorks 项目空间 ID。 |
5678 |
| ConnectionPropertiesMode |
string |
否 |
数据源添加的类别,不同 type 下会有不同的子类型,对应有不同的参数约束,场景举例:
|
UrlMode |
| Description |
string |
否 |
数据源描述信息,长度不超过 3000 个字符。 |
test |
| ConnectionProperties |
string |
是 |
数据源具体连接配置信息,包括连接地址、访问身份、环境信息等。数据源环境 EnvType 信息是此对象的成员属性,包括
不同类型的数据源在不同的配置模式(ConnectionPropertiesMode)下具有不同的属性信息规范,请参考数据源连接信息 ConnectionProperties |
{ "envType": "Prod", "regionId": "cn-beijing", "instanceId": "hgprecn-cn-x0r3oun4k001", "database": "testdb", "securityProtocol": "authTypeNone", "authType": "Executor", "authIdentity": "1107550004253538" } |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
返回结果。 |
||
| RequestId |
string |
请求 ID。用于定位日志,排查问题。 |
102E8E24-0387-531D-8A75-1C0AE7DD03E5 |
| Success |
boolean |
数据源是否修改成功:
|
true |
示例
正常返回示例
JSON格式
{
"RequestId": "102E8E24-0387-531D-8A75-1C0AE7DD03E5",
"Success": true
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。