文档首页> 交换数据空间 EDS> API参考> API> 合约管理> 终止合约
更新时间：2024-03-15 GMT+08:00
在线调试
CLI示例
查看PDF
分享

终止合约

功能介绍

终止合约。

URI

PUT /v1/{project_id}/eds/instances/{instance_id}/connectors/{connector_id}/contracts/{contract_id}

表1 路径参数

参数

是否必选

参数类型

描述

instance_id

是

String

实例ID，开通的数据交换平台实例ID。

获取方法请参考获取实例ID。

connector_id

是

String

连接器ID，指定数据交换平台下连接器的ID。

获取方法请参考获取连接器ID。

contract_id

是

String

合约ID。

参数校验规则：最小长度1，最大长度50，匹配字母数字和符号-。

project_id

是

String

项目ID。

获取方法请参考获取项目ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token，通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

data

ContractResult object

返回数据。

total

Long

总数。

error_code

String

错误码。

error_msg

String

错误描述。
表4 ContractResult

参数

参数类型

描述

contract_id

String

合约ID。

contract_name

String

合约名称。

result_code

String

操作结果返回码：

  • SUCCESS：操作成功
  • FAILED：操作失败

枚举值：

  • SUCCESS
  • FAILED

result_description

String

操作结果描述。

状态码： 400

表5 响应Body参数

参数

参数类型

描述

data

-

返回null。

total

Long

总数。

error_code

String

错误码。

error_msg

String

错误描述。

状态码： 500

表6 响应Body参数

参数

参数类型

描述

data

-

返回null。

total

Long

总数。

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

终止合约。

PUT https://{endpoint}/v1/{project_id}/eds/instances/{instance_id}/connectors/{connector_id}/contracts/AGRTconnector-****3b53a05caccd4c53b509************

响应示例

状态码： 200

OK

  • 合约操作结果
    {
  "data" : {
    "contract_id" : "AGRTconnector-****3b53a05caccd4c53b509************",
    "contract_name" : "测试合约3",
    "result_code" : "SUCCESS",
    "result_description" : "Cancel contract success."
  },
  "total" : 0,
  "error_code" : null,
  "error_msg" : null
}

状态码

状态码

描述

200

OK

400

Bad Request

500

Internal Server Error

错误码

请参见错误码。

父主题： 合约管理
分享：

    相关文档

    相关产品