1. 接口描述
接口请求域名: eb.tencentcloudapi.com 。
创建事件连接器
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateConnection。 |
Version | 是 | String | 公共参数,本接口取值:2021-04-16。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
ConnectionDescription | 是 | ConnectionDescription | 连接器描述 |
EventBusId | 是 | String | 事件集ID 示例值:eb-xxxxxxxx |
ConnectionName | 是 | String | 连接器名称 示例值:connection |
Description | 否 | String | 描述 示例值:这是一个描述 |
Enable | 否 | Boolean | 使能开关 示例值:true |
Type | 否 | String | 连接器类型,目前支持以下类型:apigw/ckafka/dts/tdmq 示例值:apigw |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
ConnectionId | String | 连接器ID 示例值:connection-xxxxxxxx |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建连接器
输入示例
POST / HTTP/1.1
Host: eb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateConnection
<公共请求参数>
{
"EventBusId": "eb-l65vlc2",
"Type": "tdmq",
"ConnectionDescription": {
"ResourceDescription": "qcs::tdmq:ap-guangzhou:uin/3473058547:subscriptionName/pulsar-5r5drqo7j8/user/test/sub1",
"APIGWParams": null
},
"ConnectionName": "conn"
}
输出示例
{
"Response": {
"ConnectionId": "connection-5t492ybt",
"RequestId": "99d8d400-2bde-49d6-99f4-7367907e5964"
}
}
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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
FailedOperation.ServiceError | ServiceError操作失败,请检查资源信息。 |
InternalError.OssException | 服务处理出错,请稍后重试。若无法解决,请联系智能客服或提交工单。 |
InvalidParameterValue.ConnectionDescription | ConnectionDescription取值与规范不符,请修正后再试。 |
InvalidParameterValue.ConnectionName | ConnectionName取值与规范不符,请修正后再试。 |
InvalidParameterValue.DTSParams | DTSParams取值与规范不符,请修正后再试。 |
InvalidParameterValue.Description | Description取值与规范不符,请修正后再试。 |
InvalidParameterValue.EventBusId | EventBusId取值与规范不符,请修正后再试。 |
InvalidParameterValue.EventBusName | EventBusName取值与规范不符,请修正后再试。 |
InvalidParameterValue.InvalidApiRequestConfig | InvalidApiRequestConfig取值与规范不符,请修正后再试。 |
InvalidParameterValue.Type | Type取值与规范不符,请修正后再试。 |
LimitExceeded.Connection | Connection数量达到限制,可提交工单申请提升限制。 |
LimitExceeded.RouteOverLimit | RouteOverLimit数量达到限制,可提交工单申请提升限制。 |
OperationDenied.EventBusResourceIsLocked | 技术架构升级,该资源临时锁定中,预计持续3~5分钟,事件推送流程无影响。 |
OperationDenied.ResourceImmutable | 操作失败,该资源不可修改或删除。 |
OperationDenied.UnsupportedOperation | 当前用户账号类型暂不支持操作,请提交工单处理。 |
ResourceNotFound.EventBus | 未找到指定事件集,请创建后再试。 |
ResourceNotFound.InvalidService | 连接器操作失败,未找到指定 API 网关服务。 |
ResourceNotFound.Role | 未找到指定的服务角色,请创建后再试。 |
ResourceNotFound.Target | 未找到指定的Target,请创建后再试。 |
ResourceUnavailable.Connection | 连接器创建失败,当前资源不可用。 |
UnsupportedOperation | 操作不支持。 |
UnsupportedOperation.InvalidAction | 连接器操作失败,接口不支持当前操作。 |
UnsupportedOperation.InvalidEndpointType | 连接器创建失败,不支持当前后端服务类型。 |