文档首页/ 交换数据空间 EDS/ API参考/ API/ 合约管理/ 查询合约列表
更新时间：2024-11-06 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询合约列表

功能介绍

查询合约列表。

URI

GET /v1/{project_id}/eds/instances/{instance_id}/connectors/{connector_id}/contracts

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。

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

instance_id

是

String

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

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

connector_id

是

String

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

获取方法请参考获取连接器ID。
表2 Query参数

参数

是否必选

参数类型

描述

sub_flag

是

Integer

提供/收到的合约标志：

  • 0：我提供的合约

  • 1：我收到的合约

offset

否

Integer

偏移量，表示从此偏移量开始查询，offset大于等于0。

  • 最小值：0

  • 最大值：999999

  • 缺省值：0

最小值：0

最大值：999999

缺省值：0

limit

否

Integer

每页显示条目数量，最大数量999，超过999后只返回999（防止单页返回过大）。

  • 最小值：1

  • 最大值：999

  • 缺省值：10

最小值：1

最大值：999

缺省值：10

transactional_mode

是

String

交换模式：

  • PEER_TO_PEER： 点对点

  • SUBSCRIBE：订阅

枚举值：

  • PEER_TO_PEER

  • SUBSCRIBE

name

否

String

合约名称。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

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

x-eds-proxy-userid

否

String

如果X-Auth-Token是租户ID，那么x-eds-proxy-userid填写实际被代理的真实用户ID。

最小长度：0

最大长度：100000

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

data

Array of Contract objects

返回数据。

total

Long

总数。

error_code

String

错误码。

error_msg

String

错误描述。
表5 Contract

参数

参数类型

描述

contract_id

String

合约ID。

contract_name

String

合约名称。

contract_description

String

合约描述。

owner_connector_id

String

提供者连接器ID。

owner_connector_name

String

提供者连接器名称。

subscribe_connector_id

String

订阅连接器ID。

subscribe_connector_name

String

订阅连接器名称。

transactional_mode

String

交换模式：

  • PEER_TO_PEER： 点对点

  • SUBSCRIBE：订阅

枚举值：

  • PEER_TO_PEER

  • SUBSCRIBE

status

String

合约状态：

  • APPROVING： 审批中

  • RUNNING：数据传输中

  • SUCCESS：成功

  • FAILED：失败

  • CLOSED：到期关闭

  • TERMINATED：已终止

  • REJECTED：审批驳回

枚举值：

  • APPROVING

  • RUNNING

  • SUCCESS

  • FAILED

  • CLOSED

  • TERMINATED

  • REJECTED

create_time

String

创建时间。

状态码： 400

表6 响应Body参数

参数

参数类型

描述

data

Object

返回数据。

total

Long

总数。

error_code

String

错误码。

error_msg

String

错误描述。

状态码： 500

表7 响应Body参数

参数

参数类型

描述

data

Object

返回数据。

total

Long

总数。

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

查询合约列表。

GET https://{endpoint}/v1/{project_id}/eds/instances/{instance_id}/connectors/{connector_id}/contracts?offset=0&limit=10&transactional_mode=SUBSCRIBE&sub_flag=0

响应示例

状态码： 200

OK

  • 合约列表。

    {
  "data" : [ {
    "contract_id" : "AGRTconnector-****94b22a8544ab486c8f45************",
    "contract_name" : "测试合约1",
    "contract_description" : "测试合约",
    "owner_connector_id" : "b40b0d94-3201-4687-93aa-************",
    "owner_connector_name" : "连接器A",
    "subscribe_connector_id" : "c1bf9bd7-52fc-435b-ae55-************",
    "subscribe_connector_name" : "连接器B",
    "transactional_mode" : "SUBSCRIBE",
    "status" : "SUCCESS",
    "create_time" : "2023-10-12T18:11:07Z"
  }, {
    "contract_id" : "AGRTconnector-****e1c57b62b46b411380a0************",
    "contract_name" : "测试合约2",
    "contract_description" : "测试合约",
    "owner_connector_id" : "b40b0d94-3201-4687-93aa-************",
    "owner_connector_name" : "连接器A",
    "subscribe_connector_id" : "c1bf9bd7-52fc-435b-ae55-************",
    "subscribe_connector_name" : "连接器B",
    "transactional_mode" : "SUBSCRIBE",
    "status" : "SUCCESS",
    "create_time" : "2023-10-12T16:20:20Z"
  } ],
  "total" : 2,
  "error_code" : null,
  "error_msg" : null
}

状态码

状态码

描述

200

OK

400

Bad Request

500

Internal Server Error

错误码

请参见错误码。

父主题： 合约管理

相关文档