查询接收的合约数据
功能介绍
查询接收的合约数据。
URI
GET /v1/{project_id}/eds/instances/{instance_id}/connectors/{connector_id}/contracts/received-data-resources
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
project_id |
是 |
String |
项目ID。 获取方法请参考获取项目ID。 |
instance_id |
是 |
String |
实例ID，开通的数据交换平台实例ID。 获取方法请参考获取实例ID。 |
connector_id |
是 |
String |
连接器ID，指定数据交换平台下连接器的ID。 获取方法请参考获取连接器ID。 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
scope |
是 |
String |
查询范围：
枚举值：
|
offset |
否 |
Integer |
偏移量，表示从此偏移量开始查询，offset大于等于0。
|
limit |
否 |
Integer |
每页显示条目数量，最大数量999，超过999后只返回999（防止单页返回过大）。
|
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 最小长度：1 最大长度：100000 |
响应参数
状态码： 200
参数 |
参数类型 |
描述 |
|---|---|---|
data |
Array of DataPackageResource objects |
返回数据。 |
total |
Long |
总数。 |
error_code |
String |
错误码。 |
error_msg |
String |
错误描述。 |
参数 |
参数类型 |
描述 |
|---|---|---|
data_packet_name |
String |
数据包名称。 |
data_packet_id |
String |
数据包ID。 |
contract_id |
String |
合约ID。 |
creator |
String |
创建人。 |
create_time |
String |
创建时间。 |
updater |
String |
更新人。 |
update_time |
String |
更新时间。 |
shared_company_name |
String |
数据包提供方所属的企业，即所属租户名。 |
shared_company_id |
String |
数据包提供方所属的企业id，即所属租户id。 |
shared_connector_name |
String |
数据包提供方所属的连接器，即所属连接器名。 |
shared_connector_id |
String |
数据包提供方所属的连接器id，即所属连接器id。 |
状态码： 400
参数 |
参数类型 |
描述 |
|---|---|---|
data |
- |
返回null。 |
total |
Long |
总数。 |
error_code |
String |
错误码。 |
error_msg |
String |
错误描述。 |
状态码： 500
参数 |
参数类型 |
描述 |
|---|---|---|
data |
- |
返回null。 |
total |
Long |
总数。 |
error_code |
String |
错误码。 |
error_msg |
String |
错误描述。 |
请求示例
查询接收的合约数据。
GET https://{endpoint}/v1/{project_id}/eds/instances/{instance_id}/connectors/{connector_id}/contracts/received-data-resources?scope=UNREAD&offset=0&limit=10
响应示例
状态码： 200
OK
- 合约数据包列表。
{ "data" : [ { "data_packet_name" : "演示合约1", "data_packet_id" : "44d2f35e-0371-433f-b5b6-************", "contract_id" : "AGRTconnector-****3b53a05caccd4c53b509************", "creator" : "************", "create_time" : "2023-12-05T20:24:42Z", "updater" : "************", "update_time" : "2023-12-05T20:24:42Z", "shared_company_name" : null, "shared_company_id" : null, "shared_connector_name" : "连接器A", "shared_connector_id" : "b40b0d94-3201-4687-93aa-************" }, { "data_packet_name" : "演示合约2", "data_packet_id" : "448e88db-70c0-430b-a195-************", "contract_id" : "AGRTconnector-****b252e8d809754d6aaef7************", "creator" : "0574abfba400d2a91f5ec01111a89fcf", "create_time" : "2023-11-29T10:06:40Z", "updater" : "************", "update_time" : "2023-11-29T10:06:40Z", "shared_company_name" : null, "shared_company_id" : null, "shared_connector_name" : "连接器A", "shared_connector_id" : "b40b0d94-3201-4687-93aa-************" } ], "total" : 2, "error_code" : null, "error_msg" : null }
状态码
状态码 |
描述 |
|---|---|
200 |
OK |
400 |
Bad Request |
500 |
Internal Server Error |
错误码
请参见错误码。
