路由規(guī)則
本文列出了聯(lián)系方式相關(guān)的所有 OpenAPI 及其請求參數(shù)、返回參數(shù)。
創(chuàng)建路由規(guī)則
sofa.apigateway.router.create
用于快速創(chuàng)建一個路由規(guī)則。
請求參數(shù)
名稱 | 類型 | 是否必填 | 示例 | 描述 |
param | RouterInfoVO | 是 | - | param |
tenant_id | STRING | 是 | TSCPDICNT | 租戶標(biāo)識 |
workspace_id | STRING | 是 | default | 工作空間標(biāo)識 |
返回參數(shù)
名稱 | 類型 | 示例 | 描述 |
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"
}
刪除路由規(guī)則
sofa.apigateway.router.delete
用于快速刪除一個指定路由規(guī)則。
請求參數(shù)
名稱 | 類型 | 是否必填 | 示例 | 描述 |
router_id | STRING | 是 | 8Amfi67dmE9wpY46 | 路由規(guī)則標(biāo)識 |
tenant_id | STRING | 是 | TSCPDICNT | 租戶標(biāo)識 |
workspace_id | STRING | 是 | default | 工作空間標(biāo)識 |
返回參數(shù)
名稱 | 類型 | 示例 | 描述 |
data | BOOLEAN | true, false | data |
代碼示例
請求示例
{
"router_id":"uY2fA0kL9qf1lbqy",
"tenan_id":"JADDGOCN",
"workspace_id":"antdemo"
}
返回示例
{
"data":true,
"result_code":"OK"
}
更新路由規(guī)則
sofa.apigateway.router.update
用于更新一個路由規(guī)則信息。
請求參數(shù)
名稱 | 類型 | 是否必填 | 示例 | 描述 |
param | RouterInfoVO | 否 | - | param |
tenant_id | STRING | 是 | TSCPDICNT | 租戶標(biāo)識 |
workspace_id | STRING | 是 | default | 工作空間標(biāo)識 |
返回參數(shù)
名稱 | 類型 | 示例 | 描述 |
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 查詢路由規(guī)則
sofa.apigateway.router.get
用于查詢指定路由規(guī)則的配置信息。
請求參數(shù)
名稱 | 類型 | 是否必填 | 示例 | 描述 |
router_id | STRING | 是 | 8Amfi67dmE9wpY46 | 路由規(guī)則標(biāo)識 |
tenant_id | STRING | 是 | TSCPDICNT | 租戶標(biāo)識 |
workspace_id | STRING | 是 | default | 工作空間標(biāo)識 |
返回參數(shù)
名稱 | 類型 | 示例 | 描述 |
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
用于查詢所有路由信息。
請求參數(shù)
名稱 | 類型 | 是否必填 | 示例 | 描述 |
param | RouterInfoQueryVO | 否 | - | param |
tenant_id | STRING | 是 | TSCPDICNT | 租戶標(biāo)識 |
workspace_id | STRING | 是 | default | 工作空間標(biāo)識 |
返回參數(shù)
名稱 | 類型 | 示例 | 描述 |
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"
}
查詢路由規(guī)則分頁列表
sofa.apigateway.router.list
用于查詢路由規(guī)則的分頁列表。
請求參數(shù)
名稱 | 類型 | 是否必填 | 示例 | 描述 |
param | RouterInfoQueryVO | 否 | - | param |
tenant_id | STRING | 是 | TSCPDICNT | 租戶標(biāo)識 |
workspace_id | STRING | 是 | default | 工作空間標(biāo)識 |
返回參數(shù)
名稱 | 類型 | 示例 | 描述 |
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"
}
通過路由規(guī)則 ID 查詢 API 列表
sofa.apigateway.router.api.all
用于查詢使用了特定路有規(guī)則的所有 API 列表。
請求參數(shù)
名稱 | 類型 | 是否必填 | 示例 | 描述 |
param | ApiInfoQueryVO | 否 | - | param |
router_id | STRING | 是 | 8Amfi67dmE9wpY46 | 路由規(guī)則ID |
tenant_id | STRING | 是 | TSCPDICNT | 租戶標(biāo)識 |
workspace_id | STRING | 是 | default | 工作空間標(biāo)識 |
返回參數(shù)
名稱 | 類型 | 示例 | 描述 |
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"
}
通過路由規(guī)則 ID 查詢 API 分頁列表
sofa.apigateway.router.api.list
用于查詢使用了特定路有規(guī)則的 API 分頁列表。
請求參數(shù)
名稱 | 類型 | 是否必填 | 示例 | 描述 |
param | ApiInfoQueryVO | 否 | - | param |
router_id | STRING | 是 | 8Amfi67dmE9wpY46 | 路由規(guī)則ID |
tenant_id | STRING | 是 | TSCPDICNT | 租戶標(biāo)識 |
workspace_id | STRING | 是 | default | 工作空間標(biāo)識 |
返回參數(shù)
名稱 | 類型 | 示例 | 描述 |
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"
}