1. 接口描述
接口请求域名: cngw.tencentcloudapi.com 。
上传插件前置操作,获取COS相关信息
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:CheckCloudNativeAPIGatewayMCPRouteMatch。 |
| Version | 是 | String | 公共参数,本接口取值:2023-04-18。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| GatewayId | 是 | String | 网关 ID 示例值:gateway-46a97dc8 |
| ServerId | 是 | String | MCP Server ID 示例值:f8d4b985-641f-4010-a202-4559af81df6d |
| ExcludeRouteId | 否 | String | Modify时用于排除自身的Route ID 示例值:791a27f9-0431-4d71-87e3-511a650cc760 |
| HeaderMatch.N | 否 | Array of AIGWHeaderRule | Head匹配规则 |
| Methods.N | 否 | Array of String | http method 示例值:["GET"] |
| Path | 否 | String | 路径 示例值:/mcpserver |
| PathMatchType | 否 | String | path的匹配方式 枚举值:
示例值:Exact |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Result | AIGWMCPRouteCheckResult | 是否冲突 注意:此字段可能返回 null,表示取不到有效值。 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询冲突
输入示例
POST / HTTP/1.1
Host: cngw.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CheckCloudNativeAPIGatewayMCPRouteMatch
<公共请求参数>
{
"GatewayId": "gateway-46a97dc8",
"ServerId": "f8d4b985-641f-4010-a202-4559af81df6d",
"Path": "/mcpserver",
"PathMatchType": "Exact",
"Methods": [
"GET"
],
"HeaderMatch": [
{
"Key": "X-Tenant",
"MatchType": "Exact",
"Value": "tenant-a"
}
],
"ExcludeRouteId": "791a27f9-0431-4d71-87e3-511a650cc760"
}
输出示例
{
"Response": {
"Result": {
"IsConflict": false
},
"RequestId": "17bb3715-d66e-4885-b50b-385e5b55bbef"
}
}
5. 开发者资源
腾讯云 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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| FailedOperation.Cos | FailedOperation.Cos |
| FailedOperation.FailedOperation | FailedOperation.FailedOperation |
| FailedOperation.InternalError | FailedOperation.InternalError |
| FailedOperation.Plugin | FailedOperation.Plugin |
| FailedOperation.Resource | FailedOperation.Resource |
| FailedOperation.Role | FailedOperation.Role |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
| InvalidParameterValue.Action | InvalidParameterValue.Action |
| InvalidParameterValue.BadRequestFormat | InvalidParameterValue.BadRequestFormat |
| InvalidParameterValue.BucketName | InvalidParameterValue.BucketName |
| InvalidParameterValue.Cos | InvalidParameterValue.Cos |
| InvalidParameterValue.CreateError | InvalidParameterValue.CreateError |
| InvalidParameterValue.Description | InvalidParameterValue.Description |
| InvalidParameterValue.GatewayId | InvalidParameterValue.GatewayId |
| InvalidParameterValue.GatewayVersion | InvalidParameterValue.GatewayVersion |
| InvalidParameterValue.InvalidParameterValue | InvalidParameterValue.InvalidParameterValue |
| InvalidParameterValue.KeyNotExist | InvalidParameterValue.KeyNotExist |
| InvalidParameterValue.Name | InvalidParameterValue.Name |
| InvalidParameterValue.ObjectName | InvalidParameterValue.ObjectName |
| InvalidParameterValue.OperationFailed | InvalidParameterValue.OperationFailed |
| InvalidParameterValue.Plugin | InvalidParameterValue.Plugin |
| InvalidParameterValue.QueryError | InvalidParameterValue.QueryError |
| InvalidParameterValue.Region | InvalidParameterValue.Region |
| InvalidParameterValue.ResourceAlreadyExist | InvalidParameterValue.ResourceAlreadyExist |
| InvalidParameterValue.Specification | InvalidParameterValue.Specification |
| InvalidParameterValue.SystemParameter | InvalidParameterValue.SystemParameter |
| InvalidParameterValue.Type | InvalidParameterValue.Type |
| InvalidParameterValue.UpdateError | InvalidParameterValue.UpdateError |
| InvalidParameterValue.ZipFile | InvalidParameterValue.ZipFile |
| OperationDenied | 操作被拒绝。 |
| OperationDenied.LimitExceeded | OperationDenied.LimitExceeded |
| OperationDenied.OperationDenied | OperationDenied.OperationDenied |
| ResourceNotFound.ResourceNotFound | ResourceNotFound.ResourceNotFound |