全部产品

应用管理

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

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

创建应用

sofa.apigateway.app.create 用于创建一个应用。

请求参数

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

返回参数

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

代码示例

请求示例

  1. {
  2. "param": {
  3. "app_type": "STANDARD",
  4. "app_name": "app3",
  5. },
  6. "tenant_id": "JADDGOCN",
  7. "workspace_id": "antdemo"
  8. }

返回示例

  1. {
  2. "data": {
  3. "tenant_id": "JADDGOCN",
  4. "workspace_id": "antdemo",
  5. "app_name": "app3",
  6. "app_type": "STANDARD",
  7. "authentication_config": {
  8. "secret_key": "5790AHAxbUjxXMEzMFV74l6wtzZHUzOk",
  9. "authentication_type": "SECRET"
  10. },
  11. "app_id": "TGcdFd3i1v4EOUXD",
  12. "operator": ""
  13. },
  14. "result_code": "OK"
  15. }

删除应用

sofa.apigateway.app.delete 用于删除指定 APPID 的应用。

请求参数

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

返回参数

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

代码示例

请求示例

  1. {
  2. "app_id": "UfBAJ5bA0nJMSTm9",
  3. "tenant_id": "JADDGOCN",
  4. "workspace_id": "antdemo"
  5. }

返回示例

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

更新应用

sofa.apigateway.app.update 用于更新应用信息。

请求参数

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

返回参数

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

代码示例

请求示例

  1. {
  2. "param": {
  3. "app_type": "STANDARD",
  4. "app_name": "app1",
  5. "description": "abc",
  6. "app_id": "uOQQqaGBYif5oChg"
  7. },
  8. "tenant_id": "JADDGOCN",
  9. "workspace_id": "antdemo"
  10. }

返回示例

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

通过 ID 查询应用

sofa.apigateway.app.get 用于查询指定 APPID 的应用信息。

请求参数

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

返回参数

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

代码示例

请求示例

  1. {
  2. "app_id": "uOQQqaGBYif5oChg",
  3. "tenant_id": "JADDGOCN",
  4. "workspace_id": "antdemo"
  5. }

返回示例

  1. {
  2. "data": {
  3. "tenant_id": "JADDGOCN",
  4. "gmt_create": "2020-03-25 16:38:18",
  5. "workspace_id": "antdemo",
  6. "app_name": "app1",
  7. "app_type": "STANDARD",
  8. "api_count": 1,
  9. "description": "abc",
  10. "authentication_config": {
  11. "secret_key": "1KxGmLMpBQxqZAkZJXZBwObHCmSlumbj",
  12. "authentication_type": "SECRET"
  13. },
  14. "gmt_modified": "2020-03-27 10:09:28",
  15. "app_id": "uOQQqaGBYif5oChg",
  16. "operator": ""
  17. },
  18. "result_code": "OK"
  19. }

查询应用分页列表

sofa.apigateway.app.list 用于查询应用的分页列表。

请求参数

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

返回参数

名称 类型 示例 描述
data AppInfoPagedListVO data

代码示例

请求示例

  1. {
  2. "param": {
  3. "page_info": {
  4. "page_size": 10,
  5. "page_index": 1
  6. },
  7. "query": {
  8. "app_id": 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 10:09:28",
  11. "appName": "app1",
  12. "appType": "MPAAS",
  13. "appId": "uOQQqaGBYif5oChg",
  14. "tenantId": "JADDGOCN",
  15. "apiCount": 1,
  16. "description": "abc",
  17. "gmtCreate": "2020-03-25 16:38:18",
  18. "operator": "",
  19. "workspaceId": "antdemo"
  20. },
  21. {
  22. "gmtModified": "2020-03-27 10:02:04",
  23. "appName": "app4",
  24. "appType": "MPAAS",
  25. "appId": "mpaas_TGcdFd3i1v4EOUXD",
  26. "tenantId": "JADDGOCN",
  27. "gmtCreate": "2020-03-27 10:02:04",
  28. "operator": "",
  29. "workspaceId": "antdemo"
  30. }
  31. ]
  32. },
  33. "result_code": "OK"
  34. }

查询应用列表

sofa.apigateway.app.all 用于查询所有的应用列表。

请求参数

