全部产品

路由规则

更新时间:2020-04-21 11:33:47

本文列出了联系方式相关的所有 OpenAPI 及其请求参数、返回参数。

创建路由规则

sofa.apigateway.router.create 用于快速创建一个路由规则。

请求参数

名称 类型 是否必填 示例 描述
param RouterInfoVO - param
tenant_id STRING TSCPDICNT 租户标识
workspace_id STRING default 工作空间标识

返回参数

名称 类型 示例 描述
data RouterInfoVO data

代码示例

请求示例

  1. {
  2. "param": {
  3. "router_name": "router1",
  4. "router_type": "HEADER",
  5. "upstream_protocol": "HTTP",
  6. "router_configs": [
  7. {
  8. "arg_key": "param1",
  9. "match_type": "IN",
  10. "arg_value": "value1",
  11. "sys_id": "cBfmcHFVNMXmTrEWFH4FsZf9wDPLndt8"
  12. }
  13. ]
  14. },
  15. "tenant_id": "JADDGOCN",
  16. "workspace_id": "antdemo"
  17. }

返回示例

  1. {
  2. "data": {
  3. "router_configs": [
  4. {
  5. "sysId": "cBfmcHFVNMXmTrEWFH4FsZf9wDPLndt8",
  6. "argKey": "param1",
  7. "matchType": "IN",
  8. "routerType": "HEADER",
  9. "argValue": "value1"
  10. }
  11. ],
  12. "upstream_protocol": "HTTP",
  13. "router_id": "7SpBBxXzQp8UzRVZ",
  14. "router_name": "router1",
  15. "router_type": "HEADER",
  16. "operator": ""
  17. },
  18. "result_code": "OK"
  19. }

删除路由规则

sofa.apigateway.router.delete 用于快速删除一个指定路由规则。

请求参数

名称 类型 是否必填 示例 描述
router_id STRING 8Amfi67dmE9wpY46 路由规则标识
tenant_id STRING TSCPDICNT 租户标识
workspace_id STRING default 工作空间标识

返回参数

名称 类型 示例 描述
data BOOLEAN true, false data

代码示例

请求示例

  1. {
  2. "router_id": "uY2fA0kL9qf1lbqy",
  3. "tenan_id": "JADDGOCN",
  4. "workspace_id": "antdemo"
  5. }

返回示例

  1. {
  2. "data": true,
  3. "result_code": "OK"
  4. }

更新路由规则

sofa.apigateway.router.update 用于更新一个路由规则信息。

请求参数

名称 类型 是否必填 示例 描述
param RouterInfoVO - param
tenant_id STRING TSCPDICNT 租户标识
workspace_id STRING default 工作空间标识

返回参数

名称 类型 示例 描述
data BOOLEAN true, false data

代码示例

请求示例

  1. {
  2. "param": {
  3. "router_name": "router3",
  4. "router_type": "HEADER",
  5. "upstream_protocol": "HTTP",
  6. "router_id": "uY2fA0kL9qf1lbqy",
  7. "router_configs": [
  8. {
  9. "arg_key": "param1",
  10. "weight": null,
  11. "match_type": "IN",
  12. "arg_value": "value1",
  13. "sys_id": "cBfmcHFVNMXmTrEWFH4FsZf9wDPLndt8"
  14. }
  15. ]
  16. },
  17. "tenant_id": "JADDGOCN",
  18. "workspace_id": "antdemo"
  19. }

返回示例

  1. {
  2. "data": true,
  3. "result_code": "OK"
  4. }

通过 ID 查询路由规则

sofa.apigateway.router.get 用于查询指定路由规则的配置信息。

请求参数

名称 类型 是否必填 示例 描述
router_id STRING 8Amfi67dmE9wpY46 路由规则标识
tenant_id STRING TSCPDICNT 租户标识
workspace_id STRING default 工作空间标识

返回参数

名称 类型 示例 描述
data RouterInfoVO - data

代码示例

请求示例

  1. {
  2. "router_id": "7SpBBxXzQp8UzRVZ",
  3. "tenant_id": "JADDGOCN",
  4. "workspace_id": "antdemo"
  5. }

