全部产品

API 管理

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

本文列出了 API 管理相关的所有 OpenAPI 及其请求参数、返回参数。

创建 API 信息

sofa.apigateway.api.create 用于快速创建一个 API 服务。

请求参数

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

返回参数

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

代码示例

请求示例

  1. {
  2. "param": {
  3. "api_group_id": "fifhwqgcsmqo9ycl",
  4. "api_name": "api-test",
  5. "app_type": "STANDARD",
  6. "path": "/openapi/apigateway/test/api",
  7. "method": "GET",
  8. "content_type": "application/json",
  9. "charset": "UTF-8",
  10. "path_rule": 1,
  11. "upstream_type": "SYSTEM_CLUSTER",
  12. "upstream_protocol": "HTTP",
  13. "upstream_path": "/openapi/apigateway/test/api",
  14. "router_type": "PATH",
  15. "sys_id": "A3QV9pym9CaVKdLV0gIcQMsGNIplTZwd",
  16. "downstream_protocol": "HTTP",
  17. "timeout": 3000,
  18. },
  19. "tenant_id": "JADDGOCN",
  20. "workspace_id": "antdemo"
  21. }

返回示例

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

通过 ID 删除 API

sofa.apigateway.api.delete 用于通过 API 标识删除指定 API。

请求参数

名称 类型 是否必填 示例 描述
api_id STRING 8Amfi67dmE9wpY46 API标识
tenant_id STRING TSCPDICNT 租户标识
workspace_id STRING default 工作空间标识

返回参数

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

代码示例

请求示例

  1. {
  2. "api_id": "p4UXmtfxcjkzAKIi9Zgqzr598oa37fHO",
  3. "tenant_id": "JADDGOCN",
  4. "workspace_id": "antdemo"
  5. }

返回示例

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

更新 API 信息

sofa.apigateway.api.update 用于更新 API 信息。

请求参数

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

返回参数

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

代码示例

请求示例

  1. {
  2. "param": {
  3. "api_group_id": "fifhwqgcsmqo9ycl",
  4. "api_name": "api-test2",
  5. "app_type": "STANDARD",
  6. "path": "/openapi/apigateway/test/api1",
  7. "method": "GET",
  8. "content_type": "application/json",
  9. "charset": "UTF-8",
  10. "path_rule": 1,
  11. "upstream_type": "SYSTEM_CLUSTER",
  12. "upstream_protocol": "HTTP",
  13. "upstream_path": "/openapi/apigateway/test/api",
  14. "router_type": "PATH",
  15. "sys_id": "A3QV9pym9CaVKdLV0gIcQMsGNIplTZwd",
  16. "downstream_protocol": "HTTP",
  17. "timeout": 3000,
  18. "api_id": "IjiuBaYgvZLz2ODOvRWiQT3OGCqSbDYu"
  19. },
  20. "tenant_id": "JADDGOCN",
  21. "workspace_id": "antdemo"
  22. }

返回示例

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

通过 ID 查询 API

sofa.apigateway.api.get 用于通过 API ID 查询获取指定 API 信息。

请求参数

名称 类型 是否必填 示例 描述
api_id STRING 8Amfi67dmE9wpY46 API标识
tenant_id STRING TSCPDICNT 租户标识
workspace_id STRING default 工作空间标识

返回参数

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

代码示例

请求示例

  1. {
  2. "api_id": "IjiuBaYgvZLz2ODOvRWiQT3OGCqSbDYu",
  3. "tenant_id": "JADDGOCN",
  4. "workspace_id": "antdemo"
  5. }

