GetModelConnection - 查询模型连接

更新时间:
复制 MD 格式

查询指定模型连接的详细配置、凭据配置状态、发布状态和所属地域。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

agentcore:GetModelConnection

get

*ModelConnection

acs:agentcore:{#regionId}:{#accountId}:workspace/{#workspaceId}/modelconnection/{#connectionId}

无 无

请求语法

GET /workspaces/{workspaceId}/model-connections/{connectionId} HTTP/1.1

路径参数

名称

类型

必填

描述

示例值

workspaceId

string

是

工作空间 ID。

ws-1

connectionId

string

是

模型连接 ID。

mc-1

请求参数

名称

类型

必填

描述

示例值

当前API无需请求参数

返回参数

名称

类型

描述

示例值

object

模型调试成功时返回的模型文本响应;调试失败时为空。

code

string

业务状态码。成功时为 SUCCESS。

SUCCESS

data

object

模型连接详细信息。

apiKeyCount

integer

模型连接中已配置的 API Key 数量。

1

apiKeys

array

用于访问上游模型服务的 API Key 列表,至少包含一个非空值。

string

该字段的业务值。

sk-****

connectionId

string

模型连接 ID。

mc-1

createdAt

string

资源创建时间,采用 RFC 3339 UTC 格式。

2026-08-09T00:00:00Z

credentialConfigured

boolean

是否已为模型连接配置访问凭据。

description

string

模型连接描述,最长 255 个字符。

description

endpoint

string

上游模型服务的绝对 HTTP 或 HTTPS 地址,最长 1024 个字符。

https://dashscope.aliyuncs.com/compatible-mode/v1

name

string

模型连接名称,长度为 1~128 个非空白字符。

name

protocol

string

模型调用协议。当前仅支持 OpenAI/v1,创建模型连接时未设置则使用该默认值。

OpenAI/v1

providerType

string

模型供应商类型。

qwen

regionId

string

资源所属的地域 ID。

cn-hangzhou

status

string

资源状态。

枚举值:

  • Creating :

    创建中

  • Active :

    可用

  • Failed :

    失败

  • Updating :

    更新中

  • Deleting :

    删除中

Active

statusReason

string

模型连接发布失败,或删除失败但仍处于删除中时返回的失败摘要;其他状态为空。

GatewayOperationException

updatedAt

string

资源最后更新时间,采用 RFC 3339 UTC 格式。

2026-08-09T00:00:00Z

workspaceId

string

工作空间 ID。

ws-1

httpStatusCode

integer

HTTP 状态码。成功时为 200。

200

message

string

请求处理结果消息。

success

requestId

string

请求 ID。

request-1

success

boolean

请求是否成功。

示例

正常返回示例

JSON格式

{
  "code": "SUCCESS",
  "data": {
    "apiKeyCount": 1,
    "apiKeys": [
      "sk-****"
    ],
    "connectionId": "mc-1",
    "createdAt": "2026-08-09T00:00:00Z",
    "credentialConfigured": true,
    "description": "description",
    "endpoint": "https://dashscope.aliyuncs.com/compatible-mode/v1",
    "name": "name",
    "protocol": "OpenAI/v1",
    "providerType": "qwen",
    "regionId": "cn-hangzhou",
    "status": "Active",
    "statusReason": "GatewayOperationException",
    "updatedAt": "2026-08-09T00:00:00Z",
    "workspaceId": "ws-1"
  },
  "httpStatusCode": 200,
  "message": "success",
  "requestId": "request-1",
  "success": true
}

错误码

HTTP status code

错误码

错误信息

描述

400 InvalidParameter A model connection parameter is invalid.
404 Resource.NotFound The specified AgentCore workspace does not exist.

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

变更历史

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