文档首页> 交换数据空间 EDS> API参考> API> offer管理> 查询offer详情（不限连接器）
更新时间：2024-05-30 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询offer详情（不限连接器）

功能介绍

查询offer详情（不限连接器）。

URI

GET /v1/{project_id}/eds/instances/{instance_id}/connectors/{connector_id}/broker/offers/{offer_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。

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

instance_id

是

String

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

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

connector_id

是

String

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

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

offer_id

是

String

Offer ID。

参数校验规则：最小长度1，最大长度100。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

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

最小长度：1

最大长度：100000

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

data

OfferSummary object

返回数据。

total

Long

总数。

error_code

String

错误码。

error_msg

String

错误描述。
表4 OfferSummary

参数

参数类型

描述

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订阅的类型。

枚举值：

  • OPEN_DATA 公开
  • CONTROLLED_DATA 受控

offer_followed_info

OfferFollowed object

Offer引用信息。

mask_sensitive

Array of MaskSensitive objects

结构化数据列脱敏信息。

use_control_policies_template

Array of UseControlPoliciesInner objects

合约使用控制策略列表。
表5 OfferFollowed

参数

参数类型

描述

offer_subscription

Boolean

Offer订阅状态。

offer_favorite

Boolean

Offer收藏状态。

offer_subscription_num

Integer

Offer订阅次数。

offer_favorite_num

Integer

Offer收藏次数。

offer_view_num

Integer

Offer查看次数。
表6 MaskSensitive

参数

参数类型

描述

attribute_code

String

属性code。

reserve_head_len

Integer

首端保留长度。

reserve_tail_len

Integer

尾端保留长度。
表7 UseControlPoliciesInner

参数

参数类型

描述

action

String

执行动作过滤：

  • VIEW：查看
  • MODIFY：加工
  • DOWNLOAD：下载

枚举值：

  • VIEW
  • MODIFY
  • DOWNLOAD

when

TimeInterval object

限制使用时间。

how_many

Integer

限制使用次数。

where

Array of strings

限制地点列表。

who

Array of strings

限制用户列表。

application

Array of strings

限制应用模板id列表。

additional_attributes

DatabaseAttributes

object

策略的扩展属性。

user_type

String

限制用户类型。

  • USER ：指定用户
  • TEAM ：指定团队

枚举值：

  • USER
  • TEAM
表8 TimeInterval

参数

参数类型

描述

start_time

String

起始时间。

end_time

String

截止时间。
表9 DatabaseAttributes

参数

参数类型

描述

column

String

可见行。

rows

Arrays of RowDTO

可见列。
表10 RowDTO

参数

参数类型

描述

column_name

String

参数名称。

condition

String

参数条件。

value

String

参数条件值。

状态码： 400

表11 响应Body参数

参数

参数类型

描述

data

-

返回null。

total

Long

总数。

error_code

String

错误码。

error_msg

String

错误描述。

状态码： 500

表12 响应Body参数

参数

参数类型

描述

data

-

返回null。

total

Long

总数。

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

查询offer详情（不限连接器）。

GET https://{endpoint}/v1/{project_id}/eds/instances/{instance_id}/connectors/{connector_id}/broker/offers/321fd67b-ceba-4638-b54a-************

响应示例

状态码： 200

OK

  • offer详情
    {
  "data" : {
    "offer_id" : "321fd67b-ceba-4638-b54a-************",
    "offer_name" : "Offer20231121AD_EXCEL",
    "offer_type" : 2,
    "need_approval" : false,
    "can_terminate" : true,
    "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" : "a",
    "offer_followed_info" : {
      "offer_subscription" : true,
      "offer_favorite" : true,
      "offer_subscription_num" : 1,
      "offer_favorite_num" : 0,
      "offer_view_num" : 1
    },
    "mask_sensitive" : null,
    "use_control_policies_template" : [ {
      "action" : "VIEW",
      "when" : {
        "start_time" : "2023-11-21T16:25:27Z",
        "end_time" : "2023-12-21T16:25:27Z"
      },
      "how_many" : null,
      "where" : [ ],
      "who" : [ ],
      "user_type": null,
      "application" : [ "321ac118-758e-4324-9d41-************" ],
      "additional_attributes" : 
      {
       "column": null,
       "rows": null
       }
    }, {
      "action" : "DOWNLOAD",
      "when" : {
        "start_time" : "2023-11-21T16:25:27Z",
        "end_time" : "2023-12-21T16:25:27Z"
      },
      "how_many" : null,
      "where" : [ ],
      "who" : [ ],
      "user_type": null,
      "application" : [ "dae4237f-9880-4fb9-a618-************" ],
      "additional_attributes" : 
      {
       "column": null,
       "rows": null
       }
    } ]
  },
  "total" : 0,
  "error_code" : null,
  "error_msg" : null
}

状态码

状态码

描述

200

OK

400

Bad Request

500

Internal Server Error

错误码

请参见错误码。

父主题： offer管理
分享：

    相关文档

    相关产品