使用GetConnection查询连接详情-人工智能平台 PAI-阿里云

获取连接详情。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

paiworkspace:GetConnection

get

*全部资源

*

无

请求语法

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

路径参数

名称	类型	必填	描述	示例值
ConnectionId	string	是	连接 ID。如何获取连接 ID，详情请参见 ListConnections 。	conn-pai9m***mi47

请求参数

名称	类型	必填	描述	示例值
EncryptOption	string	否	加密设置。可取值： PlainText：明文。 Secret：密文。	PlainText

返回参数

名称	类型	描述	示例值
	object	响应信息。
RequestId	string	请求唯一 ID。	5A14FA81-DD4E-******-6343FE44B941
WorkspaceId	string	工作空间 ID。	11**43
Accessibility	string	资源可见性，取值如下： PUBLIC：当前工作空间所有成员都可以访问。 PRIVATE：只有创建者可以访问。	PRIVATE
ConnectionId	string	连接 ID。	conn-pai9m***mi47
ConnectionType	string	连接的类型。可能值： DashScopeConnection：百炼服务连接。 OpenLLMConnection：开源模型连接。 MilvusConnection：Milvus 连接。 OpenSearchConnection：OpenSearch 连接。 LindormConnection：Lindorm 连接。 ElasticsearchConnection：Elasticsearch 连接。 HologresConnection：Hologres 连接。 RDSConnection：RDS 连接。 CustomConnection：自定义连接。	OpenSearchConnection
ConnectionName	string	连接的名称。	数据库连接
Description	string	连接的描述。	用于数据集检索。
Configs	object	连接的配置信息。
	string	连接配置的 value 值。	12345
Secrets	object	需要加密的 Key-Value 配置。如数据库登录密码，模型连接的 Key 等。
	string	加密连接配置的 value 值。	Dsjk***hsl01
GmtCreateTime	string	创建连接的 UTC 时间，时间格式为 ISO8601。	2025-03-07T07:54:56Z
GmtModifiedTime	string	修改连接的 UTC 时间，时间格式为 ISO8601。	2025-03-07T07:54:56Z
Creator	string	连接的创建者。	28632***898231
ResourceMeta	object	连接的实例资源信息。一般适用于数据库类型的连接。
InstanceId	string	实例 ID。	ld-2vc1***v1zaqgzol
InstanceName	string	实例名称。	测试实例。
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

示例

正常返回示例

JSON格式

{
  "RequestId": "5A14FA81-DD4E-******-6343FE44B941",
  "WorkspaceId": "11**43",
  "Accessibility": "PRIVATE",
  "ConnectionId": "conn-pai9m***mi47",
  "ConnectionType": "OpenSearchConnection",
  "ConnectionName": "数据库连接",
  "Description": "用于数据集检索。",
  "Configs": {
    "key": "12345"
  },
  "Secrets": {
    "key": "Dsjk***hsl01"
  },
  "GmtCreateTime": "2025-03-07T07:54:56Z",
  "GmtModifiedTime": "2025-03-07T07:54:56Z",
  "Creator": "28632***898231",
  "ResourceMeta": {
    "InstanceId": "ld-2vc1***v1zaqgzol",
    "InstanceName": "测试实例。",
    "Extra": "{\"vpcId\":\"vpc-xxxx\"}"
  },
  "Models": [
    {
      "Model": "model_001",
      "DisplayName": "测试语言模型。",
      "ModelType": "LLM",
      "ToolCall": true
    }
  ]
}

错误码

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

变更历史

更多信息，参考变更详情。