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

功能介绍

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

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。

URI

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

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目ID。获取方法请参考获取项目ID。
instance_id	是	String	实例ID，开通的交换数据平台实例ID。获取方法请参考获取实例ID。
connector_id	是	String	连接器ID，指定交换数据平台下连接器的ID。获取方法请参考获取连接器ID。

表2 Query参数
参数	是否必选	参数类型	描述
offer_name	否	String	offer名称。
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
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	Object	返回数据。
total	Long	总数。
error_code	String	错误码。
error_msg	String	错误描述。

状态码： 500

表7 响应Body参数
参数	参数类型	描述
data	Object	返回数据。
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

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
}