调用ListConnections API获取连接列表-人工智能平台 PAI-阿里云

获取连接列表。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

paiworkspace:ListConnections

list

*全部资源

*

无

请求语法

GET /api/v1/connections HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
WorkspaceId	string	否	工作空间 ID。如何获取工作空间 ID，请参见 ListWorkspaces 。	478**
NextToken	string	否	分页游标的标识。用于标记下一页查询的起始位置。	15
MaxResults	integer	否	每页的最大数据条数。	10
SortBy	string	否	分页查询时的排序字段，默认使用 GmtCreateTime。取值如下。 GmtCreateTime（默认值）：按创建时间。	GmtCreateTime
Order	string	否	分页查询时，对指定的排序字段进行升序或降序，与 SortBy 结合使用。 ASC：升序。 DESC（默认值）：降序。	DESC
ConnectionIds	array	否	连接 ID 列表。
	string	否	连接 ID。	conn-ljasd***jsx
ConnectionName	string	否	连接的名称。	数据库连接
ConnectionTypes	array	否	连接类型列表。
	string	否	连接类型。可选值： DashScopeConnection：百炼服务连接。 OpenLLMConnection：开源模型连接。 MilvusConnection：Milvus 连接。 OpenSearchConnection：OpenSearch 连接。 LindormConnection：Lindorm 连接。 ElasticsearchConnection：Elasticsearch 连接。 HologresConnection：Hologres 连接。 RDSConnection：RDS 连接。 CustomConnection：自定义连接。	OpenLLMConnection
EncryptOption	string	否	加密设置。可取值： PlainText（明文） Secret（密文）	PlainText
Model	string	否	模型标识符。	model_001
ModelTypes	array	否	模型类型列表。
	string	否	模型类型。可取值： LLM Embedding ReRank	LLM
ToolCall	boolean	否	是否支持 ToolCall 工具调用。可取值： true：支持 false：不支持	true
Creator	string	否	创建者。	12908*******3242

返回参数

名称	类型	描述	示例值
	object	响应信息。
Connections	array	连接列表信息。
	Connection	连接信息。
MaxResults	integer	每页的最大数据条数。	10
NextToken	string	分页游标的标识。用于标记下一页查询的起始位置。	15
TotalCount	integer	符合过滤条件的连接总数。	27
RequestId	string	请求唯一 ID。	B2C51F93-1C07-5477-9705-5FDB****F19F

示例

正常返回示例

JSON格式

{
  "Connections": [
    {
      "Description": "This is a description of a database connection.",
      "ConnectionType": "ElasticsearchConnection",
      "Accessibility": "PRIVATE",
      "Secrets": {
        "key": "Dsjk***hsl01\n"
      },
      "WorkspaceId": "228**",
      "Creator": "20925961****557803",
      "ResourceMeta": {
        "InstanceName": "lindorm-xxxxxxx",
        "Extra": "{\"vpcId\":\"vpc-xxxx\"}",
        "InstanceId": "ld-2vc1***v1zaqgzol"
      },
      "GmtModifiedTime": "2025-03-07T07:54:56Z\n",
      "ConnectionName": "lindorm-connection",
      "ConnectionId": "conn-pai9m***mi47",
      "Configs": {
        "key": "12345"
      },
      "Models": [
        {
          "ToolCall": true,
          "Model": "model_001",
          "DisplayName": "BGE model deploy.",
          "ModelType": "LLM"
        }
      ],
      "GmtCreateTime": "2025-03-07T07:54:56Z\n"
    }
  ],
  "MaxResults": 10,
  "NextToken": "15",
  "TotalCount": 27,
  "RequestId": "B2C51F93-1C07-5477-9705-5FDB****F19F"
}

错误码

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

变更历史

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