一、1. 接口描述
创建AI网关MCP Tool
默认接口请求频率限制:20次/秒。
二、2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
| Action | 是 | String | 公共参数,本接口取值:CreateCloudNativeAPIGatewayMCPTool。 |
| Version | 是 | String | 公共参数,本接口取值:2023-04-18。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| GatewayId | 是 | String | 网关实例 id示例值:gateway-99761825 |
| ServerId | 是 | String | MCP Server Id示例值:5483b23c-690f-494b-949c-a2a969e02561 |
| ContentType | 是 | String | 内容类型示例值:application/json |
| Name | 是 | String | 名字示例值:echo_500 |
| Method | 是 | String | 方法枚举值:GET: GETPOST: POSTPUT: PUTDELETE: DELETEPATCH: PATCH示例值:POST |
| Path | 是 | String | 路径示例值:/echo500 |
| DisplayName | 否 | String | 展示名字示例值:获取用户信息 |
| ServiceId | 否 | String | 服务 id示例值:4e141ac6-f0cd-4d35-80f0-75e47f5d56a6 |
| InputParams.N | 否 | Array of CNAPIGwMCPToolParam | 输入 |
| Description | 否 | String | 描述示例值:echo tool for echo_500 |
三、3. 输出参数
| 参数名称 | 类型 | 描述 |
| Result | CNAPIGwCreateCommonResult | 创建结果 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
四、输入示例
POST / HTTP/1.1
Host: cngw.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateCloudNativeAPIGatewayMCPTool
<公共请求参数>
{
"GatewayId": "gateway-99761825",
"ServerId": "5483b23c-690f-494b-949c-a2a969e02561",
"Name": "echo_500",
"Description": "echo tool for echo_500",
"Method": "POST",
"Path": "/echo500",
"ContentType": "application/json",
"InputParams": [
{
"Name": "note",
"Type": "string",
"Required": false,
"Position": "query",
"Description": "optional note"
}
]
}
五、输出示例
{
"Response": {
"Result": {
"Success": true,
"ID": "7fae6228-c9c6-4d8a-9a63-8b4cd678f3f4"
},
"RequestId": "09f1adda-fdfd-4cb7-848d-5d6dfdeb2819"
}
}
六、腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便你从同一入口查询及使用腾讯云提供的所有 API 服务。
七、API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
八、SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
·Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
·Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
·Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
·Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
·Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
·Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
·Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
·Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
九、命令行工具
·Tencent Cloud CLI 3.0
十、6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
| FailedOperation | 操作失败。 |
| FailedOperation.FailedOperation | FailedOperation.FailedOperation |
| FailedOperation.InternalError | FailedOperation.InternalError |
| FailedOperation.Role | FailedOperation.Role |
| FailedOperation.Vpc | FailedOperation.Vpc |
| InternalError | 内部错误。 |
| InternalError.QueryError | InternalError.QueryError |
| InvalidParameterValue.BadRequestFormat | InvalidParameterValue.BadRequestFormat |
| InvalidParameterValue.InvalidParameterValue | InvalidParameterValue.InvalidParameterValue |
| InvalidParameterValue.OperationFailed | InvalidParameterValue.OperationFailed |
| InvalidParameterValue.Region | InvalidParameterValue.Region |
| InvalidParameterValue.ResourceAlreadyExist | InvalidParameterValue.ResourceAlreadyExist |
| InvalidParameterValue.Specification | InvalidParameterValue.Specification |
| InvalidParameterValue.Type | InvalidParameterValue.Type |
| MissingParameter | 缺少参数错误。 |
| ResourceNotFound.InstanceNotFound | ResourceNotFound.InstanceNotFound |
| ResourceNotFound.ResourceNotFound | ResourceNotFound.ResourceNotFound |
| UnauthorizedOperation.CamNoAuth | UnauthorizedOperation.CamNoAuth |
| UnauthorizedOperation.CamPassRoleNotExist | UnauthorizedOperation.CamPassRoleNotExist |
| UnauthorizedOperation.Uin | UnauthorizedOperation.Uin |
| UnauthorizedOperation.UnauthorizedOperation | UnauthorizedOperation.UnauthorizedOperation |