CreateConnection - EventBridge - Alibaba Cloud Documentation Center

Creates a connection.

Operation description

You can call this API operation to create a connection.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
ConnectionName	string	Yes	The name of the connection. The name must be 2 to 127 characters in length.	connection-name
Description	string	No	The description of the connection. The description can be up to 255 characters in length.	demo
NetworkParameters	object	Yes	The parameters that are configured for the network.
NetworkType	string	Yes	The network type. Valid values: PublicNetwork and PrivateNetwork. Note: If you set this parameter to PrivateNetwork, you must configure VpcId, VswitcheId, and SecurityGroupId.	PublicNetwork
VpcId	string	No	The VPC. ID	eb-test/vpc-bp1symadadwnwg****
VswitcheId	string	No	The vSwitch ID.	vsw-bp1iu4x7aeradadown1og8,vsw-bp193sqmadadlaszpeq****
SecurityGroupId	string	No	The ID of the security group.	eb-167adad548759-security_grop/sg-bp1addad26peuh9qh9****
AuthParameters	object	No	The parameters that are configured for authentication.
AuthorizationType	string	No	The authentication type. Valid values: BASIC_AUTH: basic authentication. Introduction: Basic authentication is a simple authentication scheme built into the HTTP protocol. When you use the HTTP protocol for communications, the authentication method that the HTTP server uses to authenticate user identities on the client is defined in the protocol. The request header is in the Authorization: Basic Base64-encoded string (Username:Password) format. Username and Password are required. API_KEY_AUTH: API key authentication. Introduction: The request header is in the Token: Token value format. ApiKeyName and ApiKeyValue are required. OAUTH_AUTH: OAuth authentication. Introduction: OAuth2.0 is an authentication mechanism. In normal cases, a system that does not use OAuth2.0 can access the resources of the server from the client. To ensure access security, access tokens are used to authenticate users in OAuth 2.0. The client must use an access token to access protected resources. This way, OAuth 2.0 protects resources from being accessed from malicious clients and improves system security. AuthorizationEndpoint, OAuthHttpParameters, and HttpMethod are required.	BASIC_AUTH
ApiKeyAuthParameters	object	No	The parameters that are configured for API key authentication.
ApiKeyName	string	No	The key of the API key.	Token
ApiKeyValue	string	No	The value of the API key.	adkjnakddh****
BasicAuthParameters	object	No	The parameters that are configured for basic authentication.
Password	string	No	The password for basic authentication.	*******
Username	string	No	The username for basic authentication.	admin
OAuthParameters	object	No	The parameters that are configured for OAuth authentication.
AuthorizationEndpoint	string	No	The IP address of the authorized endpoint. The default value of a column can be up to 127 characters in length.	http://localhost:8080/oauth/token
ClientParameters	object	No	The parameters that are configured for the client.
ClientID	string	No	The client ID.	ClientID
ClientSecret	string	No	The AccessKey secret of the client.	Qo57Q~F249~S74GmNPA36pZJoJK4f4LY****
HttpMethod	string	No	The HTTP request method. Valid values: GET POST HEAD DELETE PUT PATCH	POST
OAuthHttpParameters	object	No	The request parameters that are configured for OAuth authentication.
BodyParameters	object []	No	The parameters that are configured for the request body.
IsValueSecret	string	No	Specifies whether to enable authentication.	false
Key	string	No	The key of the request body.	keyDemo
Value	string	No	The value of the request body.	keyValue
HeaderParameters	object []	No	The parameters that are configured for the request header.
IsValueSecret	string	No	Specifies whether to enable authentication.	false
Key	string	No	The key of the request header.	keyDemo
Value	string	No	The value of the request header.	keyValue
QueryStringParameters	object []	No	The parameters that are configured for the request path.
IsValueSecret	string	No	Specifies whether to enable authentication.	false
Key	string	No	The key of the request path.	keyDemo
Value	string	No	The value of the request path.	valueDemo

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	7DA60DED-CD36-5837-B848-C01A23D2****
Message	string	The returned message. If the request is successful, success is returned. If the request failed, an error code is returned.	success
Code	string	The returned response code. The value Success indicates that the request is successful.	Success
Data	object	The returned data.
ConnectionName	string	The connection name.	connection-demo

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status code	Error code	Error message
409	RequestParameterException	Request parameter exception

For a list of error codes, visit the Service error codes.

Change history

Change time

Summary of changes

Operation

2023-09-13

The Error code has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	Error Codes 409 change
	Added Error Codes: 500

2023-04-12

The Error code has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	delete Error Codes: 409

2023-04-06

The Error code has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	delete Error Codes: 409