CreateConnection - 创建连接_人工智能平台 PAI(PAI)-阿里云帮助中心

创建连接。用于LangStudio、数据集多模态检索服务等场景中连接PAI云端到客户的模型、数据库等服务。

调试

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

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
paiworkspace:CreateConnection	create	全部资源 ``	无	无

请求语法

POST /api/v1/connections HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
body	object	否	请求结构体。创建连接所需要的参数信息。
Accessibility	string	否	工作空间可见度，取值如下。 PRIVATE（默认值）：在此工作空间中，仅对您和管理员可见。 PUBLIC：在此工作空间中，对所有人可见。	PRIVATE
Configs	object	是	连接的配置信息。以 key-valued 的形式配置，不同的连接类型对应的 Config 配置的 key 不相同。具体参见请求参数补充说明。
	string	否	连接配置的 value 值。	6379
ConnectionName	string	是	连接的名称。	llm-connection
ConnectionType	string	否	连接的类型，可选值： DashScopeConnection：百炼服务连接。 OpenLLMConnection：开源模型连接。 MilvusConnection：Milvus 连接。 OpenSearchConnection：OpenSearch 连接。 LindormConnection：Lindorm 连接。 ElasticsearchConnection：Elasticsearch 连接。 HologresConnection：Hologres 连接。 RDSConnection：RDS 连接。 CustomConnection：自定义连接。	DashScopeConnection
Description	string	否	连接的描述。	开源大模型服务连接。
Secrets	object	否	需要加密的连接配置信息。比如数据库的账密信息，模型服务的 key 等。
	string	否	加密连接配置的 value 值。	Dsjk***hsl01
WorkspaceId	string	否	工作空间 ID，可从接口 ListWorkspaces 获取。	123**45
ResourceMeta	object	否	连接的资源信息。一般适用于数据库类型的连接配置。
InstanceName	string	否	实例名称。	测试实例。
InstanceId	string	否	实例 ID。	ld-uf69****9nqjjes
Extra	string	否	额外配置信息。	{"vpcId":"vpc-xxxx"}
Models	array<object>	否	模型列表。适用于模型服务类型的连接。
	object	否	模型。
Model	string	否	模型标识符。	model_001
DisplayName	string	否	模型的显示名称。	语言模型。
ModelType	string	否	模型类型。可选值： LLM：大语言模型 Embedding：Embedding 模型 ReRank：ReRank 模型	LLM
ToolCall	boolean	否	是否支持 ToolCall 工具调用。可取值： true：支持 false：不支持	true

各种连接类型（ConnectionType）对应的 Configs 和 Secrets 配置格式：

DashScopeConnection/OpenLLMConnection

{
    "Secrets": {
        "api_key": "xxx"
    },
    "Configs": {
        "base_url": "cn-hangzhou.aigc.aliyuncs.com/api/v1/services/xxx"
    }
}

OpenSearchConnection/LindormConnection/ElasticsearchConnection


{
    "Secrets": {
        "password": "xxx"
    },
    "Confgs": {
        "uri": "xxx",
        "username": "xxx"
    }
}

MilvusConnection

{
    "Secrets": {
        "password": "xxx"
    },
    "Confgs": {
        "uri": "xxx",
        "username": "xxx"
    }
}

HologresConnection

{
    "Secrets": {
        "password": "xxx"
    },
    "Configs": {
        "database": "xx",
        "port": "xx",
        "host": "xx",
        "user": "xx"
    }
}

RDSConnection

{
    "Secrets": {
        "password": "xxx"
    },
    "Configs": {
        "database": "xxx",
        "port": "xxx",
        "host": "xxx",
        "type": "db_type",
        "username": "xxx"
    }
}

CustomConnection

自定义格式

返回参数

名称	类型	描述	示例值
	object	返回信息。
RequestId	string	请求唯一 ID。	5A14FA81-DD4E-******-6343FE44B941
ConnectionId	string	连接 ID。	conn-pai9m***mi47

示例

正常返回示例

JSON格式

{
  "RequestId": "5A14FA81-DD4E-******-6343FE44B941",
  "ConnectionId": "conn-pai9m***mi47"
}

错误码

访问错误中心查看更多错误码。