终止合约 - CancelContract

功能介绍

终止合约。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。

URI

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

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目ID。获取方法请参考获取项目ID。
instance_id	是	String	实例ID，开通的交换数据平台实例ID。获取方法请参考获取实例ID。
connector_id	是	String	连接器ID，指定交换数据平台下连接器的ID。获取方法请参考获取连接器ID。
contract_id	是	String	合约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	Object	返回数据。
total	Long	总数。
error_code	String	错误码。
error_msg	String	错误描述。

状态码： 500

表6 响应Body参数
参数	参数类型	描述
data	Object	返回数据。
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

合约操作结果

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