更新连接器连接 - UpdateConnectorDatalink
功能介绍
更新连接器连接
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。
URI
PUT /v1/{project_id}/workspaces/{workspace_id}/soc/connectors/{connector_id}/datalinks/{datalink_id}
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID,用于明确项目归属,配置后可通过该ID查询项目下连接器,可以通过调用API获取,也可以从控制台获取。获取项目ID 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| workspace_id | 是 | String | 参数解释: 工作空间id。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| connector_id | 是 | String | 参数解释: 连接器的唯一标识id 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| datalink_id | 是 | String | 参数解释: 连接器连接的唯一标识id 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Language | 是 | String | 参数解释: 语言,参考值:zh-cn、en-us 约束限制: 不涉及 取值范围: zh-cn:中文环境 en-us:英文环境 默认取值: 不涉及 |
| X-Auth-Token | 是 | String | 参数解释: 用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。获取用户Token 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| Content-Type | 是 | String | 参数解释: 内容类型 - application/json;charset=UTF-8 普通API请求的类型 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| name | 否 | String | 参数解释: 连接器连接名称 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| src_asset_id | 否 | String | 参数解释: 源端凭据ID 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| dst_asset_id | 否 | String | 参数解释: 目的端凭据ID 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| src_dataset_desc | 否 | String | 参数解释: 源端数据集描述 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| dst_dataset_desc | 否 | String | 参数解释: 目的端数据集描述 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| extend_params | 否 | String | 参数解释: 运行时参数(JSON格式) 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| src_scope | 否 | String | 参数解释: 源端范围 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| dst_scope | 否 | String | 参数解释: 目的端范围 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| code | String | 参数解释: 请求响应码 取值范围: 不涉及 |
| message | String | 参数解释: 请求描述 取值范围: 不涉及 |
| data | DataLink object | 参数解释: 连接器连接 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 参数解释: 连接器连接唯一标识 取值范围: 不涉及 |
| connector_id | String | 参数解释: 连接器ID 取值范围: 不涉及 |
| name | String | 参数解释: 连接器连接名称 取值范围: 不涉及 |
| zh_name | String | 参数解释: 连接器连接中文名称 取值范围: 不涉及 |
| en_name | String | 参数解释: 连接器连接英文名称 取值范围: 不涉及 |
| src_asset_id | String | 参数解释: 源端凭据ID 取值范围: 不涉及 |
| src_scope | String | 参数解释: 源端范围 取值范围: 不涉及 |
| dst_asset_id | String | 参数解释: 目的端凭据ID 取值范围: 不涉及 |
| dst_scope | String | 参数解释: 目的端范围 取值范围: 不涉及 |
| src_dataset_id | String | 参数解释: 源端数据集ID 取值范围: 不涉及 |
| dst_dataset_id | String | 参数解释: 目的端数据集ID 取值范围: 不涉及 |
| src_dataset_desc | String | 参数解释: 源端描述 取值范围: 不涉及 |
| zh_src_dataset_desc | String | 参数解释: 源端描述(中文) 取值范围: 不涉及 |
| en_src_dataset_desc | String | 参数解释: 源端描述(英文) 取值范围: 不涉及 |
| dst_dataset_desc | String | 参数解释: 目的端描述 取值范围: 不涉及 |
| zh_dst_dataset_desc | String | 参数解释: 目的端描述(中文) 取值范围: 不涉及 |
| en_dst_dataset_desc | String | 参数解释: 目的端描述(英文) 取值范围: 不涉及 |
| extend_params | String | 参数解释: 运行时参数(JSON格式) 取值范围: 不涉及 |
| run_status | String | 参数解释: 运行状态 取值范围: |
| create_time | String | 参数解释: 创建时间,格式ISO8601:YYYY-MM-DDTHH:mm:ss.ms+timezone。时区信息为事件发生时区,无法解析时区的时间,默认时区填东八区 取值范围: 不涉及 |
| update_time | String | 参数解释: 更新时间,格式ISO8601:YYYY-MM-DDTHH:mm:ss.ms+timezone。时区信息为事件发生时区,无法解析时区的时间,默认时区填东八区 取值范围: 不涉及 |
| creator_id | String | 参数解释: 创建者ID 取值范围: 不涉及 |
| creator_name | String | 参数解释: 创建者名称 取值范围: 不涉及 |
| modifier_id | String | 参数解释: 修改者ID 取值范围: 不涉及 |
| modifier_name | String | 参数解释: 修改者名称 取值范围: 不涉及 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| X-request-id | String | 参数解释: 请求ID 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| code | String | 参数解释: 请求响应码 取值范围: 不涉及 |
| message | String | 参数解释: 请求描述 取值范围: 不涉及 |
请求示例
更新连接器连接的请求样例
https://{endpoint}/v1/{project_id}/workspaces/{workspace_id}/soc/connectors/{connector_id}/datalinks/{datalink_id}
{
"name" : "连接器连接1-更新",
"src_asset_id" : "909494e3-558e-46b6-a9eb-07a8e18ca621",
"dst_asset_id" : "909494e3-558e-46b6-a9eb-07a8e18ca622",
"src_dataset_desc" : "源端连接器连接描述-更新",
"dst_dataset_desc" : "目的端连接器连接描述-更新",
"extend_params" : "{\"param1\": \"value1\", \"param2\": \"value2\"}"
} 响应示例
状态码:200
{
"code" : "SecMaster.00000000",
"message" : "Parameter error.",
"data" : {
"id" : "909494e3-558e-46b6-a9eb-07a8e18ca621",
"connector_id" : "909494e3-558e-46b6-a9eb-07a8e18ca621",
"src_dataset_id" : "909494e3-558e-46b6-a9eb-07a8e18ca621",
"src_dataset_desc" : "链接",
"src_asset_id" : "909494e3558e46b6-a9eb07a8e18ca621",
"dst_asset_id" : "909494e3558e46b6-a9eb07a8e18ca621",
"dst_dataset_id" : "909494e3-558e-46b6-a9eb-07a8e18ca621",
"dst_dataset_desc" : "909494e3-558e-46b6-a9eb-07a8e18ca621",
"update_time" : "2023-02-27 20:28:53.001000+08:00",
"modifier_id" : "909494e3-558e-46b6-a9eb-07a8e18ca621",
"modifier_name" : "用户1",
"run_status" : "NORMAL"
}
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 连接器实例更新返回对象 |
| 400 | 响应错误返回对象 |
错误码
请参见错误码。