搜索offer列表(不限连接器)
功能介绍
搜索offer列表(不限连接器)。
URI
GET /v1/{project_id}/eds/instances/{instance_id}/connectors/{connector_id}/broker/offers
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID。 获取方法请参考获取项目ID。 |
instance_id |
是 |
String |
实例ID,开通的交换数据平台实例ID。 获取方法请参考获取实例ID。 |
connector_id |
是 |
String |
连接器ID,指定交换数据平台下连接器的ID。 获取方法请参考获取连接器ID。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
key_words |
否 |
String |
搜索的关键字,如果是多个关键字,通过空格分开,默认为全量搜索。 |
ownered_company_name |
否 |
String |
限定租户名,即限定企业。 |
ownered_connector_name |
否 |
String |
限定连接器名。 |
offset |
否 |
Integer |
偏移量,表示从此偏移量开始查询,offset大于等于0。
|
limit |
否 |
Integer |
每页显示条目数量,最大数量200,超过200后只返回200(防止单页返回过大)。
|
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。通过调用IAM服务“获取用户Token”接口获取(响应消息头中X-Subject-Token的值)。 最小长度:1 最大长度:100000 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
data |
Array of OfferSummary objects |
返回数据。 |
total |
Long |
总数。 |
error_code |
String |
错误码。 |
error_msg |
String |
错误描述。 |
参数 |
参数类型 |
描述 |
---|---|---|
offer_id |
String |
Offer ID。 |
offer_name |
String |
Offer名称。 |
offer_type |
Integer |
Offer公开范围:公开-1、受控-2。 |
need_approval |
Boolean |
是否需要审批。 注:开启【需要审批】后,下载合约资源的加工产物时需要审批。 |
can_terminate |
Boolean |
是否允许提供方删除数据。 |
ownered_company_name |
String |
Offer所属的企业,即所属租户名。 |
ownered_company_id |
String |
Offer所属的企业ID,即所属租户ID。 |
ownered_connector_name |
String |
Offer所属的连接器,即所属连接器名。 |
ownered_connector_id |
String |
Offer所属的连接器ID,即所属连接器id。 |
offer_creator_name |
String |
Offer创建者名称。 |
offer_creator_id |
String |
Offer创建者ID。 |
offer_description |
String |
Offer描述。 |
subscription_type |
String |
订阅类型:
|
offer_followed_info |
OfferFollowed object |
Offer引用信息。 |
mask_sensitive |
Array of MaskSensitive objects |
结构化数据列脱敏信息。 |
use_control_policies_template |
Array of UseControlPoliciesInner objects |
合约使用控制策略列表。 |
参数 |
参数类型 |
描述 |
---|---|---|
offer_subscription |
Boolean |
Offer订阅状态。 |
offer_favorite |
Boolean |
Offer收藏状态。 |
offer_subscription_num |
Integer |
Offer订阅次数。 |
offer_favorite_num |
Integer |
Offer收藏次数。 |
offer_view_num |
Integer |
Offer查看次数。 |
参数 |
参数类型 |
描述 |
---|---|---|
attribute_code |
String |
属性code。 |
reserve_head_len |
Integer |
首端保留长度。 最大值:5000 |
reserve_tail_len |
Integer |
尾端保留长度。 最大值:5000 |
参数 |
参数类型 |
描述 |
---|---|---|
action |
String |
执行动作过滤:
枚举值:
|
when |
TimeInterval object |
限制使用时间。 |
how_many |
Integer |
限制使用次数。 参数校验规则:最小值1,最大值10000。 |
where |
Where object |
限制地点列表。 |
who |
Array of strings |
限制用户/团队列表。(目前不支持多个用户或者团队) |
user_type |
String |
限制用户类型。(团队订阅时who和user_type必填)
枚举值:
|
application |
Array of strings |
限制应用列表。 |
additional_attributes |
DatabaseAttributes object |
策略的扩展属性。 |
参数 |
参数类型 |
描述 |
---|---|---|
column_name |
String |
参数名称,需要与condition、value配合生效。 |
condition |
String |
参数条件,需要与column_name、value配合生效。 |
value |
String |
参数条件值,需要与column_name、condition配合生效。 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
data |
Object |
返回数据。 |
total |
Long |
总数。 |
error_code |
String |
错误码。 |
error_msg |
String |
错误描述。 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
data |
Object |
返回数据。 |
total |
Long |
总数。 |
error_code |
String |
错误码。 |
error_msg |
String |
错误描述。 |
请求示例
搜索offer列表(不限连接器)。
GET https://{endpoint}/v1/{project_id}/eds/instances/{instance_id}/connectors/{connector_id}/broker/offers?key_words=***&ownered_connector_name=连接器A&offset=0&limit=10
响应示例
状态码: 200
OK
- Offer列表
{ "data" : [ { "offer_id" : "29146bc7-c5ab-4369-8611-************", "offer_name" : "offer20231121AC-EXCEL", "offer_type" : 2, "need_approval" : null, "can_terminate" : null, "ownered_company_name" : null, "ownered_company_id" : null, "ownered_connector_name" : "连接器A", "ownered_connector_id" : "b40b0d94-3201-4687-93aa-************", "offer_creator_name" : null, "offer_creator_id" : null, "offer_description" : "", "offer_followed_info" : { "offer_subscription" : true, "offer_favorite" : true, "offer_subscription_num" : 2, "offer_favorite_num" : 0, "offer_view_num" : 1 }, "mask_sensitive" : null, "use_control_policies_template" : null } ] }
状态码
状态码 |
描述 |
---|---|
200 |
OK |
400 |
Bad Request |
500 |
Internal Server Error |
错误码
请参见错误码。