全部产品

API 分组

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

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

创建 API 分组

sofa.apigateway.apigroup.create 用于快速创建一个 API 分组。

请求参数

名称 类型 是否必填 示例 描述
param ApiGroupVO param
tenant_id STRING TSCPDICNT tenant_id
workspace_id STRING default workspace_id

返回参数

名称 类型 示例 描述
data ApiGroupVO data

代码示例

请求示例

  1. {
  2. "param": {
  3. "group_name": "apigroup2"
  4. },
  5. "tenant_id": "JADDGOCN",
  6. "workspace_id": "antdemo"
  7. }

返回示例

  1. {
  2. "data": {
  3. "api_group_id": "gjrjknp1s4alzubn",
  4. "tenant_id": "JADDGOCN",
  5. "workspace_id": "antdemo",
  6. "domain_name": "gjrjknp1s4alzubn.apigateway.inc.alipay.net",
  7. "group_name": "apigroup2",
  8. "operator": ""
  9. },
  10. "result_code": "OK"
  11. }

删除 API 分组

sofa.apigateway.apigroup.delete 用于删除一个 API 分组。

请求参数

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

返回参数

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

代码示例

请求示例

  1. {
  2. "api_group_id": "evrtxymrpxkep6bc",
  3. "tenant_id": "JADDGOCN",
  4. "workspace_id": "antdemo"
  5. }

返回示例

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

更新 API 分组

sofa.apigateway.apigroup.update 用于更新一个 API 分组的配置信息。

请求参数

名称 类型 是否必填 示例 描述
param ApiGroupVO param
tenant_id STRING TSCPDICNT tenant_id
workspace_id STRING default workspace_id

返回参数

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

代码示例

请求示例

  1. {
  2. "param": {
  3. "group_name": "apigroup3",
  4. "api_group_id": "gjrjknp1s4alzubn",
  5. "description": "abcd"
  6. },
  7. "tenant_id": "JADDGOCN",
  8. "workspace_id": "antdemo"
  9. }

返回示例

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

通过 ID 查询 API 分组

sofa.apigateway.apigroup.get 用于通过指定 API 分组 ID 查询该分组的具体信息。

请求参数

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

返回参数

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

代码示例

请求示例

  1. {
  2. "api_group_id": "fifhwqgcsmqo9ycl",
  3. "tenant_id": "JADDGOCN",
  4. "workspace_id": "antdemo"
  5. }

返回示例

  1. {
  2. "data": {
  3. "api_group_id": "fifhwqgcsmqo9ycl",
  4. "tenant_id": "JADDGOCN",
  5. "gmt_create": "2020-03-27 01:51:36",
  6. "workspace_id": "antdemo",
  7. "domain_name": "fifhwqgcsmqo9ycl.apigateway.inc.alipay.net",
  8. "group_name": "apigroup2",
  9. "gmt_modified": "2020-03-27 01:51:36",
  10. "operator": ""
  11. },
  12. "result_code": "OK"
  13. }

查询 API 分组列表

sofa.apigateway.apigroup.all 用于快速查询所有 API 分组列表。

请求参数

名称 类型 是否必填 示例 描述
param ApiGroupQueryVO - param
tenant_id STRING TSCPDICNT tenant_id
workspace_id STRING default workspace_id

返回参数

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

代码示例

请求示例

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

返回示例

  1. {
  2. "data": [
  3. {
  4. "groupName": "apigroup3",
  5. "gmtModified": "2020-03-27 01:58:40",
  6. "apiGroupId": "gjrjknp1s4alzubn",
  7. "domainName": "gjrjknp1s4alzubn.apigateway.inc.alipay.net",
  8. "tenantId": "JADDGOCN",
  9. "description": "abcd",
  10. "gmtCreate": "2020-03-27 01:53:20",
  11. "operator": "",
  12. "workspaceId": "antdemo"
  13. },
  14. {
  15. "groupName": "apigroup2",
  16. "gmtModified": "2020-03-27 01:51:36",
  17. "apiGroupId": "fifhwqgcsmqo9ycl",
  18. "domainName": "fifhwqgcsmqo9ycl.apigateway.inc.alipay.net",
  19. "tenantId": "JADDGOCN",
  20. "gmtCreate": "2020-03-27 01:51:36",
  21. "operator": "",
  22. "workspaceId": "antdemo"
  23. },
  24. {
  25. "groupName": "apigroup1",
  26. "gmtModified": "2020-03-27 01:05:46",
  27. "apiGroupId": "vfaqppj02kv30tx2",
  28. "domainName": "vfaqppj02kv30tx2.apigateway.inc.alipay.net",
  29. "tenantId": "JADDGOCN",
  30. "apiCount": 3,
  31. "gmtCreate": "2020-03-25 16:55:03",
  32. "operator": "",
  33. "workspaceId": "antdemo"
  34. },
  35. {
  36. "groupName": "test_aalq",
  37. "gmtModified": "2020-03-26 11:58:29",
  38. "apiGroupId": "dumebnn9gbnyy02y",
  39. "domainName": "dumebnn9gbnyy02y.apigateway.inc.alipay.net",
  40. "tenantId": "JADDGOCN",
  41. "apiCount": 3,
  42. "gmtCreate": "2020-03-25 15:06:03",
  43. "operator": "",
  44. "workspaceId": "antdemo"
  45. }
  46. ],
  47. "result_code": "OK"
  48. }

