全部产品

系统集群

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

本文列出了系统集群相关的所有 OpenAPI 及其请求参数、返回参数。

创建系统集群

sofa.apigateway.sys.create 用于创建一个后端系统集群。

请求参数

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

返回参数

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

代码示例

请求示例

  1. {
  2. "param": {
  3. "sys_name": "sys2",
  4. "upstream_protocol": "HTTP",
  5. "sys_type": "URL",
  6. "lb_type": "ROUND_ROBIN",
  7. "authentication_type": "SECRET",
  8. "host": [
  9. "192.157.1.3:80",
  10. "192.168.2.3:80"
  11. ]
  12. },
  13. "tenant_id": "JADDGOCN",
  14. "workspace_id": "antdemo"
  15. }

返回示例

  1. {
  2. "data": {
  3. "tenant_id": "JADDGOCN",
  4. "workspace_id": "antdemo",
  5. "sys_id": "bh4ufj0dFgEp5LoZjOJbN3h3y8cWxrZD",
  6. "upstream_protocol": "HTTP",
  7. "host": [
  8. "192.157.1.3:80",
  9. "192.168.2.3:80"
  10. ],
  11. "sys_name": "sys2",
  12. "sys_type": "URL",
  13. "authentication_config": {
  14. "secret_key": "aaOVjo7iU5cFo7YENoPjUgMWgrZhAh6Q",
  15. "access_key": "Kie4pNJj5nGiNAGx",
  16. "authentication_type": "SECRET"
  17. },
  18. "authentication_type": "SECRET",
  19. "lb_type": "ROUND_ROBIN",
  20. "operator": ""
  21. },
  22. "result_code": "OK"
  23. }

删除系统集群

sofa.apigateway.sys.delete 用于快速删除指定 ID 的系统集群。

请求参数

名称 类型 是否必填 示例 描述
sys_id STRING 8Amfi67dmE9wpY46 后端集群标识
tenant_id STRING TSCPDICNT 租户标识
workspace_id STRING default 工作空间标识

返回参数

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

代码示例

请求示例

  1. {
  2. "sys_id": "A3QV9pym9CaVKdLV0gIcQMsGNIplTZwd",
  3. "tenant_id": "JADDGOCN",
  4. "workspace_id": "antdemo"
  5. }

返回示例

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

更新系统集群

sofa.apigateway.sys.update 用于更新一个系统集群的配置信息。

请求参数

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

返回参数

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

代码示例

请求示例

  1. {
  2. "data": {
  3. "sys_name": "sys3",
  4. "upstream_protocol": "HTTP",
  5. "sys_type": "URL",
  6. "lb_type": "ROUND_ROBIN",
  7. "authentication_type": "SECRET",
  8. "host": [
  9. "192.157.1.3:80",
  10. "192.168.2.3:80"
  11. ]
  12. "sys_id": "bh4ufj0dFgEp5LoZjOJbN3h3y8cWxrZD",
  13. },
  14. "tenant_id": "JADDGOCN",
  15. "workspace_id": "antdemo"
  16. }

返回示例

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

通过 ID 查询系统集群

sofa.apigateway.sys.get 用于查询指定 ID 的系统集群。

请求参数

名称 类型 是否必填 示例 描述
sys_id STRING 8Amfi67dmE9wpY46 后端集群标识
tenant_id STRING TSCPDICNT 租户标识
workspace_id STRING default 工作空间标识

返回参数

名称 类型 示例 描述
data SystemClusterVO data

代码示例

请求示例

  1. {
  2. "sys_id": "A3QV9pym9CaVKdLV0gIcQMsGNIplTZwd",
  3. "tenant_id": "JADDGOCN",
  4. "workspace_id": "antdemo"
  5. }

