更新时间:2023-12-12 GMT+08:00
分享

查询目标连接列表

功能介绍

查询目标连接列表。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

GET /v1/{project_id}/connections

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户项目ID

表2 Query参数

参数

是否必选

参数类型

描述

offset

Integer

偏移量,表示从此偏移量开始查询,偏移量不能小于0

最小值:0

最大值:100

缺省值:0

limit

Integer

每页显示的条目数量,不能小于1或大于1000

最小值:1

最大值:1000

缺省值:15

sort

String

指定查询排序

缺省值:created_time:DESC

name

String

指定查询的目标连接名称,精准匹配

fuzzy_name

String

指定查询的目标连接名称,模糊匹配

instance_id

String

指定查询的目标连接,队列的实例id

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

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

最小长度:1

最大长度:16384

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

total

Integer

总数

最小值:0

最大值:100

size

Integer

本页数量

最小值:0

最大值:100

items

Array of ConnectionInfo objects

对象列表

数组长度:0 - 100

表5 ConnectionInfo

参数

参数类型

描述

id

String

事件源ID

name

String

目标连接名称,租户下唯一,由小写字母、数字、点、下划线和中划线组成,必须以字母或数字开头,不能为default

description

String

目标连接描述

status

String

目标连接状态

枚举值:

  • CREATING

  • CREATED

  • CREATE_FAILED

error_info

ErrorInfo object

vpc_id

String

待连接的VPC ID

subnet_id

String

待连接的子网ID

agency

String

私网目标连接使用的用户委托名称

flavor

flavor object

规格

type

String

目标连接类型。目前支持webhook:http连接;kafka:华为云官方kafka实例

枚举值:

  • WEBHOOK

  • KAFKA

kafka_detail

KafkaConnectionDetail object

created_time

String

创建UTC时间

updated_time

String

更新UTC时间

表6 ErrorInfo

参数

参数类型

描述

error_code

String

错误码

最小长度:1

最大长度:128

error_detail

String

错误详情

最小长度:1

最大长度:128

error_msg

String

错误信息

最小长度:1

最大长度:128

表7 flavor

参数

参数类型

描述

name

String

规格名称

concurrency_type

String

并发规格类型

枚举值:

  • shared

  • exclusive

concurrency

Integer

并发数

bandwidth_type

String

带宽类型

枚举值:

  • shared

  • exclusive

表8 KafkaConnectionDetail

参数

参数类型

描述

instance_id

String

kafka实例id。

addr

String

kafka连接地址。

security_protocol

String

安全协议。

enable_sasl_ssl

Boolean

kafka实例是否开启了SASL_SSL。

缺省值:false

user_name

String

kafka实例用户名。实例开启了SASL_SSL时必填

password

String

kafka实例密码。实例开启了SASL_SSL时必填

acks

String

收到Server端确认信号个数,表示producer需要收到多少个这样的确认信号,算消息发送成功。acks参数代表了数据备份的可用性。支持选项: acks=0:表示producer不需要等待任何确认收到的信息,副本将立即加到socket buffer并认为已经发送。没有任何保障可以保证此种情况下server已经成功接收数据,同时重试配置不会发生作用(因为客户端不知道是否失败)回馈的offset会总是设置为-1。 acks=1:这意味着至少要等待leader已经成功将数据写入本地log,但是并没有等待所有follower是否成功写入。如果follower没有成功备份数据,而此时leader又无法提供服务,则消息会丢失。 acks=all:这意味着leader需要等待ISR中所有备份都成功写入日志,只有任何一个备份存活,数据都不会丢失。min.insync.replicas指定必须确认写入才能被认为成功的副本的最小数量。

缺省值:1

枚举值:

  • 0

  • 1

  • all

状态码: 400

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度:1

最大长度:128

error_msg

String

错误消息

最小长度:1

最大长度:512

error_details

String

具体错误消息

最小长度:1

最大长度:1024

request_id

String

请求处理ID

最小长度:1

最大长度:128

状态码: 401

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度:1

最大长度:128

error_msg

String

错误消息

最小长度:1

最大长度:512

error_details

String

具体错误消息

最小长度:1

最大长度:1024

request_id

String

请求处理ID

最小长度:1

最大长度:128

状态码: 403

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度:1

最大长度:128

error_msg

String

错误消息

最小长度:1

最大长度:512

error_details

String

具体错误消息

最小长度:1

最大长度:1024

request_id

String

请求处理ID

最小长度:1

最大长度:128

状态码: 404

表12 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度:1

最大长度:128

error_msg

String

错误消息

最小长度:1

最大长度:512

error_details

String

具体错误消息

最小长度:1

最大长度:1024

request_id

String

请求处理ID

最小长度:1

最大长度:128

状态码: 500

表13 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度:1

最大长度:128

error_msg

String

错误消息

最小长度:1

最大长度:512

error_details

String

具体错误消息

最小长度:1

最大长度:1024

request_id

String

请求处理ID

最小长度:1

最大长度:128

请求示例

响应示例

状态码: 400

{
  "error_code" : "EG.00014000",
  "error_msg" : "Bad request"
}

状态码: 401

{
  "error_code" : "EG.00014010",
  "error_msg" : "Incorrect token or token resolution failed"
}

状态码: 403

{
  "error_code" : "EG.00014030",
  "error_msg" : "No permissions to request this method"
}

状态码: 404

{
  "error_code" : "EG.00014040",
  "error_msg" : "Not request resource found"
}

状态码: 500

{
  "error_code" : "EG.00015000",
  "error_msg" : "Internal Server Error"
}

状态码

状态码

描述

200

列表

400

非法请求

401

未授权

403

禁止访问

404

未找到资源

500

内部服务错误

错误码

请参见错误码

相关文档