返回示例

  1. {
  2. "data": {
  3. "gmt_create": "2020-03-27 02:14:18",
  4. "router_configs": [
  5. {
  6. "systemCluster": {
  7. "gmtModified": "2020-03-25 15:14:27",
  8. "sysType": "URL",
  9. "sysId": "cBfmcHFVNMXmTrEWFH4FsZf9wDPLndt8",
  10. "host": [
  11. "123.4.2:80"
  12. ],
  13. "sysName": "ffff",
  14. "tenantId": "JADDGOCN",
  15. "upstreamProtocol": "HTTP",
  16. "apiCount": 1,
  17. "gmtCreate": "2020-03-25 15:14:18",
  18. "operator": "",
  19. "workspaceId": "antdemo"
  20. },
  21. "sysId": "cBfmcHFVNMXmTrEWFH4FsZf9wDPLndt8",
  22. "argKey": "param1",
  23. "matchType": "IN",
  24. "routerType": "HEADER",
  25. "argValue": "value1"
  26. }
  27. ],
  28. "upstream_protocol": "HTTP",
  29. "router_id": "7SpBBxXzQp8UzRVZ",
  30. "router_name": "router2",
  31. "gmt_modified": "2020-03-27 02:14:18",
  32. "router_type": "HEADER",
  33. "operator": ""
  34. },
  35. "result_code": "OK"
  36. }

查询路由信息列表

sofa.apigateway.router.all 用于查询所有路由信息。

请求参数

名称 类型 是否必填 示例 描述
param RouterInfoQueryVO - param
tenant_id STRING TSCPDICNT 租户标识
workspace_id STRING default 工作空间标识

返回参数

名称 类型 示例 描述
data ARRAY[RouterInfoVO] - data

代码示例

请求示例

  1. {
  2. "param": {
  3. "page_info": {
  4. "page_index": 1,
  5. "page_size": 10
  6. },
  7. "query": {
  8. "router_name": null
  9. }
  10. },
  11. "tenant_id": "JADDGOCN",
  12. "workspace_id": "antdemo"
  13. }

返回示例

  1. {
  2. "data": [
  3. {
  4. "gmtModified": "2020-03-27 02:14:18",
  5. "routerName": "router2",
  6. "routerId": "7SpBBxXzQp8UzRVZ",
  7. "routerType": "HEADER",
  8. "upstreamProtocol": "HTTP",
  9. "gmtCreate": "2020-03-27 02:14:18",
  10. "operator": ""
  11. },
  12. {
  13. "gmtModified": "2020-03-26 11:58:29",
  14. "routerName": "rrrr",
  15. "routerId": "aPdifmIr852vfqE4",
  16. "routerType": "HEADER",
  17. "upstreamProtocol": "HTTP",
  18. "apiCount": 1,
  19. "gmtCreate": "2020-03-25 15:15:08",
  20. "operator": ""
  21. }
  22. ],
  23. "result_code": "OK"
  24. }

查询路由规则分页列表

sofa.apigateway.router.list 用于查询路由规则的分页列表。

请求参数

名称 类型 是否必填 示例 描述
param RouterInfoQueryVO - param
tenant_id STRING TSCPDICNT 租户标识
workspace_id STRING default 工作空间标识

返回参数

名称 类型 示例 描述
data RouterInfoPagedListVO - data

代码示例

请求示例

  1. {
  2. "param": {
  3. "page_info": {
  4. "page_index": 1,
  5. "page_size": 10
  6. },
  7. "query": {
  8. "router_name": null
  9. }
  10. },
  11. "tenant_id": "JADDGOCN",
  12. "workspace_id": "antdemo"
  13. }