返回示例

  1. {
  2. "data": {
  3. "gmt_create": "2020-03-27 10:46:33",
  4. "tenant_id": "JADDGOCN",
  5. "api_count": 1,
  6. "sys_type": "URL",
  7. "gmt_modified": "2020-03-27 14:17:30",
  8. "authentication_type": "SECRET",
  9. "lb_type": "ROUND_ROBIN",
  10. "operator": "",
  11. "workspace_id": "antdemo",
  12. "sys_id": "A3QV9pym9CaVKdLV0gIcQMsGNIplTZwd",
  13. "upstream_protocol": "HTTP",
  14. "host": [
  15. "192.157.1.3:80",
  16. "192.168.2.3:80"
  17. ],
  18. "sys_name": "sys2",
  19. "authentication_config": {
  20. "secret_key": "vtEnfnU6XNNpI4Wln66OCJd8FRWGgNhv",
  21. "access_key": "YqRIovzEtBjkS6MV",
  22. "authentication_type": "SECRET"
  23. }
  24. },
  25. "result_code": "OK"
  26. }

查询系统集群分页列表

sofa.apigateway.sys.list 用于查询系统集群的分页列表。

请求参数

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

返回参数

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

代码示例

请求示例

  1. {
  2. "param": {
  3. "query": {
  4. "upstream_protocol": "HTTP"
  5. }
  6. },
  7. "tenant_id": "JADDGOCN",
  8. "workspace_id": "antdemo"
  9. }

返回示例

  1. {
  2. "data": [
  3. {
  4. "gmtModified": "2020-03-27 14:17:30",
  5. "sysType": "URL",
  6. "sysId": "A3QV9pym9CaVKdLV0gIcQMsGNIplTZwd",
  7. "host": [
  8. "192.157.1.3:80",
  9. "192.168.2.3:80"
  10. ],
  11. "lbType": "ROUND_ROBIN",
  12. "sysName": "sys2",
  13. "tenantId": "JADDGOCN",
  14. "upstreamProtocol": "HTTP",
  15. "apiCount": 1,
  16. "gmtCreate": "2020-03-27 10:46:33",
  17. "operator": "",
  18. "workspaceId": "antdemo"
  19. },
  20. {
  21. "gmtModified": "2020-03-25 15:14:27",
  22. "sysType": "URL",
  23. "sysId": "cBfmcHFVNMXmTrEWFH4FsZf9wDPLndt8",
  24. "host": [
  25. "123.4.2:80"
  26. ],
  27. "sysName": "ffff",
  28. "tenantId": "JADDGOCN",
  29. "upstreamProtocol": "HTTP",
  30. "apiCount": 1,
  31. "gmtCreate": "2020-03-25 15:14:18",
  32. "operator": "",
  33. "workspaceId": "antdemo"
  34. }
  35. ],
  36. "result_code": "OK"
  37. }

查询系统集群列表

sofa.apigateway.sys.all 用于查询系统集群的所有列表。

请求参数

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

返回参数

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

代码示例

请求示例

  1. {
  2. "param": {
  3. "query": {
  4. "upstream_protocol": "HTTP"
  5. }
  6. },
  7. "tenant_id": "JADDGOCN",
  8. "workspace_id": "antdemo"
  9. }

返回示例

  1. {
  2. "data": [
  3. {
  4. "gmtModified": "2020-03-27 14:17:30",
  5. "sysType": "URL",
  6. "sysId": "A3QV9pym9CaVKdLV0gIcQMsGNIplTZwd",
  7. "host": [
  8. "192.157.1.3:80",
  9. "192.168.2.3:80"
  10. ],
  11. "lbType": "ROUND_ROBIN",
  12. "sysName": "sys2",
  13. "tenantId": "JADDGOCN",
  14. "upstreamProtocol": "HTTP",
  15. "apiCount": 1,
  16. "gmtCreate": "2020-03-27 10:46:33",
  17. "operator": "",
  18. "workspaceId": "antdemo"
  19. },
  20. {
  21. "gmtModified": "2020-03-25 15:14:27",
  22. "sysType": "URL",
  23. "sysId": "cBfmcHFVNMXmTrEWFH4FsZf9wDPLndt8",
  24. "host": [
  25. "123.4.2:80"
  26. ],
  27. "sysName": "ffff",
  28. "tenantId": "JADDGOCN",
  29. "upstreamProtocol": "HTTP",
  30. "apiCount": 1,
  31. "gmtCreate": "2020-03-25 15:14:18",
  32. "operator": "",
  33. "workspaceId": "antdemo"
  34. }
  35. ],
  36. "result_code": "OK"
  37. }

