UpdateConnection-阿里云帮助中心

Updates the connection configuration.

Operation description

Updates the 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:UpdateConnection

update

*Connection

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

None

Request parameters

Parameter	Type	Required	Description	Example
ConnectionName	string	Yes	The name of the connection to be updated. The maximum length is 127 characters. The minimum length is 2 characters.	connection-name
Description	string	No	The description. The maximum length is 255 characters.	Description of the connection configuration
NetworkParameters	object	Yes	The data structure of the network configuration.
NetworkType	string	Yes	Public network: PublicNetwork Virtual Private Cloud (VPC): PrivateNetwork Note When you select PrivateNetwork, VpcId, VswitcheId, and SecurityGroupId are required.	PublicNetwork
VpcId	string	No	The ID of the VPC.	eb-test/vpc-bp1symadadwnwgmqud
VswitcheId	string	No	The vSwitch ID.	vsw-bp1iu4x7aeradadown1og8,vsw-bp193sqmadadlaszpeqbt2c
SecurityGroupId	string	No	The ID of the security group.	eb-167adad548759-security_grop/sg-bp1addad26peuh9qh9rtyb
Type	string	No	The connection type. Valid values: MySQL, PostgreSQL, Elasticsearch, and Http.	Http
Parameters	any	No	The data source connection parameters (JSON object). For specific field definitions, call the GetConnectionType API and refer to the ParamsSchema in the response.	{"HostName":"xxx.mysql.rds.aliyuncs.com","Port":"3306","User":"root","Password":"xxx","DatabaseName":"demo_db"}
AuthParameters	object	No	The data structure of the authentication parameters.
AuthorizationType	string	No	The authentication type. Valid values: BASIC: BASIC_AUTH. This authorization method is the basic authentication method implemented by browsers in compliance with the HTTP protocol. During communication using the HTTP protocol, the HTTP protocol defines basic authentication that allows the HTTP server to authenticate the user identity of the client. Add Authorization: Basic followed by one space and the Base64-encoded value of `username:password` to the request header in a fixed format. Username and Password are required. API KEY: API_KEY_AUTH. Add Token: TokenValue to the request header in a fixed format. ApiKeyName and ApiKeyValue are required. OAUTH: OAUTH_AUTH. OAuth 2.0 is an authorization mechanism. In normal cases, 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 for users, the Access Token mechanism is added between the client and the resource server. The client must carry an Access Token to access protected resources. Therefore, OAuth 2.0 prevents resources from being accessed by malicious clients, thereby improving the security of the system. AuthorizationEndpoint, OAuthHttpParameters, and HttpMethod are required.	BASIC_AUTH
ApiKeyAuthParameters	object	No	The data structure of API Key authentication.
ApiKeyName	string	No	The key of the API Key.	name
ApiKeyValue	string	No	The value of the API Key.	demo
BasicAuthParameters	object	No	The data structure of Basic authentication.
Password	string	No	The password for Basic authentication.	admin
Username	string	No	The username for Basic authentication.	admin
OAuthParameters	object	No	The data structure of the OAuth authentication parameters.
AuthorizationEndpoint	string	No	The request URL for obtaining the OAuth token. The maximum length is 127 characters.	http://localhost:8080/oauth/token
ClientParameters	object	No	The data structure of the client parameters.
ClientID	string	No	The ID of the client.	ClientID
ClientSecret	string	No	The AppKey secret of the client.	ClientSecret
HttpMethod	string	No	The HTTP request method. Valid values: GET POST HEAD DELETE PUT PATCH	POST
OAuthHttpParameters	object	No	The request parameters for OAuth authentication.
BodyParameters	array<object>	No	The data structure list of the request parameters.
	object	No	The data structure of the body request parameter.
IsValueSecret	string	No	Specifies whether to perform authentication.	false
Key	string	No	The key of the body request parameter.	name
Value	string	No	The value of the body request parameter.	demo
HeaderParameters	array<object>	No	The list of request header parameters.
	object	No	The data structure of the request header parameter.
IsValueSecret	string	No	Specifies whether to perform authentication.	false
Key	string	No	The key of the request header parameter.	name
Value	string	No	The value of the request header parameter.	demo
QueryStringParameters	array<object>	No	The data structure of the request path parameters.
	object	No	The data structure of the request path parameter.
IsValueSecret	string	No	Specifies whether to perform authentication.	false
Key	string	No	The key of the request path parameter.	name
Value	string	No	The value of the request path parameter.	demo

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	8346BE8F-40F3-533D-A0B8-1359C31BD5BA
Message	string	The returned message.	success
Code	string	The API status code or POP error code. Description: 200 indicates success.	200

Examples

Success response

JSON format

{
  "RequestId": "8346BE8F-40F3-533D-A0B8-1359C31BD5BA",
  "Message": "success",
  "Code": "200"
}

Error codes

HTTP status code	Error code	Error message
500	InternalError	InternalError
409	RequestParameterException	Request parameter exception
409	ConnectionNotExist	The Connection not existed!
409	SecretManagerAPIDeleteSecretFailed	Delete secret manager api secret failed!
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!
409	SecretManagerAPIGetSecretValueFailed	Get secret manager api secret value failed!

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.