注册Agent
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| ClientToken |
string |
否 |
提供幂等能力,3 分钟内,相同的值只会生效一次。 |
eyJhbGciOiJIUzI1NiIsInR5cC..... |
| AgentDisplayName |
string |
是 |
Agent 显示名称 |
测试Agent |
| AgentHost |
string |
是 |
Agent 对外提供服务 Endpoint 域名名称 |
example.com |
| AgentVersion |
string |
是 |
Agent 版本 |
1.0.1 |
| AgentDescription |
string |
否 |
Agent 能力描述 |
支付服务 |
| RegistrantId |
string |
是 |
实名认证注册者的 id,需要调用实名认证 API 接口获取或从 ATS 控制台获取 |
2072277378616354816 |
| Endpoints |
array<object> |
是 |
配置 Agent 接入点信息 |
[{\"EndpointValue\":\"http://www.baidu.com\",\"EndpointType\":\"http\"}] |
|
object |
否 |
已废弃字段。请使用 Endpoint |
||
| Protocol |
string |
否 |
声明该 Agent 端点遵循的通信协议标准,决定调用方如何与该 Agent 交互: 协议 说明
作用:其他 Agent 或客户端看到这个协议标识后,就知道该用什么方式与它对话。比如 MCP 协议走 MCP SDK,A2A 走 A2A SDK,OpenAPI 走标准 HTTP 请求。 |
A2A |
| AgentUrl |
string |
否 |
该 Agent 端点的实际服务地址,即 Agent 在线运行的 HTTPS 入口。必填字段,最大 500 字符。
作用:调用方通过 DNS 发现到这个 Agent 后,拿到这个 URL 就可以直接发起连接。这是 Agent 真正"在线"的地址。 |
https://www.example.com/mcp |
| Transports |
array |
否 |
传输方式 |
STREAMABLE-HTTP |
|
string |
否 |
该 Agent 端点支持的通信传输机制,与协议(protocol)联动: 协议 可选传输方式 说明 1、协议:MCP,可选传输方式:STREAMABLE-HTTP、SSE,说明:MCP 协议支持流式 HTTP 和 Server-Sent Events 2、协议:A2A,可选传输方式:STREAMABLE-HTTP、SSE,说明:A2A 协议同样支持这两种 3、协议:OpenAPI,可选传输方式:REST、HTTP,说明:传统 REST API 通信方式 |
STREAMABLE-HTTP |
|
| MetadataUrl |
string |
否 |
一个可选的 URL 地址,指向该 Agent 的元数据描述文件(通常是 JSON 格式)。作用:让其他 Agent 或客户端在连接前,可以通过这个 URL 自动发现该 Agent 的能力描述,包括: Agent 支持哪些功能(functions) 输入/输出格式 版本信息 其他能力声明 |
// https://my-agent.example.com/.well-known/agent.json { "name": "智能客服助手", "version": "1.2.0", "protocol": "MCP", "description": "提供产品咨询、订单查询、售后服务的智能客服Agent", "capabilities": { "tools": [ { "name": "order_query", "description": "查询订单状态" }, { "name": "product_search", "description": "搜索产品信息" }, { "name": "refund_request", "description": "发起退款申请" } ], "resources": [ { "uri": "faq://knowledge-base", "description": "FAQ知识库" } ] }, "endpoint": { "url": "https://my-agent.example.com/mcp", "transport": ["STREAMABLE-HTTP", "SSE"] }, "policy": { "authentication": "mTLS", "rateLimit": "100/min" } } |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| RequestId |
string |
请求 ID |
536E9CAD-DB30-4647-AC87-AA5CC38C5382 |
| AgentRegisterInfoId |
string |
AgentRegisterInfoId Agent 注册 ID。由阿里云 ATS 平台自动生成,在阿里云 ATS 平台具有全局唯一性。在 Agent 注册过程中自动生成,通过 API 注册的多步流程中,该 ID 必须全程携带,以确保各步骤关联至同一 Agent,完成完整的注册闭环。 |
2074031103110331392 |
| AtiName |
string |
ATI 名称,在 ATI 信任体系中的全局唯一标识符 示例解析: ati://v1.0.0.www.example.com
|
ati://v1.0.0.www.example.com |
| Status |
string |
解析记录状态。取值: Enable: 启用解析 Disable: 暂停解析 |
enable disable |
| CreateTimestamp |
integer |
创建时间(时间戳)。 |
1527690629357 |
| AccessDeniedDetail |
object |
访问被拒绝详细信息,只有 RAM 校验失败才会返回此字段。 |
|
| AuthAction |
string |
尝试执行的未授权操作。 |
AddRspDomainServerHoldStatusForGateway |
| AuthPrincipalDisplayName |
string |
授权主体显示名称。 |
2015555733387XXXX |
| AuthPrincipalOwnerId |
string |
授权主体所有者 ID。 |
10469733312XXX |
| AuthPrincipalType |
string |
身份类型 |
SubUser |
| EncodedDiagnosticMessage |
string |
加密后的完整诊断信息。 |
AQFohtp4aIbaeEXXXXQxNjFDLUIzMzgtNTXXXX05NkFCLUI2RkY5XXXXzAzQQ== |
| NoPermissionType |
string |
导致鉴权失败的原因。具体取值为:
|
ImplicitDeny |
| PolicyType |
string |
策略类型。 |
DlpSend |
示例
正常返回示例
JSON格式
{
"RequestId": "536E9CAD-DB30-4647-AC87-AA5CC38C5382",
"AgentRegisterInfoId": "2074031103110331392",
"AtiName": "ati://v1.0.0.www.example.com",
"Status": "enable\ndisable",
"CreateTimestamp": 1527690629357,
"AccessDeniedDetail": {
"AuthAction": "AddRspDomainServerHoldStatusForGateway",
"AuthPrincipalDisplayName": "2015555733387XXXX",
"AuthPrincipalOwnerId": "10469733312XXX",
"AuthPrincipalType": "SubUser",
"EncodedDiagnosticMessage": "AQFohtp4aIbaeEXXXXQxNjFDLUIzMzgtNTXXXX05NkFCLUI2RkY5XXXXzAzQQ==",
"NoPermissionType": "ImplicitDeny",
"PolicyType": "DlpSend"
}
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。