路由规则
本文列出了联系方式相关的所有 OpenAPI 及其请求参数、返回参数。
创建路由规则
sofa.apigateway.router.create 用于快速创建一个路由规则。
请求参数
名称 | 类型 | 是否必填 | 示例 | 描述 |
param | RouterInfoVO | 是 | - | param |
tenant_id | STRING | 是 | TSCPDICNT | 租户标识 |
workspace_id | STRING | 是 | default | 工作空间标识 |
返回参数
名称 | 类型 | 示例 | 描述 |
data | RouterInfoVO | data |
代码示例
请求示例
{
"param":{
"router_name":"router1",
"router_type":"HEADER",
"upstream_protocol":"HTTP",
"router_configs":[
{
"arg_key":"param1",
"match_type":"IN",
"arg_value":"value1",
"sys_id":"cBfmcHFVNMXmTrEWFH4FsZf9wDPLndt8"
}
]
},
"tenant_id":"JADDGOCN",
"workspace_id":"antdemo"
}返回示例
{
"data":{
"router_configs":[
{
"sysId":"cBfmcHFVNMXmTrEWFH4FsZf9wDPLndt8",
"argKey":"param1",
"matchType":"IN",
"routerType":"HEADER",
"argValue":"value1"
}
],
"upstream_protocol":"HTTP",
"router_id":"7SpBBxXzQp8UzRVZ",
"router_name":"router1",
"router_type":"HEADER",
"operator":""
},
"result_code":"OK"
}删除路由规则
sofa.apigateway.router.delete 用于快速删除一个指定路由规则。
请求参数
名称 | 类型 | 是否必填 | 示例 | 描述 |
router_id | STRING | 是 | 8Amfi67dmE9wpY46 | 路由规则标识 |
tenant_id | STRING | 是 | TSCPDICNT | 租户标识 |
workspace_id | STRING | 是 | default | 工作空间标识 |
返回参数
名称 | 类型 | 示例 | 描述 |
data | BOOLEAN | true, false | data |
代码示例
请求示例
{
"router_id":"uY2fA0kL9qf1lbqy",
"tenan_id":"JADDGOCN",
"workspace_id":"antdemo"
}返回示例
{
"data":true,
"result_code":"OK"
}更新路由规则
sofa.apigateway.router.update 用于更新一个路由规则信息。
请求参数
名称 | 类型 | 是否必填 | 示例 | 描述 |
param | RouterInfoVO | 否 | - | param |
tenant_id | STRING | 是 | TSCPDICNT | 租户标识 |
workspace_id | STRING | 是 | default | 工作空间标识 |
返回参数
名称 | 类型 | 示例 | 描述 |
data | BOOLEAN | true, false | data |
代码示例
请求示例
{
"param":{
"router_name":"router3",
"router_type":"HEADER",
"upstream_protocol":"HTTP",
"router_id":"uY2fA0kL9qf1lbqy",
"router_configs":[
{
"arg_key":"param1",
"weight":null,
"match_type":"IN",
"arg_value":"value1",
"sys_id":"cBfmcHFVNMXmTrEWFH4FsZf9wDPLndt8"
}
]
},
"tenant_id":"JADDGOCN",
"workspace_id":"antdemo"
}返回示例
{
"data":true,
"result_code":"OK"
}通过 ID 查询路由规则
sofa.apigateway.router.get 用于查询指定路由规则的配置信息。
请求参数
名称 | 类型 | 是否必填 | 示例 | 描述 |
router_id | STRING | 是 | 8Amfi67dmE9wpY46 | 路由规则标识 |
tenant_id | STRING | 是 | TSCPDICNT | 租户标识 |
workspace_id | STRING | 是 | default | 工作空间标识 |
返回参数
名称 | 类型 | 示例 | 描述 |
data | RouterInfoVO | - | data |
代码示例
请求示例
{
"router_id":"7SpBBxXzQp8UzRVZ",
"tenant_id":"JADDGOCN",
"workspace_id":"antdemo"
}返回示例
{
"data":{
"gmt_create":"2020-03-27 02:14:18",
"router_configs":[
{
"systemCluster":{
"gmtModified":"2020-03-25 15:14:27",
"sysType":"URL",
"sysId":"cBfmcHFVNMXmTrEWFH4FsZf9wDPLndt8",
"host":[
"123.4.2:80"
],
"sysName":"ffff",
"tenantId":"JADDGOCN",
"upstreamProtocol":"HTTP",
"apiCount":1,
"gmtCreate":"2020-03-25 15:14:18",
"operator":"",
"workspaceId":"antdemo"
},
"sysId":"cBfmcHFVNMXmTrEWFH4FsZf9wDPLndt8",
"argKey":"param1",
"matchType":"IN",
"routerType":"HEADER",
"argValue":"value1"
}
],
"upstream_protocol":"HTTP",
"router_id":"7SpBBxXzQp8UzRVZ",
"router_name":"router2",
"gmt_modified":"2020-03-27 02:14:18",
"router_type":"HEADER",
"operator":""
},
"result_code":"OK"
}查询路由信息列表
sofa.apigateway.router.all 用于查询所有路由信息。
请求参数
名称 | 类型 | 是否必填 | 示例 | 描述 |
param | RouterInfoQueryVO | 否 | - | param |
tenant_id | STRING | 是 | TSCPDICNT | 租户标识 |
workspace_id | STRING | 是 | default | 工作空间标识 |
返回参数
名称 | 类型 | 示例 | 描述 |
data | ARRAY[RouterInfoVO] | - | data |
代码示例
请求示例
{
"param":{
"page_info":{
"page_index":1,
"page_size":10
},
"query":{
"router_name":null
}
},
"tenant_id":"JADDGOCN",
"workspace_id":"antdemo"
}返回示例
{
"data":[
{
"gmtModified":"2020-03-27 02:14:18",
"routerName":"router2",
"routerId":"7SpBBxXzQp8UzRVZ",
"routerType":"HEADER",
"upstreamProtocol":"HTTP",
"gmtCreate":"2020-03-27 02:14:18",
"operator":""
},
{
"gmtModified":"2020-03-26 11:58:29",
"routerName":"rrrr",
"routerId":"aPdifmIr852vfqE4",
"routerType":"HEADER",
"upstreamProtocol":"HTTP",
"apiCount":1,
"gmtCreate":"2020-03-25 15:15:08",
"operator":""
}
],
"result_code":"OK"
}查询路由规则分页列表
sofa.apigateway.router.list 用于查询路由规则的分页列表。
请求参数
名称 | 类型 | 是否必填 | 示例 | 描述 |
param | RouterInfoQueryVO | 否 | - | param |
tenant_id | STRING | 是 | TSCPDICNT | 租户标识 |
workspace_id | STRING | 是 | default | 工作空间标识 |
返回参数
名称 | 类型 | 示例 | 描述 |
data | RouterInfoPagedListVO | - | data |
代码示例
请求示例
{
"param":{
"page_info":{
"page_index":1,
"page_size":10
},
"query":{
"router_name":null
}
},
"tenant_id":"JADDGOCN",
"workspace_id":"antdemo"
}返回示例
{
"data":{
"page_info":{
"total":2,
"page_index":1,
"page_size":10
},
"list":[
{
"gmtModified":"2020-03-27 02:14:18",
"routerName":"router2",
"routerId":"7SpBBxXzQp8UzRVZ",
"routerType":"HEADER",
"upstreamProtocol":"HTTP",
"gmtCreate":"2020-03-27 02:14:18",
"operator":""
},
{
"gmtModified":"2020-03-26 11:58:29",
"routerName":"rrrr",
"routerId":"aPdifmIr852vfqE4",
"routerType":"HEADER",
"upstreamProtocol":"HTTP",
"apiCount":1,
"gmtCreate":"2020-03-25 15:15:08",
"operator":""
}
]
},
"result_code":"OK"
}通过路由规则 ID 查询 API 列表
sofa.apigateway.router.api.all 用于查询使用了特定路有规则的所有 API 列表。
请求参数
名称 | 类型 | 是否必填 | 示例 | 描述 |
param | ApiInfoQueryVO | 否 | - | param |
router_id | STRING | 是 | 8Amfi67dmE9wpY46 | 路由规则ID |
tenant_id | STRING | 是 | TSCPDICNT | 租户标识 |
workspace_id | STRING | 是 | default | 工作空间标识 |
返回参数
名称 | 类型 | 示例 | 描述 |
data | ARRAY[ApiInfoVO] | - | data |
代码示例
请求示例
{
"param":{
"page_info":{
"page_size":10,
"page_index":1
},
"query":{
"api_name":null
}
},
"router_id":"aPdifmIr852vfqE4"
}返回示例
{
"data":{
"page_info":{
"total":1,
"page_index":1,
"page_size":10
},
"list":[
{
"charset":"UTF-8",
"apiName":"rrrwe",
"gmtModified":"2020-03-26 11:58:29",
"method":"GET",
"upstreamPath":"/werwer",
"routerType":"HEADER",
"upstreamProtocol":"HTTP",
"gmtCreate":"2020-03-25 15:15:12",
"timeout":3000,
"operator":"",
"path":"/werwer",
"apiGroupId":"dumebnn9gbnyy02y",
"appType":"STANDARD_AND_MPAAS",
"routerId":"aPdifmIr852vfqE4",
"downstreamProtocol":"HTTP",
"domainName":"dumebnn9gbnyy02y.apigateway.inc.alipay.net",
"apiGroupName":"test_aalq",
"tenantId":"JADDGOCN",
"operationType":"wer.wer",
"contentType":"application/json",
"upstreamType":"SYSTEM_CLUSTER",
"apiId":"1h3WttiKTeTUtZpWn5Xg5P5bu2UBGjrP",
"apiStatus":"CLOSED",
"workspaceId":"antdemo"
}
]
},
"result_code":"OK"
}通过路由规则 ID 查询 API 分页列表
sofa.apigateway.router.api.list 用于查询使用了特定路有规则的 API 分页列表。
请求参数
名称 | 类型 | 是否必填 | 示例 | 描述 |
param | ApiInfoQueryVO | 否 | - | param |
router_id | STRING | 是 | 8Amfi67dmE9wpY46 | 路由规则ID |
tenant_id | STRING | 是 | TSCPDICNT | 租户标识 |
workspace_id | STRING | 是 | default | 工作空间标识 |
返回参数
名称 | 类型 | 示例 | 描述 |
data | ApiInfoPagedListVO | - | data |
代码示例
请求示例
{
"param":{
"page_info":{
"page_size":10,
"page_index":1
},
"query":{
"api_name":null
}
},
"router_id":"aPdifmIr852vfqE4"
}返回示例
{
"data":[
{
"charset":"UTF-8",
"apiName":"rrrwe",
"gmtModified":"2020-03-26 11:58:29",
"method":"GET",
"upstreamPath":"/werwer",
"routerType":"HEADER",
"upstreamProtocol":"HTTP",
"gmtCreate":"2020-03-25 15:15:12",
"timeout":3000,
"operator":"",
"path":"/werwer",
"apiGroupId":"dumebnn9gbnyy02y",
"appType":"STANDARD_AND_MPAAS",
"routerId":"aPdifmIr852vfqE4",
"downstreamProtocol":"HTTP",
"tenantId":"JADDGOCN",
"operationType":"wer.wer",
"contentType":"application/json",
"upstreamType":"SYSTEM_CLUSTER",
"apiId":"1h3WttiKTeTUtZpWn5Xg5P5bu2UBGjrP",
"apiStatus":"CLOSED",
"workspaceId":"antdemo"
}
],
"result_code":"OK"
}