更新时间:2025-04-25 GMT+08:00
分享

查询目标连接详情

功能介绍

查询目标连接详情。

调试

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

URI

GET /v1/{project_id}/connections/{connection_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户资源空间ID

connection_id

String

指定查询的目标连接ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

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

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

id

String

事件源ID

name

String

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

description

String

目标连接描述

status

String

目标连接状态

error_info

ErrorInfo object

错误信息

vpc_id

String

待连接的VPC ID

subnet_id

String

待连接的子网ID

agency

String

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

flavor

flavor object

规格

type

String

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

kafka_detail

KafkaConnectionDetail object

kafka连接参数

created_time

String

创建UTC时间

updated_time

String

更新UTC时间

表4 ErrorInfo

参数

参数类型

描述

error_code

String

错误码

error_detail

String

错误详情

error_msg

String

错误信息

表5 flavor

参数

参数类型

描述

name

String

规格名称

concurrency_type

String

并发规格类型

concurrency

Integer

并发数

bandwidth_type

String

带宽类型

表6 KafkaConnectionDetail

参数

参数类型

描述

instance_id

String

kafka实例id。

addr

String

kafka连接地址。

security_protocol

String

安全协议。

enable_sasl_ssl

Boolean

kafka实例是否开启了SASL_SSL。

user_name

String

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

password

String

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

acks

String

收到Server端确认信号个数,表示procuder需要收到多少个这样的确认信号,算消息发送成功。acks参数代表了数据备份的可用性。支持选项:

acks=0:表示producer不需要等待任何确认收到的信息,副本将立即加到socket buffer并认为已经发送。没有任何保障可以保证此种情况下server已经成功接收数据,同时重试配置不会发生作用(因为客户端不知道是否失败)回馈的offset会总是设置为-1。

acks=1:这意味着至少要等待leader已经成功将数据写入本地log,但是并没有等待所有follower是否成功写入。如果follower没有成功备份数据,而此时leader又无法提供服务,则消息会丢失。

acks=all:这意味着leader需要等待ISR中所有备份都成功写入日志,只有任何一个备份存活,数据都不会丢失。min.insync.replicas指定必须确认写入才能被认为成功的副本的最小数量。

请求示例

查询目标连接详情

GET https://{endpoint}/v1/{project_id}/connections/{connection_id}

响应示例

状态码:200

详情

{
  "id" : "90e0b962-c6c1-438c-ba8a-3024fe592bda",
  "name" : "private-link",
  "description" : "",
  "status" : "CREATING",
  "error_info" : { },
  "vpc_id" : "ac14144e-8fec-53d6-bdfd-8f09b52c09iu",
  "subnet_id" : "bf14153e-5fec-67d6-b89d-5409b52c0op8",
  "agency" : "EG_TRUST",
  "flavor" : {
    "name" : "default",
    "concurrency_type" : "exclusive",
    "concurrency" : 500,
    "bandwidth_type" : "exclusive"
  },
  "type" : { },
  "kafka_detail" : { },
  "created_time" : "2021-12-09 09:00:00",
  "updated_time" : "2021-12-09 09:00:00"
}

状态码

状态码

描述

200

详情

错误码

请参见错误码

相关文档