文档首页> 交换数据空间 EDS> API参考> API> offer管理> 查询指定offer详情
更新时间：2024-04-29 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询指定offer详情

功能介绍

查询指定offer详情。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

instance_id

是

String

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

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

connector_id

是

String

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

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

offer_id

是

String

Offer ID。

参数校验规则：最小长度1，最大长度50，匹配字母数字和符号-。

project_id

是

String

项目ID。

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

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

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

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

data

OfferDetail object

返回数据。

total

Long

总数。

error_code

String

错误码。

error_msg

String

错误描述。
表4 OfferDetail

参数

参数类型

描述

offer_id

String

Offer ID。

offer_name

String

offer名称。

offer_status

String

offer状态：

  • APPROVING： 审批中
  • APPROVE_REJECTED：审批拒绝
  • ON_BOARDING：上架中
  • ON_BOARD：已上架
  • ON_BOARD_FAILED：上架失败
  • OFF_BOARDING：下架中
  • OFF_BOARD：已下架
  • OFF_BOARD_FAILED：下架失败

枚举值：

  • APPROVING
  • APPROVE_REJECTED
  • ON_BOARDING
  • ON_BOARD
  • ON_BOARD_FAILED
  • OFF_BOARDING
  • OFF_BOARD
  • OFF_BOARD_FAILED

offer_resources

Array of OfferResource objects

offer关联的资源信息。

数组长度：0 - 9999

need_approval

Boolean

是否需要审批。

注：开启【需要审批】后，下载合约资源的加工产物时需要审批。

can_terminate

Boolean

是否允许提供方删除数据。

use_control_policies_template

Array of UseControlPoliciesInner objects

合约使用控制策略列表。

mask_sensitive

Array of MaskSensitive objects

结构化数据列脱敏信息。
表5 OfferResource

参数

参数类型

描述

resource_id

String

资源ID。

resource_title

String

资源名称。

resource_type

String

资源的文件类型。

resource_category

String

资源分类：

  • DATASET： 数据集
  • FILE：文件

枚举值：

  • DATASETS
  • FILE
表6 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
表7 MaskSensitive

参数

参数类型

描述

attribute_code

String

属性code。

reserve_head_len

Integer

首端保留长度。

reserve_tail_len

Integer

尾端保留长度。
表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}/offers/fbf85846-3782-46dc-affb-************

响应示例

状态码： 200

OK

  • Offer详情。
    {
  "data" : {
    "offer_id" : "fbf85846-3782-46dc-affb-************",
    "offer_name" : "offer-mysql-20231129AA",
    "offer_status" : "ON_BOARD",
    "offer_resources" : [ {
      "resource_id" : "25546208-0854-49a0-9023-************",
      "resource_title" : "mysqlteset20231120184721",
      "resource_type" : null,
      "resource_category" : null
    } ],
    "need_approval" : false,
    "can_terminate" : true,
    "use_control_policies_template" : [ {
      "action" : "VIEW",
      "when" : {
        "start_time" : "2023-11-29T10:19:03Z",
        "end_time" : "2023-12-29T10:19:03Z"
      },
      "how_many" : null,
      "where" : [ ],
      "who" : [ ],
      "user_type": null,
      "application" : [ "22aac118-d58e-4324-9d41-************" ],
      "additional_attributes" : {
        "column" : "id,animal_name,category",
        "rows": null
      }
    }, {
      "action" : "DOWNLOAD",
      "when" : {
        "start_time" : "2023-11-29T10:19:03Z",
        "end_time" : "2023-12-29T10:19:03Z"
      },
      "how_many" : null,
      "where" : [ ],
      "who" : [ ],
      "user_type": null,
      "application" : [ "dae4237f-9880-4fb9-a618-************" ],
      "additional_attributes" : {
        "column" : "id,animal_name,category",
        "rows": null
      }
    } ],
    "mask_sensitive" : [ {
      "attribute_code" : "animal_name",
      "reserve_head_len" : 1,
      "reserve_tail_len" : 1
    } ]
  },
  "total" : 0,
  "error_code" : null,
  "error_msg" : null
}

状态码

状态码

描述

200

OK

400

Bad Request

500

Internal Server Error

错误码

请参见错误码。

父主题： offer管理
分享：

    相关文档

    相关产品