返回示例

  1. {
  2. "data": {
  3. "gmt_create": "2020-03-27 14:12:43",
  4. "tenant_id": "JADDGOCN",
  5. "charset": "UTF-8",
  6. "api_id": "IjiuBaYgvZLz2ODOvRWiQT3OGCqSbDYu",
  7. "app_type": "STANDARD",
  8. "upstream_type": "SYSTEM_CLUSTER",
  9. "gmt_modified": "2020-03-27 14:17:30",
  10. "timeout": 3000,
  11. "operator": "",
  12. "system_cluster": {
  13. "tenant_id": "JADDGOCN",
  14. "gmt_create": "2020-03-27 10:46:33",
  15. "workspace_id": "antdemo",
  16. "sys_id": "A3QV9pym9CaVKdLV0gIcQMsGNIplTZwd",
  17. "upstream_protocol": "HTTP",
  18. "host": [
  19. "192.157.0.3:80",
  20. "192.168.0.3:80"
  21. ],
  22. "sys_name": "sys2",
  23. "api_count": 1,
  24. "sys_type": "URL",
  25. "gmt_modified": "2020-03-27 14:17:30",
  26. "lb_type": "ROUND_ROBIN",
  27. "operator": ""
  28. },
  29. "workspace_id": "antdemo",
  30. "upstream_path": "/openapi/apigateway/test/api1",
  31. "sys_id": "A3QV9pym9CaVKdLV0gIcQMsGNIplTZwd",
  32. "path": "/openapi/apigateway/test/api1",
  33. "domain_name": "fifhwqgcsmqo9ycl.apigateway.inc.alipay.net",
  34. "content_type": "application/json",
  35. "api_group_name": "apigroup2",
  36. "downstream_protocol": "HTTP",
  37. "history_version_list": [],
  38. "method": "GET",
  39. "api_status": "CLOSED",
  40. "api_group_id": "fifhwqgcsmqo9ycl",
  41. "edit_version": {
  42. "gmt_create": "2020-03-27 14:12:43",
  43. "version_no": "20200327141243487-B0XAffhP",
  44. "api_id": "IjiuBaYgvZLz2ODOvRWiQT3OGCqSbDYu",
  45. "gmt_edit": "2020-03-27 14:17:30",
  46. "version_id": "3VdYOmSsKAD07DuvX6EHvsnheXONfF80",
  47. "gmt_modified": "2020-03-27 14:17:30"
  48. },
  49. "upstream_protocol": "HTTP",
  50. "api_name": "api-test2",
  51. "router_type": "PATH"
  52. },
  53. "result_code": "OK"
  54. }

查询 API 列表

sofa.apigateway.api.all 用于快速查询 API 列表。

请求参数

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

返回参数

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

代码示例

请求示例

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

返回示例

  1. {
  2. "data": [
  3. {
  4. "charset": "UTF-8",
  5. "apiName": "api-test2",
  6. "gmtModified": "2020-03-27 14:17:30",
  7. "method": "GET",
  8. "sysId": "A3QV9pym9CaVKdLV0gIcQMsGNIplTZwd",
  9. "upstreamPath": "/openapi/apigateway/test/api1",
  10. "routerType": "PATH",
  11. "upstreamProtocol": "HTTP",
  12. "gmtCreate": "2020-03-27 14:12:43",
  13. "timeout": 3000,
  14. "operator": "",
  15. "path": "/openapi/apigateway/test/api1",
  16. "apiGroupId": "fifhwqgcsmqo9ycl",
  17. "appType": "STANDARD",
  18. "downstreamProtocol": "HTTP",
  19. "tenantId": "JADDGOCN",
  20. "contentType": "application/json",
  21. "upstreamType": "SYSTEM_CLUSTER",
  22. "apiId": "IjiuBaYgvZLz2ODOvRWiQT3OGCqSbDYu",
  23. "apiStatus": "CLOSED",
  24. "workspaceId": "antdemo"
  25. },
  26. {
  27. "charset": "UTF-8",
  28. "apiName": "rrrwe",
  29. "gmtModified": "2020-03-26 11:58:29",
  30. "method": "GET",
  31. "upstreamPath": "/werwer",
  32. "routerType": "HEADER",
  33. "upstreamProtocol": "HTTP",
  34. "gmtCreate": "2020-03-25 15:15:12",
  35. "timeout": 3000,
  36. "operator": "",
  37. "path": "/werwer",
  38. "apiGroupId": "dumebnn9gbnyy02y",
  39. "appType": "STANDARD",
  40. "routerId": "aPdifmIr852vfqE4",
  41. "downstreamProtocol": "HTTP",
  42. "tenantId": "JADDGOCN",
  43. "operationType": "wer.wer",
  44. "contentType": "application/json",
  45. "upstreamType": "SYSTEM_CLUSTER",
  46. "apiId": "1h3WttiKTeTUtZpWn5Xg5P5bu2UBGjrP",
  47. "apiStatus": "CLOSED",
  48. "workspaceId": "antdemo"
  49. }
  50. ],
  51. "result_code": "OK"
  52. }

