调用SyncMCPServers API同步Nacos MCP Server至网关-API 网关-阿里云-API 网关(API Gateway)-阿里云帮助中心

同步外部MCP server。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

apig:SyncMCPServers

none

*全部资源

*

无

请求语法

POST /v1/mcp-servers/sync-mcp-server HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
body	object	否	请求 Body。
gatewayId	string	否	网关 ID。	gw-cq7l5s5lhtg***
domainIds	array	否	域名 ID。
	string	否	域名 ID。	d-cr62ts5lhtglnu***
sourceId	string	否	来源 ID。	src-d40mff6m1hkpt84vep60
namespace	string	否	Nacos 命名空间。	default
nacosMcpServers	array<object>	否	本次同步的 Nacos MCP Server 列表，如果包含已同步的 MCP Server，需补充 mcpServerId
	object	否
instanceId	string	否	Nacos 实例 ID。	mse-24afmoioxxx
exposedUriPath	string	否	暴露的 URI 路径，当 protocol 为 SSE 或 StreamableHTTP 且 type 为 RealMCP 时必填	/sse
mcpServerName	string	否	MCP Server 名称	test
protocols	array	否	协议。
	string	否	协议枚举值： SSE : SSE HTTPS : HTTPS StreamableHTTP : StreamableHTTP HTTP : HTTP	SSE
mcpServerId	string	否	MCP Server ID	mcp-d3s8qo6m1hknegofa3bg

返回参数

名称	类型	描述	示例值
	object	Schema of Response
requestId	string	Id of the request	2F46B9E7-67EF-5C8A-BA52-D38D5B32AF2C
code	string	响应码。	Ok
message	string	响应消息	success
data	object	响应数据。
succeedMcpServers	array<object>	同步成功的 MCP Server 列表
	object
mcpServerName	string	MCP Server 名称	mcp-success
protocols	array	协议。
	string	协议	SSE
failedMcpServers	array<object>	同步失败的 MCP Server 列表
	object
mcpServerName	string	MCP Server 名称	mcp-fail
protocols	array	协议
	string	协议。	SSE

示例

正常返回示例

JSON格式

{
  "requestId": "2F46B9E7-67EF-5C8A-BA52-D38D5B32AF2C",
  "code": "Ok",
  "message": "success",
  "data": {
    "succeedMcpServers": [
      {
        "mcpServerName": "mcp-success",
        "protocols": [
          "SSE"
        ]
      }
    ],
    "failedMcpServers": [
      {
        "mcpServerName": "mcp-fail",
        "protocols": [
          "SSE"
        ]
      }
    ]
  }
}

错误码

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

变更历史

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