UpdateConnection-阿里云帮助中心

Updates a connection configuration.

Try it now

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

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

paiworkspace:UpdateConnection

update

*All Resource

*

None

Request syntax

PUT /api/v1/connections/{ConnectionId} HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
ConnectionId	string	Yes	The connection ID. For information about how to obtain a connection ID, see ListConnections.	conn-pai9m***mi47

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	The request body.
Configs	object	No	The configuration of the connection, specified as key-value pairs. The keys in the Configs parameter vary based on the connection type. For more information, see the request parameters in the CreateConnection topic.
	string	No	The value of a connection configuration parameter.	6379
Description	string	No	The description of the connection.	用于标注的连接。
Secrets	object	No	Key-value pairs that require encryption, such as database logon passwords and keys for model connections.
	string	No	The value of an encrypted connection configuration parameter.	Dakbjas**aljksdn
Models	array<object>	No	A list of model information.
	object	No	The model information.
Model	string	No	The model identifier.	model_001
DisplayName	string	No	The display name of the model.	car_tag
ModelType	string	No	The model type. Valid values: LLM Embedding ReRank	LLM
ToolCall	boolean	No	Indicates whether ToolCall is supported. Valid values: true: ToolCall is supported. false: ToolCall is not supported.	true

Response elements

Element	Type	Description	Example
	object	The response.
RequestId	string	The unique ID of the request.	A0F049F0-8D69-5BAC-8F10-B******A34C

Examples

Success response

JSON format

{
  "RequestId": "A0F049F0-8D69-5BAC-8F10-B******A34C"
}

Error codes

See for a complete list.

Release notes

See 变更详情 for a complete list.