查询连接器列表 - ListConnectorsByInstanceManger

功能介绍

查询连接器列表。

授权信息

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

URI

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

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

表2 Query参数
参数	是否必选	参数类型	描述
type	是	String	查询类型。枚举值： ADMIN
offset	否	Integer	分页查询页码，表示从此页码开始查询。最小值：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 ConnectorInfo objects	连接器信息。
total	Long	总数。
error_code	String	错误码。
error_msg	String	错误描述。

表5 ConnectorInfo
参数	参数类型	描述
connector_id	String	连接器ID。
connector_name	String	连接器名称。
create_user_id	String	创建人ID。
create_user_name	String	创建人。
connector_owner_name	String	连接器管理员名称。
connector_owner_Id	String	连接器管理员ID。
protocol_signed	Boolean	签署IDS协议标识，true代表已经签署了协议，false表示没有签署。

状态码： 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	错误描述。

请求示例

查询连接器列表。

GET https://{endpoint}/v1/{project_id}/eds/instances/{instance_id}/connectors

响应示例

状态码： 200

查询连接器列表。

{
  "data" : [ {
    "connector_id" : "b40b0d94-3201-4687-93aa-************",
    "connector_name" : "连接器A",
    "create_user_name" : "pa*******135",
    "create_user_id" : "0574************",
    "connector_owner_name" : "pa*******135",
    "connector_owner_Id" : "create_user_id",
    "protocol_signed" : true
  } ],
  "total" : 1,
  "error_code" : null,
  "error_msg" : null
}