查询 API 分页列表

sofa.apigateway.api.list 用于快速查询 API 分页列表。

请求参数

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

返回参数

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

代码示例

请求示例

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

返回示例

  1. {
  2. "data": {
  3. "page_info": {
  4. "total": 2,
  5. "page_index": 1,
  6. "page_size": 10
  7. },
  8. "list": [
  9. {
  10. "charset": "UTF-8",
  11. "apiName": "api-test2",
  12. "gmtModified": "2020-03-27 14:17:30",
  13. "method": "GET",
  14. "sysId": "A3QV9pym9CaVKdLV0gIcQMsGNIplTZwd",
  15. "upstreamPath": "/openapi/apigateway/test/api1",
  16. "routerType": "PATH",
  17. "upstreamProtocol": "HTTP",
  18. "gmtCreate": "2020-03-27 14:12:43",
  19. "timeout": 3000,
  20. "operator": "",
  21. "path": "/openapi/apigateway/test/api1",
  22. "apiGroupId": "fifhwqgcsmqo9ycl",
  23. "appType": "STANDARD",
  24. "downstreamProtocol": "HTTP",
  25. "tenantId": "JADDGOCN",
  26. "contentType": "application/json",
  27. "upstreamType": "SYSTEM_CLUSTER",
  28. "apiId": "IjiuBaYgvZLz2ODOvRWiQT3OGCqSbDYu",
  29. "apiStatus": "CLOSED",
  30. "workspaceId": "antdemo"
  31. },
  32. {
  33. "charset": "UTF-8",
  34. "apiName": "rrrwe",
  35. "gmtModified": "2020-03-26 11:58:29",
  36. "method": "GET",
  37. "upstreamPath": "/werwer",
  38. "routerType": "HEADER",
  39. "upstreamProtocol": "HTTP",
  40. "gmtCreate": "2020-03-25 15:15:12",
  41. "timeout": 3000,
  42. "operator": "",
  43. "path": "/werwer",
  44. "apiGroupId": "dumebnn9gbnyy02y",
  45. "appType": "STANDARD",
  46. "routerId": "aPdifmIr852vfqE4",
  47. "downstreamProtocol": "HTTP",
  48. "tenantId": "JADDGOCN",
  49. "operationType": "wer.wer",
  50. "contentType": "application/json",
  51. "upstreamType": "SYSTEM_CLUSTER",
  52. "apiId": "1h3WttiKTeTUtZpWn5Xg5P5bu2UBGjrP",
  53. "apiStatus": "CLOSED",
  54. "workspaceId": "antdemo"
  55. }
  56. ]
  57. },
  58. "result_code": "OK"
  59. }

通过 API ID 查询授权应用列表

sofa.apigateway.api.authapp.all 用于查询指定 API 的所有授权应用列表。

请求参数

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

返回参数

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

代码示例

请求示例

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

返回示例

  1. {
  2. "data": [
  3. {
  4. "gmtModified": "2020-03-25 15:06:51",
  5. "authAppType": "INNER",
  6. "apiCount": 1,
  7. "gmtCreate": "2020-03-25 15:05:42",
  8. "subWorkspaceId": "antdemo",
  9. "operator": "",
  10. "subTenantId": "JADDGOCN",
  11. "appType": "STANDARD",
  12. "subAppInfo": {
  13. "gmtModified": "2020-03-25 15:06:51",
  14. "appName": "test_lq",
  15. "appId": "Oo2llCf0MkkhGtgL",
  16. "tenantId": "JADDGOCN",
  17. "apiCount": 1,
  18. "gmtCreate": "2020-03-25 15:04:30",
  19. "operator": "",
  20. "workspaceId": "antdemo"
  21. },
  22. "authAppInfoId": "H71mhS7Co7CyY6YI",
  23. "authenticationType": "SECRET",
  24. "encryptType": "NONE",
  25. "subAppId": "Oo2llCf0MkkhGtgL"
  26. }
  27. ],
  28. "result_code": "OK"
  29. }

通过 API ID 查询授权应用分页列表

sofa.apigateway.api.authapp.list 用于查询指定 API 的所有授权应用的分页列表。

