tencent cloud

All product documents
Event Bridge
DocumentationEvent BridgeAPI DocumentationEvent Connector APIsCreateConnection
CreateConnection
Download PDF
Last updated: 2023-12-01 16:50:03
CreateConnection
Last updated: 2023-12-01 16:50:03
Download PDF

1. API Description

Domain name for API request: eb.tencentcloudapi.com.

This API is used to create an event connector.

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: CreateConnection.
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.
ConnectionDescription Yes ConnectionDescription Connector description
EventBusId Yes String Event bus ID
ConnectionName Yes String Connector name
Description No String Description
Enable No Boolean Whether to enable
Type No String Type of the connector

3. Output Parameters

Parameter Name Type Description
ConnectionId String Connector ID
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Creating a Connector

Input Example

POST / HTTP/1.1
Host: eb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateConnection
<Common request parameters>

{
    "EventBusId": "eb-l65vlc2",
    "Type": "tdmq",
    "ConnectionDescription": {
        "ResourceDescription": "qcs::tdmq:ap-guangzhou:uin/3473058547:subscriptionName/pulsar-5r5drqo7j8/user/test/sub1",
        "APIGWParams": null
    },
    "ConnectionName": "conn"
}

Output Example

{
    "Response": {
        "ConnectionId": "connection-5t492ybt",
        "RequestId": "99d8d400-2bde-49d6-99f4-7367907e5964"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

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
FailedOperation Operation failed.
FailedOperation.ServiceError ServiceError: operation failed. Please check the resource information.
InternalError.OssException An error occurred while processing the service. Please try again later. If the problem persists, please contact the smart customer service or submit a ticket.
InvalidParameterValue.ConnectionDescription The ConnectionDescription value does not conform to the specification. Please fix it and try again.
InvalidParameterValue.ConnectionName The value of ConnectionName is invalid. Please check and try again.
InvalidParameterValue.DTSParams The value of AMPParams is invalid. Please check and try again.
InvalidParameterValue.Description The Description value does not conform to the specification. Please fix it and try again.
InvalidParameterValue.EventBusId The EventBusId value does not conform to the specification. Please fix it and try again.
InvalidParameterValue.EventBusName The value of EventBusName is invalid. Please check and try again.
InvalidParameterValue.InvalidApiRequestConfig The value of InvalidApiRequestConfig is invalid. Please check and try again.
InvalidParameterValue.Type The Type value does not conform to the specification. Please fix it and try again.
LimitExceeded.Connection The number of Connection reaches the upper limit. You can submit a ticket to increase it.
LimitExceeded.RouteOverLimit The number of RouteOverLimit reaches the upper limit. Submit a ticket to increase it.
OperationDenied.EventBusResourceIsLocked Due to service upgrade, this resource is locked. It may last for about 3-5 minutes. Event pushing is not affected.
OperationDenied.ResourceImmutable The operation failed, as the resource could not be modified or deleted.
OperationDenied.UnsupportedOperation The current user account type does not support this operation. Please submit a ticket.
ResourceNotFound.EventBus The specified event bus was not found. Please create it and try again.
ResourceNotFound.InvalidService The connector operation failed, as the specified API Gateway service was not found.
ResourceNotFound.Role The specified service role was not found. Please create it and try again.
ResourceNotFound.Target The specified Target was not found. Please create it and try again.
ResourceUnavailable.Connection Failed to create the connector: The current resource is unavailable.
UnsupportedOperation Unsupported operation
UnsupportedOperation.InvalidAction The connector operation failed, as the API did not support the current operation.
UnsupportedOperation.InvalidEndpointType Failed to create the connector: The current backend service type is not supported.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

Contact our sales team or business advisors to help your business.

Contact Us
Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 available.

Submit a Ticket
7x24 Phone Support
Hong Kong, China
+852 800 906 020 (Toll Free)
United States
+1 844 606 0804 (Toll Free)
United Kingdom
+44 808 196 4551 (Toll Free)
Canada
+1 888 605 7930 (Toll Free)
Australia
+61 1300 986 386 (Toll Free)
EdgeOne hotline
+852 300 80699
More local hotlines coming soon