返回示例

  1. {
  2. "data": {
  3. "page_info": {
  4. "total": 2,
  5. "page_index": 1,
  6. "page_size": 10
  7. },
  8. "list": [
  9. {
  10. "gmtModified": "2020-03-27 02:14:18",
  11. "routerName": "router2",
  12. "routerId": "7SpBBxXzQp8UzRVZ",
  13. "routerType": "HEADER",
  14. "upstreamProtocol": "HTTP",
  15. "gmtCreate": "2020-03-27 02:14:18",
  16. "operator": ""
  17. },
  18. {
  19. "gmtModified": "2020-03-26 11:58:29",
  20. "routerName": "rrrr",
  21. "routerId": "aPdifmIr852vfqE4",
  22. "routerType": "HEADER",
  23. "upstreamProtocol": "HTTP",
  24. "apiCount": 1,
  25. "gmtCreate": "2020-03-25 15:15:08",
  26. "operator": ""
  27. }
  28. ]
  29. },
  30. "result_code": "OK"
  31. }

通过路由规则 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

代码示例

请求示例

  1. {
  2. "param": {
  3. "page_info": {
  4. "page_size": 10,
  5. "page_index": 1
  6. },
  7. "query": {
  8. "api_name": null
  9. }
  10. },
  11. "router_id": "aPdifmIr852vfqE4"
  12. }

返回示例

  1. {
  2. "data": {
  3. "page_info": {
  4. "total": 1,
  5. "page_index": 1,
  6. "page_size": 10
  7. },
  8. "list": [
  9. {
  10. "charset": "UTF-8",
  11. "apiName": "rrrwe",
  12. "gmtModified": "2020-03-26 11:58:29",
  13. "method": "GET",
  14. "upstreamPath": "/werwer",
  15. "routerType": "HEADER",
  16. "upstreamProtocol": "HTTP",
  17. "gmtCreate": "2020-03-25 15:15:12",
  18. "timeout": 3000,
  19. "operator": "",
  20. "path": "/werwer",
  21. "apiGroupId": "dumebnn9gbnyy02y",
  22. "appType": "STANDARD_AND_MPAAS",
  23. "routerId": "aPdifmIr852vfqE4",
  24. "downstreamProtocol": "HTTP",
  25. "domainName": "dumebnn9gbnyy02y.apigateway.inc.alipay.net",
  26. "apiGroupName": "test_aalq",
  27. "tenantId": "JADDGOCN",
  28. "operationType": "wer.wer",
  29. "contentType": "application/json",
  30. "upstreamType": "SYSTEM_CLUSTER",
  31. "apiId": "1h3WttiKTeTUtZpWn5Xg5P5bu2UBGjrP",
  32. "apiStatus": "CLOSED",
  33. "workspaceId": "antdemo"
  34. }
  35. ]
  36. },
  37. "result_code": "OK"
  38. }

通过路由规则 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

代码示例

请求示例

  1. {
  2. "param": {
  3. "page_info": {
  4. "page_size": 10,
  5. "page_index": 1
  6. },
  7. "query": {
  8. "api_name": null
  9. }
  10. },
  11. "router_id": "aPdifmIr852vfqE4"
  12. }

返回示例

  1. {
  2. "data": [
  3. {
  4. "charset": "UTF-8",
  5. "apiName": "rrrwe",
  6. "gmtModified": "2020-03-26 11:58:29",
  7. "method": "GET",
  8. "upstreamPath": "/werwer",
  9. "routerType": "HEADER",
  10. "upstreamProtocol": "HTTP",
  11. "gmtCreate": "2020-03-25 15:15:12",
  12. "timeout": 3000,
  13. "operator": "",
  14. "path": "/werwer",
  15. "apiGroupId": "dumebnn9gbnyy02y",
  16. "appType": "STANDARD_AND_MPAAS",
  17. "routerId": "aPdifmIr852vfqE4",
  18. "downstreamProtocol": "HTTP",
  19. "tenantId": "JADDGOCN",
  20. "operationType": "wer.wer",
  21. "contentType": "application/json",
  22. "upstreamType": "SYSTEM_CLUSTER",
  23. "apiId": "1h3WttiKTeTUtZpWn5Xg5P5bu2UBGjrP",
  24. "apiStatus": "CLOSED",
  25. "workspaceId": "antdemo"
  26. }
  27. ],
  28. "result_code": "OK"
  29. }