请求参数

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

返回参数

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

代码示例

请求示例

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

返回示例

  1. {
  2. "data": {
  3. "page_info": {
  4. "total": 1,
  5. "page_index": 1,
  6. "page_size": 10
  7. },
  8. "list": [
  9. {
  10. "gmtModified": "2020-03-25 15:06:51",
  11. "authAppType": "INNER",
  12. "apiCount": 1,
  13. "gmtCreate": "2020-03-25 15:05:42",
  14. "subWorkspaceId": "antdemo",
  15. "operator": "",
  16. "subTenantId": "JADDGOCN",
  17. "appType": "STANDARD",
  18. "subAppInfo": {
  19. "gmtModified": "2020-03-25 15:06:51",
  20. "appName": "test_lq",
  21. "appId": "Oo2llCf0MkkhGtgL",
  22. "tenantId": "JADDGOCN",
  23. "apiCount": 1,
  24. "gmtCreate": "2020-03-25 15:04:30",
  25. "operator": "",
  26. "workspaceId": "antdemo"
  27. },
  28. "authAppInfoId": "H71mhS7Co7CyY6YI",
  29. "authenticationType": "SECRET",
  30. "encryptType": "NONE",
  31. "subAppId": "Oo2llCf0MkkhGtgL"
  32. }
  33. ]
  34. },
  35. "result_code": "OK"
  36. }

API 挂载授权应用

sofa.apigateway.api.authapp.mount 用于挂载指定 API 的授权应用。

请求参数

名称 类型 是否必填 示例 描述
api_id STRING 8Amfi67dmE9wpY46 API 标识
auth_app_info_id_list ARRAY[STRING] - 授权应用标识列表
tenant_id STRING TSCPDICNT 租户标识
workspace_id STRING default 工作空间标识

返回参数

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

代码示例

请求示例

  1. {
  2. "auth_app_info_id_list":[
  3. "hg42jDqSYGREHHKN"
  4. ],
  5. "api_id":"h4ZWfWe9anCJn4Tye3tPMiGJZJ2PeGWq",
  6. "tenant_id":"JADDGOCN",
  7. "workspace_id":"antdemo"
  8. }

返回示例

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

API 解除授权应用

sofa.apigateway.api.authapp.unmount 用于解除绑定指定 API 的授权应用。

请求参数

名称 类型 是否必填 示例 描述
api_id STRING api_id API 标识
auth_app_info_id_list ARRAY[STRING] - auth_app_info_id_list
tenant_id STRING tenant_id tenant_id
workspace_id STRING workspace_id workspace_id

返回参数

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

代码示例

请求示例

  1. {
  2. "api_id":"h4ZWfWe9anCJn4Tye3tPMiGJZJ2PeGWq",
  3. "auth_app_info_id_list":[
  4. "H71mhS7Co7CyY6YI"
  5. ],
  6. "tenant_id":"JADDGOCN",
  7. "workspace_id":"antdemo"
  8. }

返回示例

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

上线 API

sofa.apigateway.api.online 用于上线指定 API。

请求参数

名称 类型 是否必填 示例 描述
api_id_list ARRAY[STRING] - 要上线的 API 标识列表
online_desc STRING online_desc1 上线描述
tenant_id STRING TSCPDICNT 租户标识
workspace_id STRING default 工作空间标识

返回参数

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

代码示例

请求示例

  1. {
  2. "api_id_list":[
  3. "xN0YItcXFg9Ny6BRLFXaFv4fGHjt24P2"
  4. ],
  5. "tenant_id":"JADDGOCN",
  6. "workspace_id":"antdemo"
  7. }

返回示例

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

下线 API

sofa.apigateway.api.offline 用于下线一个 API 服务。

请求参数

名称 类型 是否必填 示例 描述
api_id_list ARRAY[STRING] - 要上线的 API 标识列表
offline_desc STRING offline_desc1 下线描述
tenant_id STRING TSCPDICNT 租户标识
workspace_id STRING default 工作空间标识

返回参数

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

代码示例

请求示例

  1. {
  2. "api_id_list":[
  3. "h4ZWfWe9anCJn4Tye3tPMiGJZJ2PeGWq"
  4. ],
  5. "tenant_id":"JADDGOCN",
  6. "workspace_id":"antdemo"
  7. }

