验证连接
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求语法
POST /api/v1/connections/validate HTTP/1.1请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| body |
object |
否 |
请求体。 |
|
| Configs |
object |
否 |
连接的配置信息。以 key-value 的形式配置，不同的连接类型对应的 Config 配置的 key 不相同。具体参见 CreateConnection 接口的请求参数补充说明。 |
|
|
string |
否 |
连接的配置信息。以 key-value 的形式配置，不同的连接类型对应的 Config 配置的 key 不相同。具体参见请求参数补充说明。 |
https://dashscope.aliyuncs.com/compatible-mode/v1 |
|
| ConnectionId |
string |
否 |
连接 ID。如何获取连接 ID，详情请参见 ListConnections 。 |
conn-x2wz5zvvbyf2420fi9 |
| ConnectionType |
string |
否 |
连接的类型，当前支持填写可公网访问的连接类型：
|
DashScopeConnection |
| Secrets |
object |
否 |
需要加密的 key-value 配置。如数据库登录密码，模型连接的 key 等。 |
|
|
string |
否 |
需要加密的连接配置信息。比如数据库的账密信息，模型服务的 key 等。 |
ZGJiZWQ2ZDY3MTMyYjJk****************NjE2NDg1NzM0YzlkZg== |
|
| ValidateType |
string |
否 |
验证类型。可设置为：
|
Connectivity |
| WorkspaceId |
string |
是 |
工作空间 ID，可从接口 ListWorkspaces 获取。 |
1234 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| Status |
string |
本次验证的结果状态。
|
success |
| RequestId |
string |
请求 ID。 |
5A14FA81-DD4E-******-6343FE44B941 |
| Message |
string |
验证结果描述。 |
The connection is reachable. |
| Code |
string |
请求失败时返回的错误代码。 |
403 |
| Details |
object |
验证结果详情。 |
|
|
string |
验证结果的详细信息，如 LatencyMs，表示测试延迟（毫秒）。 |
100 |
示例
正常返回示例
JSON格式
{
"Status": "success",
"RequestId": "5A14FA81-DD4E-******-6343FE44B941",
"Message": "The connection is reachable.",
"Code": "403",
"Details": {
"key": "100"
}
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。