启动/停止/重试连接器连接 - UpdateConnectorDatalinks
功能介绍
批量启动/停止/重试连接器连接
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。
URI
POST /v1/{project_id}/workspaces/{workspace_id}/soc/connectors/{connector_id}/datalinks/batch-update
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID,用于明确项目归属,配置后可通过该ID查询项目下连接器,可以通过调用API获取,也可以从控制台获取。获取项目ID 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| workspace_id | 是 | String | 参数解释: 工作空间id。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| connector_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请求的类型 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| datalink_ids | 是 | Array of strings | 参数解释: 连接器连接ID列表 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| action | 否 | String | 参数解释: 操作,ENABLE/DISABLE/RETRY/DELETE 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| code | String | 参数解释: 响应码 取值范围: 不涉及 |
| message | String | 参数解释: 请求描述 取值范围: 不涉及 |
| data | BatchResult object | 参数解释: 批量操作连接器返回对象 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_ids | Array of strings | 参数解释: 删除失败的连接器唯一标识列表 取值范围: 不涉及 |
| success_ids | Array of strings | 参数解释: 删除成功的连接器唯一标识列表 取值范围: 不涉及 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| X-request-id | String | 参数解释: 请求ID 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| code | String | 参数解释: 请求响应码 取值范围: 不涉及 |
| message | String | 参数解释: 请求描述 取值范围: 不涉及 |
请求示例
批量更新连接器连接的请求样例
https://{endpoint}/v1/{project_id}/workspaces/{workspace_id}/soc/connectors/{connector_id}/datalinks/batch-update
{
"datalink_ids" : [ "909494e3-558e-46b6-a9eb-07a8e18ca622" ],
"action" : "ENABLE"
} 响应示例
状态码:200
{
"code" : "SecMaster.20040001",
"message" : "Parameter error.",
"data" : {
"error_ids" : [ "909494e3-558e-46b6-a9eb-07a8e18ca621" ],
"success_ids" : [ "909494e3-558e-46b6-a9eb-07a8e18ca622" ]
}
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 连接器连接批量更新返回对象 |
| 400 | 响应错误返回对象 |
错误码
请参见错误码。