获取连接列表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
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 |
Order |
string |
否 |
分页查询时,对指定的排序字段进行升序或降序,与 SortBy 结合使用。
|
DESC |
ConnectionIds |
array |
否 |
连接 ID 列表。 |
|
string |
否 |
连接 ID。 |
conn-ljasd***jsx |
|
ConnectionName |
string |
否 |
连接的名称。 |
数据库连接 |
ConnectionTypes |
array |
否 |
连接类型列表。 |
|
string |
否 |
连接类型。可选值:
|
OpenLLMConnection |
|
EncryptOption |
string |
否 |
加密设置。可取值:
|
PlainText |
Model |
string |
否 |
模型标识符。 |
model_001 |
ModelTypes |
array |
否 |
模型类型列表。 |
|
string |
否 |
模型类型。可取值:
|
LLM |
|
ToolCall |
boolean |
否 |
是否支持 ToolCall 工具调用。可取值:
|
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": [
{
"ConnectionType": "",
"Description": "",
"Accessibility": "",
"Secrets": {
"key": ""
},
"WorkspaceId": "",
"Creator": "",
"ResourceMeta": {
"InstanceName": "",
"InstanceId": ""
},
"GmtModifiedTime": "",
"ConnectionName": "",
"ConnectionId": "",
"Configs": {
"key": ""
},
"Models": [
{
"Model": "",
"DisplayName": "",
"ModelType": "",
"ToolCall": true
}
],
"GmtCreateTime": ""
}
],
"MaxResults": 10,
"NextToken": "15",
"TotalCount": 27,
"RequestId": "B2C51F93-1C07-5477-9705-5FDB****F19F"
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。