通过系统集群 ID 查询 API 分页列表

sofa.apigateway.sys.api.list 用于查询指定系统集群下的 API 分页列表。

请求参数

名称 类型 是否必填 示例 描述
param ApiInfoQueryVO - param
sys_id STRING 8Amfi67dmE9wpY46 后端集群标识
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. "sys_id": "A3QV9pym9CaVKdLV0gIcQMsGNIplTZwd"
  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": "api-test2",
  12. "gmtModified": "2020-03-27 15:51:48",
  13. "method": "GET",
  14. "sysId": "A3QV9pym9CaVKdLV0gIcQMsGNIplTZwd",
  15. "authAppCount": 1,
  16. "upstreamPath": "/openapi/apigateway/test/api1",
  17. "routerType": "PATH",
  18. "upstreamProtocol": "HTTP",
  19. "gmtCreate": "2020-03-27 14:12:43",
  20. "timeout": 3000,
  21. "operator": "",
  22. "path": "/openapi/apigateway/test/api1",
  23. "apiGroupId": "fifhwqgcsmqo9ycl",
  24. "appType": "STANDARD",
  25. "downstreamProtocol": "HTTP",
  26. "domainName": "fifhwqgcsmqo9ycl.apigateway.inc.alipay.net",
  27. "apiGroupName": "apigroup2",
  28. "tenantId": "JADDGOCN",
  29. "contentType": "application/json",
  30. "upstreamType": "SYSTEM_CLUSTER",
  31. "apiId": "IjiuBaYgvZLz2ODOvRWiQT3OGCqSbDYu",
  32. "apiStatus": "OPENED",
  33. "workspaceId": "antdemo"
  34. }
  35. ]
  36. },
  37. "result_code": "OK"
  38. }

通过系统集群 ID 查询 API 列表

sofa.apigateway.sys.api.all 用于查询指定系统集群下所有的 API 列表。

请求参数

名称 类型 是否必填 示例 描述
param ApiInfoQueryVO - param
sys_id STRING 8Amfi67dmE9wpY46 后端集群标识
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. "sys_id": "A3QV9pym9CaVKdLV0gIcQMsGNIplTZwd"
  12. }

返回示例

  1. {
  2. "data": [
  3. {
  4. "charset": "UTF-8",
  5. "apiName": "api-test2",
  6. "gmtModified": "2020-03-27 15:51:48",
  7. "method": "GET",
  8. "sysId": "A3QV9pym9CaVKdLV0gIcQMsGNIplTZwd",
  9. "authAppCount": 1,
  10. "upstreamPath": "/openapi/apigateway/test/api1",
  11. "routerType": "PATH",
  12. "upstreamProtocol": "HTTP",
  13. "gmtCreate": "2020-03-27 14:12:43",
  14. "timeout": 3000,
  15. "operator": "",
  16. "path": "/openapi/apigateway/test/api1",
  17. "apiGroupId": "fifhwqgcsmqo9ycl",
  18. "appType": "STANDARD",
  19. "downstreamProtocol": "HTTP",
  20. "tenantId": "JADDGOCN",
  21. "contentType": "application/json",
  22. "upstreamType": "SYSTEM_CLUSTER",
  23. "apiId": "IjiuBaYgvZLz2ODOvRWiQT3OGCqSbDYu",
  24. "apiStatus": "OPENED",
  25. "workspaceId": "antdemo"
  26. }
  27. ],
  28. "result_code": "OK"
  29. }