Documentation
Home Page EventBridge Developer Reference API Reference API catalog Others CreateConnection

CreateConnection

Updated at:
Copy as MD

Creates a connection configuration.

Operation description

Creates a connection configuration.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

eventbridge:CreateConnection

create

*Connection

acs:eventbridge:{#regionId}:{#accountId}:connection/*

 None None

Request parameters

Parameter

Type

Required

Description

Example
ConnectionName

string

Yes

The connection configuration name. Maximum length: 127 characters. Minimum length: 2 characters.

connection-name
Description

string

No

The description of the connection configuration. Maximum length: 255 characters.

demo
NetworkParameters

object

Yes

The network configuration.

NetworkType

string

Yes

  • Public network: PublicNetwork

  • Virtual private cloud (VPC): PrivateNetwork

Important If you select PrivateNetwork, VpcId, VswitcheId, and SecurityGroupId are required.

PublicNetwork
VpcId

string

No

The ID of the VPC.

eb-test/vpc-bp1symadadwnwg****
VswitcheId

string

No

The vSwitch ID.

vsw-bp1iu4x7aeradadown1og8,vsw-bp193sqmadadlaszpeq****
SecurityGroupId

string

No

The security group ID.

eb-167adad548759-security_grop/sg-bp1addad26peuh9qh9****
Type

string

No

The connection type. Valid values: MySQL, PostgreSQL, Elasticsearch, and Http. This parameter is required for data source connections. If this parameter is not specified, the default value Http is used. The Http type is used for HTTP protocol targets such as API Destination. Data source types are used for data connections in the integration marketplace.

Http
Parameters

any

No

The data source connection parameters (JSON object). This parameter is required when Type is set to a data source type. This parameter is not required for the Http type. For specific field definitions, call the GetConnectionType operation and refer to ParamsSchema in the response.

{"HostName":"xxx.mysql.rds.aliyuncs.com","Port":"3306","User":"root","Password":"xxx","DatabaseName":"demo_db"}
AuthParameters

object

No

The authentication configuration.

AuthorizationType

string

No

The authentication type:

  • BASIC: BASIC_AUTH. This authorization method is a basic authorization method implemented by browsers in compliance with the HTTP protocol. During HTTP communication, the HTTP protocol defines a basic authentication method that allows an HTTP server to authenticate clients. Add Authorization: Basic Base64Encoded(username:password) in the fixed format to the request header. Username and Password are required.

  • API KEY: API_KEY_AUTH. Add Token: TokenValue in the fixed format to the request header. ApiKeyName and ApiKeyValue are required.

  • OAUTH: OAUTH_AUTH. OAuth 2.0 is an authorization mechanism. In a system that does not use an authorization mechanism such as OAuth 2.0, the client can directly access resources on the resource server. To ensure secure data access, an Access Token mechanism is added. The client must carry an Access Token to access protected resources. OAuth 2.0 prevents resources from being accessed by malicious clients, which improves system security. AuthorizationEndpoint, OAuthHttpParameters, and HttpMethod are required.

BASIC_AUTH
ApiKeyAuthParameters

object

No

The API key authentication configuration.

ApiKeyName

string

No

The key name of the API key.

Token
ApiKeyValue

string

No

The value of the API key.

adkjnakddh****
BasicAuthParameters

object

No

The basic authentication configuration.

Password

string

No

The password for basic authentication.

*******
Username

string

No

The username for basic authentication.

admin
OAuthParameters

object

No

The OAuth authentication configuration.

AuthorizationEndpoint

string

No

The authorization endpoint URL. Maximum length: 127 characters.

http://localhost:8080/oauth/token
ClientParameters

object

No

The client parameter configuration.

ClientID

string

No

The client ID.

ClientID
ClientSecret

string

No

The client secret of the application.

Qo57Q~F249~S74GmNPA36pZJoJK4f4LY****
HttpMethod

string

No

The HTTP method. Valid values:

  • GET

  • POST

  • HEAD

  • DELETE

  • PUT

  • PATCH

POST
OAuthHttpParameters

object

No

The OAuth authentication request parameters.

BodyParameters

array<object>

No

The list of body request parameter data structures.

object

No

The data structure of a body request parameter.

IsValueSecret

string

No

Specifies whether the value is used for authentication.

false
Key

string

No

The key of the body request parameter.

keyDemo
Value

string

No

The value of the body request parameter.

keyValue
HeaderParameters

array<object>

No

The list of header parameters.

object

No

The data structure of a header parameter.

IsValueSecret

string

No

Specifies whether the value is used for authentication.

false
Key

string

No

The key of the header parameter.

keyDemo
Value

string

No

The value of the header parameter.

keyValue
QueryStringParameters

array<object>

No

The data structure of the URI of the request path parameters.

object

No

The data structure of a URI of the request path parameter.

IsValueSecret

string

No

Specifies whether the value is used for authentication.

false
Key

string

No

The key of the URI of the request path parameter.

keyDemo
Value

string

No

The value of the URI of the request path parameter.

valueDemo

Response elements

Element

Type

Description

Example

object

RequestId

string

The request ID generated by Alibaba Cloud for this request.

7DA60DED-CD36-5837-B848-C01A23D2****
Message

string

The additional information. If the request is successful, success is returned. If the request fails, the specific error code is returned.

success
Code

string

The API status or POP error code. Valid values: Success.

Success
Data

object

The returned result.

ConnectionName

string

The connection configuration name.

connection-demo

Examples

Success response

JSON format

{
  "RequestId": "7DA60DED-CD36-5837-B848-C01A23D2****",
  "Message": "success",
  "Code": "Success",
  "Data": {
    "ConnectionName": "connection-demo"
  }
}

Error codes

HTTP status code

Error code

Error message

Description
500 InternalError InternalError
409 RequestParameterException Request parameter exception
409 ConnectionAlreadyExist The Connection already existed!
409 ConnectionCountExceedLimit The current count of connection, which will exceed the limit quota.
409 BasicRequiredParameterIsEmpty Basic required parameters are empty, the required parameters are username and password!
409 BasicUserNameLengthExceed Basic username length cannot exceed 127!
409 BasicPassWordLengthExceed Basic password length cannot exceed 127!
409 ApiKeyRequiredParameterIsEmpty Api Key required parameters are empty, the required parameters are apiKeyName and apiKeyValue!
409 ApiKeyNameLengthExceed Api key name length cannot exceed 127!
409 ApiKeyValueLengthExceed Api key value length cannot exceed 127!
409 OAuthRequiredParameterIsEmpty OAuth required parameters are empty, the required parameters are authorizationEndpoint and httpMethod!
409 AuthorizationEndpointLengthExceed Authorization endpoint length cannot exceed 127!
409 ClientIDLengthExceed ClientID length cannot exceed 127!
409 ClientSecretLengthExceed ClientSecret length cannot exceed 127!
409 OauthHttpParametersEmpty OauthHttpParameters is Empty.
409 SecretManagerAPICreateSecretNameFailed Create secret manager api secret name failed

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.

Previous：CreateAgentNext：CreateNamespace