1. API Description
Domain name for API request: eb.tencentcloudapi.com.
This API is used to get the list of event connectors.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.
2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: ListConnections. |
| Version | Yes | String | Common Params. The value used for this API: 2021-04-16. |
| Region | No | String | Common Params. This parameter is not required for this API. |
| EventBusId | Yes | String | Event bus ID |
| OrderBy | No | String | Indicates by which field to sort the returned results. Valid values: AddTime, ModTime |
| Limit | No | Integer | Number of returned results. Default value: 20. Maximum value: 100. |
| Order | No | String | Indicates whether the returned results are sorted in ascending or descending order. Valid values: ASC, DESC |
| Offset | No | Integer | Offset. Default value: 0. |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| Connections | Array of Connection | Connector information |
| TotalCount | Integer | Total number of connectors |
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
4. Example
Example1 Getting connector list
Input Example
POST / HTTP/1.1
Host: eb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ListConnections
<Common request parameters>
{
"EventBusId": "eb-l65vlc2"
}
Output Example
{
"Response": {
"Connections": [],
"RequestId": "cec4c711-4e68-43ac-988f-00171f2b2146",
"TotalCount": 0
}
}
Example2 Getting connector list 1
Input Example
POST / HTTP/1.1
Host: eb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ListConnections
<Common request parameters>
{
"EventBusId": "eb-l65vlc2"
}
Output Example
{
"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. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
Command Line Interface
6. Error Code
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| InvalidParameterValue.EventBusId | The EventBusId value does not conform to the specification. Please fix it and try again. |
| InvalidParameterValue.Limit | The Limit value does not conform to the specification. Please fix it and try again. |
| InvalidParameterValue.Offset | The Offset value does not conform to the specification. Please fix it and try again. |
| InvalidParameterValue.Order | The Order value does not conform to the specification. Please fix it and try again. |
| InvalidParameterValue.OrderBy | The OrderBy value does not conform to the specification. Please fix it and try again. |
| ResourceNotFound | The resource does not exist. |
| ResourceNotFound.EventBus | The specified event bus was not found. Please create it and try again. |
是
否
本页内容是否解决了您的问题？