查询 API 分组分页列表

sofa.apigateway.apigroup.list 用于查询 API 分组的分页列表。

请求参数

名称 类型 是否必填 示例 描述
param ApiGroupQueryVO param
tenant_id STRING TSCPDICNT tenant_id
workspace_id STRING default workspace_id

返回参数

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

代码示例

请求示例

  1. {
  2. "param": {
  3. "page_info": {
  4. "order_infos": [],
  5. "page_index": 1,
  6. "page_size": 10
  7. }
  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. "groupName": "apigroup3",
  11. "gmtModified": "2020-03-27 01:58:40",
  12. "apiGroupId": "gjrjknp1s4alzubn",
  13. "domainName": "gjrjknp1s4alzubn.apigateway.inc.alipay.net",
  14. "tenantId": "JADDGOCN",
  15. "description": "abcd",
  16. "gmtCreate": "2020-03-27 01:53:20",
  17. "operator": "",
  18. "workspaceId": "antdemo"
  19. },
  20. {
  21. "groupName": "apigroup2",
  22. "gmtModified": "2020-03-27 01:51:36",
  23. "apiGroupId": "fifhwqgcsmqo9ycl",
  24. "domainName": "fifhwqgcsmqo9ycl.apigateway.inc.alipay.net",
  25. "tenantId": "JADDGOCN",
  26. "gmtCreate": "2020-03-27 01:51:36",
  27. "operator": "",
  28. "workspaceId": "antdemo"
  29. },
  30. ]
  31. },
  32. "result_code": "OK"
  33. }

通过 API 分组 ID 查询 API 列表

sofa.apigateway.apigroup.api.all 用于通过分组 ID 查询该分组下的所有 API 列表。

请求参数

名称 类型 是否必填 示例 描述
api_group_id STRING api_group_id1 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. },
  8. "api_group_id": "fifhwqgcsmqo9ycl",
  9. "tenant_id": "JADDGOCN",
  10. "workspace_id": "antdemo"
  11. }

返回示例

  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": "api-test2",
  12. "gmtModified": "2020-03-27 14:58:34",
  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. "domainName": "fifhwqgcsmqo9ycl.apigateway.inc.alipay.net",
  26. "apiGroupName": "apigroup2",
  27. "tenantId": "JADDGOCN",
  28. "contentType": "application/json",
  29. "upstreamType": "SYSTEM_CLUSTER",
  30. "apiId": "IjiuBaYgvZLz2ODOvRWiQT3OGCqSbDYu",
  31. "apiStatus": "OPENED",
  32. "workspaceId": "antdemo"
  33. }
  34. ]
  35. },
  36. "result_code": "OK"
  37. }

通过 API 分组 ID 查询 API 分页列表

sofa.apigateway.apigroup.api.list 用于通过分组 ID 查询该分组下的 API 分页列表。

请求参数

名称 类型 是否必填 示例 描述
api_group_id STRING api_group_id1 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. },
  8. "api_group_id": "fifhwqgcsmqo9ycl",
  9. "tenant_id": "JADDGOCN",
  10. "workspace_id": "antdemo"
  11. }

返回示例

  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": "api-test2",
  12. "gmtModified": "2020-03-27 14:58:34",
  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. "domainName": "fifhwqgcsmqo9ycl.apigateway.inc.alipay.net",
  26. "apiGroupName": "apigroup2",
  27. "tenantId": "JADDGOCN",
  28. "contentType": "application/json",
  29. "upstreamType": "SYSTEM_CLUSTER",
  30. "apiId": "IjiuBaYgvZLz2ODOvRWiQT3OGCqSbDYu",
  31. "apiStatus": "OPENED",
  32. "workspaceId": "antdemo"
  33. }
  34. ]
  35. },
  36. "result_code": "OK"
  37. }