获取事件连接器列表

最近更新时间:2024-06-07 01:45:05

我的收藏

1. 接口描述

接口请求域名: eb.tencentcloudapi.com 。

获取事件连接器列表

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ListConnections。
Version String 公共参数,本接口取值:2021-04-16。
Region String 公共参数,详见产品支持的 地域列表
EventBusId String 事件集ID
示例值:eb-xxxxxxxx
OrderBy String 根据哪个字段进行返回结果排序,目前支持如下以下字段:AddTime, ModTime
示例值:ModTime
Limit Integer 返回数量,默认为20,最大值为100。
示例值:20
Order String 以升序还是降序的方式返回结果,可选值 ASC 和 DESC
示例值:DESC
Offset Integer 偏移量,默认为0。
示例值:0

3. 输出参数

参数名称 类型 描述
Connections Array of Connection 连接器信息
TotalCount Integer 连接器总数
示例值:1
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取连接器列表

获取连接器列表

输入示例

POST / HTTP/1.1
Host: eb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ListConnections
<公共请求参数>

{
    "EventBusId": "eb-l65vlc2"
}

输出示例

{
    "Response": {
        "Connections": [],
        "RequestId": "cec4c711-4e68-43ac-988f-00171f2b2146",
        "TotalCount": 0
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
InvalidParameterValue.EventBusId EventBusId取值与规范不符,请修正后再试。
InvalidParameterValue.Limit Limit取值与规范不符,请修正后再试。
InvalidParameterValue.Offset Offset取值与规范不符,请修正后再试。
InvalidParameterValue.Order Order取值与规范不符,请修正后再试。
InvalidParameterValue.OrderBy OrderBy取值与规范不符,请修正后再试。
ResourceNotFound 资源不存在。
ResourceNotFound.EventBus 未找到指定事件集,请创建后再试。