路由在线调试
更新时间 2026-03-23 14:47:35
最近更新时间: 2026-03-23 14:47:35
接口功能介绍
路由在线调试
接口约束
无
URI
POST /cgw/v1/route/debug
路径参数 无
Query参数 无
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 资源池编码 | 7a2828074ef6e32e041a2ef124b19e63 |
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| appId | 否 | String | 授权APP的标识ID | 64b9eb7120587e096d60977d | |
| authType | 否 | String | 认证方式，NOAUTH或者APP，大小写敏感，默认为NOAUTH | APP | |
| routeId | 是 | String | 路由唯一编码 | 64b9eb7120587e096d60977d | |
| gwInstanceId | 是 | String | 实例ID | a4eeaed8d921701f0de44c96fb7ac8c2 | |
| host | 否 | String | 请求域名，不可为空格 | a.com | |
| method | 是 | String | api的匹配方法,GET、POST、PATCH、PUT、DELETE、HEAD、OPTIONS的一种 | GET | |
| protocol | 是 | String | 请求协议类型，http或者https，大小写不敏感 | https | |
| requestBodyType | 否 | String | body请求参数输入类型,当请求方法为POST、PUT、PATCH时允许选择form或者json，默认为form;其他请求方法，为null，不放开body参数. | null or form or json | |
| requestBody | 否 | Object | 路由请求的body参数,以表单的方式交互.当body请求类型的为form时传入 | ParameterVO | |
| requestBodyString | 否 | String | 路由请求的body字串,以编辑窗口展示.当body请求类型的为json时传入 | ||
| requestHeader | 否 | Object | 路由请求的头部参数 | ParameterVO | |
| requestQuery | 否 | Object | 路由请求的query参数 | ParameterVO | |
| uri | 是 | String | 请求路径 | /usr |
表 ParameterVO
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| key | 否 | String | 当传入参数时，KEY不可为null、空串、空格 | v1 | |
| value | 否 | String | 值 | 100 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 接口状态码 | 2000 | |
| code | String | 错误码，异常时非空 | CGW_1001 | |
| returnObj | Object | 返回数据 | ||
| message | String | 异常描述 | success |
表 RouteDebugResultVO
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| request | Object | API/Route调试时的实际请求信息 | RouteDebugRequestInfo | |
| response | String | API/Route调试时的请求结果 | success |
表 RouteDebugRequestInfo
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| body | String | API/Route调试时的请求body | ||
| header | String | API/Route调试时的请求header | ||
| method | String | API/Route调试时的请求方法 | ||
| token | String | API/Route调试时的请求token | ||
| url | String | API/Route调试时的请求url |
枚举参数
无
请求示例
请求url
https://127.0.0.1:8080/cgw/v1/route/debug
请求头header
{
"regionId": "1234567890"
}
请求体body
{
"appId": "a4eeaed8d921701f0de44c96fb7ac8c2",
"authType": "NOAUTH or APP",
"routeId": "64b9eb7120587e096d60977d",
"gwInstanceId": "a4eeaed8d921701f0de44c96fb7ac8c2",
"host": "www.test.com",
"method": "get",
"protocol": "http",
"requestBodyType": "form",
"requestBody": "[{\"key\":\"id\",\"value\":\"21\"},{\"key\":\"id\",\"value\":\"22\"}]",
"requestHeader": "[{\"key\":\"id\",\"value\":\"21\"},{\"key\":\"id\",\"value\":\"22\"}]",
"requestQuery": "[{\"key\":\"id\",\"value\":\"21\"},{\"key\":\"id\",\"value\":\"22\"}]",
"uri": "/apple/count"
}
响应示例
{
"message": "String",
"returnObj": {
"request": {
"body": "String",
"header": "String",
"method": "String",
"token": "String",
"url": "String"
},
"response": "String"
},
"statusCode": 2000
}
状态码
请参考 状态码
错误码
请参考 错误码
