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

查询指定连接器下的offer列表

功能介绍

查询指定连接器下的offer列表。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

instance_id

是

String

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

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

connector_id

是

String

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

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

project_id

是

String

项目ID。

获取方法请参考获取项目ID。
表2 Query参数

参数

是否必选

参数类型

描述

offer_name

否

String

offer名称。

参数校验规则：只能包含英文字母，数字，下划线，中文及-，并且只能以中文和英文开头，最小长度1，最大长度100。

offer_status

否

String

offer状态（默认返回已上架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

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

offset

否

Integer

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

  • 最小值：0
  • 最大值：999999
  • 缺省值：0

limit

否

Integer

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

  • 最小值：1
  • 最大值：999
  • 缺省值：10

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

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

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

data

Array of Offer objects

返回数据。

total

Long

总数。

error_code

String

错误码。

error_msg

String

错误描述。
表5 Offer

参数

参数类型

描述

offer_id

String

Offer ID。

offer_code

String

offer编码。

offer_name

String

offer名称。

offer_description

String

offer描述。

create_time

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

状态码： 400

表6 响应Body参数

参数

参数类型

描述

data

-

返回null。

total

Long

总数。

error_code

String

错误码。

error_msg

String

错误描述。

状态码： 500

表7 响应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?offset=0&limit=10

响应示例

状态码： 200

OK

  • Offer列表
    {
  "data" : [ {
    "offer_id" : "e49cc59d-48a7-46b2-bfea-************",
    "offer_code" : "Fconnector-****88ad1de6fc124c519e56************",
    "offer_name" : "offer1",
    "offer_description" : "",
    "create_time" : "2023-12-01T15:06:48Z",
    "offer_status" : "ON_BOARD"
  }, {
    "offer_id" : "fbf85846-3782-46dc-affb-************",
    "offer_code" : "Fconnector-****1fc857ef325a4a458042************",
    "offer_name" : "offer2",
    "offer_description" : "",
    "create_time" : "2023-11-29T10:19:53Z",
    "offer_status" : "ON_BOARD"
  } ],
  "total" : 2,
  "error_code" : null,
  "error_msg" : null
}

状态码

状态码

描述

200

OK

400

Bad Request

500

Internal Server Error

错误码

请参见错误码。

父主题： offer管理
分享：

    相关文档

    相关产品