返回示例

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

获取指定版本的 API

sofa.apigateway.api.versionapi.get 用于查询获取指定版本的 API 信息。

请求参数

名称 类型 是否必填 示例 描述
api_id STRING api_id API 标识
tenant_id STRING tenant_id 租户 ID
version_id STRING version_id 版本号
workspace_id STRING workspace_id 工作空间 ID

返回参数

名称 类型 示例 描述
data ApiInfoVO data

代码示例

请求示例

  1. {
  2. "api_id":"IjiuBaYgvZLz2ODOvRWiQT3OGCqSbDYu",
  3. "version_id":"3VdYOmSsKAD07DuvX6EHvsnheXONfF80",
  4. "tenant_id":"JADDGOCN",
  5. "workspace_id":"antdemo"
  6. }

返回示例

  1. {
  2. "data": {
  3. "gmt_create": "2020-03-27 14:12:43",
  4. "tenant_id": "JADDGOCN",
  5. "charset": "UTF-8",
  6. "api_id": "IjiuBaYgvZLz2ODOvRWiQT3OGCqSbDYu",
  7. "app_type": "STANDARD",
  8. "method": "GET",
  9. "upstream_type": "SYSTEM_CLUSTER",
  10. "api_status": "CLOSED",
  11. "gmt_modified": "2020-03-27 14:17:30",
  12. "timeout": 3000,
  13. "operator": "",
  14. "system_cluster": {
  15. "tenant_id": "JADDGOCN",
  16. "gmt_create": "2020-03-27 10:46:33",
  17. "workspace_id": "antdemo",
  18. "sys_id": "A3QV9pym9CaVKdLV0gIcQMsGNIplTZwd",
  19. "upstream_protocol": "HTTP",
  20. "host": [
  21. "192.157.1.3:80",
  22. "192.168.2.3:80"
  23. ],
  24. "sys_name": "sys2",
  25. "api_count": 1,
  26. "sys_type": "URL",
  27. "gmt_modified": "2020-03-27 14:17:30",
  28. "lb_type": "ROUND_ROBIN",
  29. "operator": ""
  30. },
  31. "upstream_path": "/openapi/apigateway/test/api1",
  32. "api_group_id": "fifhwqgcsmqo9ycl",
  33. "workspace_id": "antdemo",
  34. "sys_id": "A3QV9pym9CaVKdLV0gIcQMsGNIplTZwd",
  35. "path": "/openapi/apigateway/test/api1",
  36. "domain_name": "fifhwqgcsmqo9ycl.apigateway.inc.alipay.net",
  37. "upstream_protocol": "HTTP",
  38. "content_type": "application/json",
  39. "api_group_name": "apigroup2",
  40. "api_name": "api-test2",
  41. "downstream_protocol": "HTTP",
  42. "router_type": "PATH"
  43. },
  44. "result_code": "OK"
  45. }

更新 API 版本号

sofa.apigateway.api.versionno.update 用于更新一个 API 的版本号。

请求参数

名称 类型 是否必填 示例 描述
api_id STRING 8Amfi67dmE9wpY46 API 标识
tenant_id STRING TSCPDICNT 租户标识
version_no STRING version_no1 版本号
workspace_id STRING default 工作空间标识

返回参数

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

代码示例

请求示例

  1. {
  2. "api_id":"IjiuBaYgvZLz2ODOvRWiQT3OGCqSbDYu",
  3. "version_no":"20200327141243487-B0XAffhP",
  4. "tenant_id":"JADDGOCN",
  5. "workspace_id":"antdemo"
  6. }

返回示例

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

调试 API

sofa.apigateway.test.http.exec 用于对 API 进行调试。

请求参数

名称 类型 是否必填 示例 描述
param ApiTestReqVO - API 调试参数
tenant_id STRING TSCPDICNT 租户标识
workspace_id STRING default 工作空间标识

返回参数

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

查询 API 监控信息

sofa.apigateway.monitor.query 用于查看 API 监控信息。

请求参数

名称 类型 是否必填 示例 描述
param MonitoryRequest - 查询的 API 监控请求参数
tenant_id STRING TSCPDICNT 租户标识
workspace_id STRING default 工作空间标识

返回参数定义

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