名称 类型 是否必填 示例 描述
param AppInfoQueryVO - param
page_info PageInfo - pageInfo
query AppInfoVO - query
tenant_id STRING TSCPDICNT 租户标识
workspace_id STRING default 工作空间标识

返回参数

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

代码示例

请求示例

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

返回示例

  1. {
  2. "data": [
  3. {
  4. "gmtModified": "2020-03-27 10:09:28",
  5. "appName": "app1",
  6. "appType": "MPAAS",
  7. "appId": "uOQQqaGBYif5oChg",
  8. "tenantId": "JADDGOCN",
  9. "apiCount": 1,
  10. "description": "abc",
  11. "gmtCreate": "2020-03-25 16:38:18",
  12. "operator": "",
  13. "workspaceId": "antdemo"
  14. },
  15. {
  16. "gmtModified": "2020-03-27 10:02:04",
  17. "appName": "app4",
  18. "appType": "MPAAS",
  19. "appId": "mpaas_TGcdFd3i1v4EOUXD",
  20. "tenantId": "JADDGOCN",
  21. "gmtCreate": "2020-03-27 10:02:04",
  22. "operator": "",
  23. "workspaceId": "antdemo"
  24. }
  25. ],
  26. "result_code": "OK"
  27. }

通过App ID查询API列表

sofa.apigateway.app.api.all 用于查询指定 APPID 的应用所订阅的所有 API 列表。

请求参数

名称 类型 是否必填 示例 描述
app_id STRING app_id1 应用标识 APPID
param ApiInfoQueryVO - param
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. "app_id": "uOQQqaGBYif5oChg",
  12. "tenant_id": "JADDGOCN",
  13. "workspace_id": "antdemo"
  14. }

返回示例

  1. {
  2. "data": {
  3. "page_info": {
  4. "total": 1,
  5. "page_index": 1,
  6. "page_size": 10
  7. },
  8. "list": [
  9. {
  10. "apiName": "test_aaaa",
  11. "gmtModified": "2020-03-26 20:26:01",
  12. "functionName": "fsdfsdf",
  13. "authAppCount": 2,
  14. "gmtCreate": "2020-03-25 15:06:29",
  15. "timeout": 3000,
  16. "operator": "",
  17. "apiGroupId": "dumebnn9gbnyy02y",
  18. "downstreamProtocol": "SOFA",
  19. "domainName": "dumebnn9gbnyy02y.apigateway.inc.alipay.net",
  20. "apiGroupName": "test_aalq",
  21. "tenantId": "JADDGOCN",
  22. "operationType": "asdfasdf.asdfasdf",
  23. "contentType": "application/json",
  24. "upstreamType": "NONE",
  25. "apiId": "h4ZWfWe9anCJn4Tye3tPMiGJZJ2PeGWq",
  26. "apiStatus": "CLOSED",
  27. "workspaceId": "antdemo"
  28. }
  29. ]
  30. },
  31. "result_code": "OK"
  32. }

通过 APP ID 查询 API 分页列表

sofa.apigateway.app.api.list 用于查询指定 APPID 的应用所订阅的 API 分页列表。

请求参数

名称 类型 是否必填 示例 描述
app_id STRING app_id1 应用标识 APPID
param ApiInfoQueryVO - param
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. "app_id": "uOQQqaGBYif5oChg",
  12. "tenant_id": "JADDGOCN",
  13. "workspace_id": "antdemo"
  14. }

返回示例

  1. {
  2. "data": [
  3. {
  4. "apiName": "test_aaaa",
  5. "gmtModified": "2020-03-26 20:26:01",
  6. "functionName": "fsdfsdf",
  7. "authAppCount": 2,
  8. "gmtCreate": "2020-03-25 15:06:29",
  9. "timeout": 3000,
  10. "operator": "",
  11. "apiGroupId": "dumebnn9gbnyy02y",
  12. "downstreamProtocol": "SOFA",
  13. "tenantId": "JADDGOCN",
  14. "operationType": "asdfasdf.asdfasdf",
  15. "contentType": "application/json",
  16. "upstreamType": "NONE",
  17. "apiId": "h4ZWfWe9anCJn4Tye3tPMiGJZJ2PeGWq",
  18. "apiStatus": "CLOSED",
  19. "workspaceId": "antdemo"
  20. }
  21. ],
  22. "result_code": "OK"
  23. }