应用管理
本文列出了应用管理相关的所有 OpenAPI 及其请求参数、返回参数。
创建应用
sofa.apigateway.app.create 用于创建一个应用。
请求参数
名称 | 类型 | 是否必填 | 示例 | 描述 |
param | AppInfoVO | 是 | param | |
tenant_id | STRING | 是 | TSCPDICNT | 租户标识 |
workspace_id | STRING | 是 | default | 工作空间标识 |
返回参数
名称 | 类型 | 示例 | 描述 |
data | AppInfoVO | - | data |
代码示例
请求示例
{
"param":{
"app_type":"STANDARD",
"app_name":"app3",
},
"tenant_id":"JADDGOCN",
"workspace_id":"antdemo"
}返回示例
{
"data":{
"tenant_id":"JADDGOCN",
"workspace_id":"antdemo",
"app_name":"app3",
"app_type":"STANDARD",
"authentication_config":{
"secret_key":"5790AHAxbUjxXMEzMFV74l6wtzZH****",
"authentication_type":"SECRET"
},
"app_id":"TGcdFd3i1v4EOUXD",
"operator":""
},
"result_code":"OK"
}删除应用
sofa.apigateway.app.delete 用于删除指定 APPID 的应用。
请求参数
名称 | 类型 | 是否必填 | 示例 | 描述 |
app_id | STRING | 是 | app_id1 | App标识 |
tenant_id | STRING | 是 | TSCPDICNT | 租户标识 |
workspace_id | STRING | 是 | default | 工作空间标识 |
返回参数
名称 | 类型 | 示例 | 描述 |
data | BOOLEAN | true, false | data |
代码示例
请求示例
{
"app_id":"UfBAJ5bA0nJMSTm9",
"tenant_id":"JADDGOCN",
"workspace_id":"antdemo"
}返回示例
{
"data":true,
"result_code":"OK"
}更新应用
sofa.apigateway.app.update 用于更新应用信息。
请求参数
名称 | 类型 | 是否必填 | 示例 | 描述 |
param | AppInfoVO | 否 | - | param |
tenant_id | STRING | 是 | TSCPDICNT | 租户标识 |
workspace_id | STRING | 是 | default | 工作空间标识 |
返回参数
名称 | 类型 | 示例 | 描述 |
data | BOOLEAN | true, false | data |
代码示例
请求示例
{
"param":{
"app_type":"STANDARD",
"app_name":"app1",
"description":"abc",
"app_id":"uOQQqaGBYif5oChg"
},
"tenant_id":"JADDGOCN",
"workspace_id":"antdemo"
}返回示例
{
"data":true,
"result_code":"OK"
}通过 ID 查询应用
sofa.apigateway.app.get 用于查询指定 APPID 的应用信息。
请求参数
名称 | 类型 | 是否必填 | 示例 | 描述 |
app_id | STRING | 是 | 123 | APPID |
tenant_id | STRING | 是 | TSCPDICNT | 租户标识 |
workspace_id | STRING | 是 | default | 工作空间标识 |
返回参数
名称 | 类型 | 示例 | 描述 |
data | AppInfoVO | true, false | data |
代码示例
请求示例
{
"app_id":"uOQQqaGBYif5oChg",
"tenant_id":"JADDGOCN",
"workspace_id":"antdemo"
}返回示例
{
"data":{
"tenant_id":"JADDGOCN",
"gmt_create":"2020-03-25 16:38:18",
"workspace_id":"antdemo",
"app_name":"app1",
"app_type":"STANDARD",
"api_count":1,
"description":"abc",
"authentication_config":{
"secret_key":"1KxGmLMpBQxqZAkZJXZBwObHCmSl****",
"authentication_type":"SECRET"
},
"gmt_modified":"2020-03-27 10:09:28",
"app_id":"uOQQqaGBYif5oChg",
"operator":""
},
"result_code":"OK"
}查询应用分页列表
sofa.apigateway.app.list 用于查询应用的分页列表。
请求参数
名称 | 类型 | 是否必填 | 示例 | 描述 |
param | AppInfoQueryVO | 否 | - | param |
tenant_id | STRING | 是 | TSCPDICNT | 租户标识 |
workspace_id | STRING | 是 | default | 工作空间标识 |
返回参数
名称 | 类型 | 示例 | 描述 |
data | AppInfoPagedListVO | data |
代码示例
请求示例
{
"param":{
"page_info":{
"page_size":10,
"page_index":1
},
"query":{
"app_id":null
}
},
"tenant_id":"JADDGOCN",
"workspace_id":"antdemo"
}返回示例
{
"data":{
"page_info":{
"total":2,
"page_index":1,
"page_size":10
},
"list":[
{
"gmtModified":"2020-03-27 10:09:28",
"appName":"app1",
"appType":"MPAAS",
"appId":"uOQQqaGBYif5oChg",
"tenantId":"JADDGOCN",
"apiCount":1,
"description":"abc",
"gmtCreate":"2020-03-25 16:38:18",
"operator":"",
"workspaceId":"antdemo"
},
{
"gmtModified":"2020-03-27 10:02:04",
"appName":"app4",
"appType":"MPAAS",
"appId":"mpaas_TGcdFd3i1v4EOUXD",
"tenantId":"JADDGOCN",
"gmtCreate":"2020-03-27 10:02:04",
"operator":"",
"workspaceId":"antdemo"
}
]
},
"result_code":"OK"
}查询应用列表
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 |
代码示例
请求示例
{
"param":{
"page_info":{
"page_size":10,
"page_index":1
},
"query":{
"app_id":null
}
},
"tenant_id":"JADDGOCN",
"workspace_id":"antdemo"
}返回示例
{
"data":[
{
"gmtModified":"2020-03-27 10:09:28",
"appName":"app1",
"appType":"MPAAS",
"appId":"uOQQqaGBYif5oChg",
"tenantId":"JADDGOCN",
"apiCount":1,
"description":"abc",
"gmtCreate":"2020-03-25 16:38:18",
"operator":"",
"workspaceId":"antdemo"
},
{
"gmtModified":"2020-03-27 10:02:04",
"appName":"app4",
"appType":"MPAAS",
"appId":"mpaas_TGcdFd3i1v4EOUXD",
"tenantId":"JADDGOCN",
"gmtCreate":"2020-03-27 10:02:04",
"operator":"",
"workspaceId":"antdemo"
}
],
"result_code":"OK"
}通过 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 |
代码示例
请求示例
{
"param":{
"page_info":{
"page_size":10,
"page_index":1
},
"query":{
"api_name":null
}
},
"app_id":"uOQQqaGBYif5oChg",
"tenant_id":"JADDGOCN",
"workspace_id":"antdemo"
}返回示例
{
"data":{
"page_info":{
"total":1,
"page_index":1,
"page_size":10
},
"list":[
{
"apiName":"test_aaaa",
"gmtModified":"2020-03-26 20:26:01",
"functionName":"fsdfsdf",
"authAppCount":2,
"gmtCreate":"2020-03-25 15:06:29",
"timeout":3000,
"operator":"",
"apiGroupId":"dumebnn9gbnyy02y",
"downstreamProtocol":"SOFA",
"domainName":"dumebnn9gbnyy02y.apigateway.inc.alipay.net",
"apiGroupName":"test_aalq",
"tenantId":"JADDGOCN",
"operationType":"asdfasdf.asdfasdf",
"contentType":"application/json",
"upstreamType":"NONE",
"apiId":"h4ZWfWe9anCJn4Tye3tPMiGJZJ2PeGWq",
"apiStatus":"CLOSED",
"workspaceId":"antdemo"
}
]
},
"result_code":"OK"
}通过 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 |
代码示例
请求示例
{
"param":{
"page_info":{
"page_size":10,
"page_index":1
},
"query":{
"api_name":null
}
},
"app_id":"uOQQqaGBYif5oChg",
"tenant_id":"JADDGOCN",
"workspace_id":"antdemo"
}返回示例
{
"data":[
{
"apiName":"test_aaaa",
"gmtModified":"2020-03-26 20:26:01",
"functionName":"fsdfsdf",
"authAppCount":2,
"gmtCreate":"2020-03-25 15:06:29",
"timeout":3000,
"operator":"",
"apiGroupId":"dumebnn9gbnyy02y",
"downstreamProtocol":"SOFA",
"tenantId":"JADDGOCN",
"operationType":"asdfasdf.asdfasdf",
"contentType":"application/json",
"upstreamType":"NONE",
"apiId":"h4ZWfWe9anCJn4Tye3tPMiGJZJ2PeGWq",
"apiStatus":"CLOSED",
"workspaceId":"antdemo"
}
],
"result_code":"OK"
}