获取事件连接器列表

最近更新时间：2024-03-12 01:28:37

我的收藏

本页目录：

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
    }
}

示例2 获取连接器列表1

输入示例

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

{
    "EventBusId": "eb-l65vlc2"
}

输出示例

{
    "Response": {
        "Connections": [
            {
                "AddTime": "2021-04-29T13:13:43+08:00",
                "ConnectionDescription": {
                    "APIGWParams": null,
                    "ResourceDescription": "qcs::tdmq:ap-guangzhou:uin/3473058547:subscriptionName/pulsar-5r5drqo7j8/user/test/sub1"
                },
                "ConnectionId": "connection-5t492ybt",
                "ConnectionName": "conn",
                "Description": "",
                "Enable": false,
                "EventBusId": "eb-l65vlc2u",
                "ModTime": "2021-04-29T13:13:44+08:00",
                "Status": "Active",
                "Type": "tdmq"
            },
            {
                "AddTime": "2021-04-29T13:00:32+08:00",
                "ConnectionDescription": {
                    "APIGWParams": null,
                    "ResourceDescription": "qcs::tdmq:ap-guangzhou:uin/3473058547:subscriptionName/pulsar-5r5drqo7j8/user/test/sub1"
                },
                "ConnectionId": "connection-7mpfojtt",
                "ConnectionName": "conn",
                "Description": "",
                "Enable": false,
                "EventBusId": "eb-l65vlc2u",
                "ModTime": "2021-04-29T13:00:33+08:00",
                "Status": "Failed",
                "Type": "tdmq"
            },
            {
                "AddTime": "2021-04-29T12:58:24+08:00",
                "ConnectionDescription": {
                    "APIGWParams": null,
                    "ResourceDescription": "qcs::tdmq:ap-guangzhou:uin/3473058547:subscriptionName/pulsar-5r5drqo7j8/user/test/sub1"
                },
                "ConnectionId": "connection-il11bb0h",
                "ConnectionName": "conn",
                "Description": "",
                "Enable": false,
                "EventBusId": "eb-l65vlc2u",
                "ModTime": "2021-04-29T12:58:24+08:00",
                "Status": "Failed",
                "Type": "tdmq"
            },
            {
                "AddTime": "2021-04-29T12:01:34+08:00",
                "ConnectionDescription": {
                    "APIGWParams": null,
                    "ResourceDescription": "qcs::tdmq:ap-guangzhou:uin/3473058547:subscriptionName/pulsar-5r5drqo7j8/user/test/sub1"
                },
                "ConnectionId": "connection-6s29eqob",
                "ConnectionName": "conn",
                "Description": "",
                "Enable": false,
                "EventBusId": "eb-l65vlc2u",
                "ModTime": "2021-04-29T12:01:35+08:00",
                "Status": "Failed",
                "Type": "tdmq"
            },
            {
                "AddTime": "2021-04-29T11:46:27+08:00",
                "ConnectionDescription": {
                    "APIGWParams": null,
                    "ResourceDescription": "qcs::tdmq:ap-guangzhou:uin/3473058547:subscriptionName/pulsar-5r5drqo7j8/user/test/sub1"
                },
                "ConnectionId": "connection-dka58wiv",
                "ConnectionName": "conn",
                "Description": "",
                "Enable": false,
                "EventBusId": "eb-l65vlc2u",
                "ModTime": "2021-04-29T11:46:28+08:00",
                "Status": "Failed",
                "Type": "tdmq"
            },
            {
                "AddTime": "2021-04-29T11:42:44+08:00",
                "ConnectionDescription": {
                    "APIGWParams": null,
                    "ResourceDescription": "qcs::tdmq:ap-guangzhou:uin/3473058547:subscriptionName/pulsar-5r5drqo7j8/user/test/sub1"
                },
                "ConnectionId": "connection-r1o76r2d",
                "ConnectionName": "conn",
                "Description": "",
                "Enable": false,
                "EventBusId": "eb-l65vlc2u",
                "ModTime": "2021-04-29T11:42:44+08:00",
                "Status": "Failed",
                "Type": "tdmq"
            },
            {
                "AddTime": "2021-04-29T11:35:12+08:00",
                "ConnectionDescription": {
                    "APIGWParams": null,
                    "ResourceDescription": "qcs::tdmq:ap-guangzhou:uin/3473058547:subscriptionName/pulsar-5r5drqo7j8/user/test/sub1"
                },
                "ConnectionId": "connection-ay3ix129",
                "ConnectionName": "conn",
                "Description": "",
                "Enable": false,
                "EventBusId": "eb-l65vlc2u",
                "ModTime": "2021-04-29T11:35:13+08:00",
                "Status": "Failed",
                "Type": "tdmq"
            },
            {
                "AddTime": "2021-04-29T11:24:45+08:00",
                "ConnectionDescription": {
                    "APIGWParams": null,
                    "ResourceDescription": "qcs::tdmq:ap-guangzhou:uin/3473058547:subscriptionName/pulsar-5r5drqo7j8/user/test/sub1"
                },
                "ConnectionId": "connection-heno97b7",
                "ConnectionName": "conn",
                "Description": "",
                "Enable": false,
                "EventBusId": "eb-l65vlc2u",
                "ModTime": "2021-04-29T11:24:45+08:00",
                "Status": "Failed",
                "Type": "tdmq"
            }
        ],
        "RequestId": "e576a375-88ae-4c3f-84a9-0bf28dc7b0ee",
        "TotalCount": 8
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

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

上一篇: 删除事件连接器下一篇: 更新事件连接器