API 分組
本文列出了 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 |
代碼示例
請求示例
{
"param":{
"group_name":"apigroup2"
},
"tenant_id":"JADDGOCN",
"workspace_id":"antdemo"
}
返回示例
{
"data":{
"api_group_id":"gjrjknp1s4alzubn",
"tenant_id":"JADDGOCN",
"workspace_id":"antdemo",
"domain_name":"gjrjknp1s4alzubn.apigateway.inc.alipay.net",
"group_name":"apigroup2",
"operator":""
},
"result_code":"OK"
}
刪除 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 |
代碼示例
請求示例
{
"api_group_id":"evrtxymrpxkep6bc",
"tenant_id":"JADDGOCN",
"workspace_id":"antdemo"
}
返回示例
{
"data":true,
"result_code":"OK"
}
更新 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 |
代碼示例
請求示例
{
"param":{
"group_name":"apigroup3",
"api_group_id":"gjrjknp1s4alzubn",
"description":"abcd"
},
"tenant_id":"JADDGOCN",
"workspace_id":"antdemo"
}
返回示例
{
"data":true,
"result_code":"OK"
}
通過 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 |
代碼示例
請求示例
{
"api_group_id":"fifhwqgcsmqo9ycl",
"tenant_id":"JADDGOCN",
"workspace_id":"antdemo"
}
返回示例
{
"data":{
"api_group_id":"fifhwqgcsmqo9ycl",
"tenant_id":"JADDGOCN",
"gmt_create":"2020-03-27 01:51:36",
"workspace_id":"antdemo",
"domain_name":"fifhwqgcsmqo9ycl.apigateway.inc.alipay.net",
"group_name":"apigroup2",
"gmt_modified":"2020-03-27 01:51:36",
"operator":""
},
"result_code":"OK"
}
查詢 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 |
代碼示例
請求示例
{
"param":{
"page_info":{
"order_infos":[
],
"page_index":1,
"page_size":10
}
},
"tenant_id":"JADDGOCN",
"workspace_id":"antdemo"
}
返回示例
{
"data":[
{
"groupName":"apigroup3",
"gmtModified":"2020-03-27 01:58:40",
"apiGroupId":"gjrjknp1s4alzubn",
"domainName":"gjrjknp1s4alzubn.apigateway.inc.alipay.net",
"tenantId":"JADDGOCN",
"description":"abcd",
"gmtCreate":"2020-03-27 01:53:20",
"operator":"",
"workspaceId":"antdemo"
},
{
"groupName":"apigroup2",
"gmtModified":"2020-03-27 01:51:36",
"apiGroupId":"fifhwqgcsmqo9ycl",
"domainName":"fifhwqgcsmqo9ycl.apigateway.inc.alipay.net",
"tenantId":"JADDGOCN",
"gmtCreate":"2020-03-27 01:51:36",
"operator":"",
"workspaceId":"antdemo"
},
{
"groupName":"apigroup1",
"gmtModified":"2020-03-27 01:05:46",
"apiGroupId":"vfaqppj02kv30tx2",
"domainName":"vfaqppj02kv30tx2.apigateway.inc.alipay.net",
"tenantId":"JADDGOCN",
"apiCount":3,
"gmtCreate":"2020-03-25 16:55:03",
"operator":"",
"workspaceId":"antdemo"
},
{
"groupName":"test_aalq",
"gmtModified":"2020-03-26 11:58:29",
"apiGroupId":"dumebnn9gbnyy02y",
"domainName":"dumebnn9gbnyy02y.apigateway.inc.alipay.net",
"tenantId":"JADDGOCN",
"apiCount":3,
"gmtCreate":"2020-03-25 15:06:03",
"operator":"",
"workspaceId":"antdemo"
}
],
"result_code":"OK"
}
查詢 API 分組分頁列表
sofa.apigateway.apigroup.list
用于查詢 API 分組的分頁列表。
請求參數
名稱 | 類型 | 是否必填 | 示例 | 描述 |
param | ApiGroupQueryVO | 否 | param | |
tenant_id | STRING | 是 | TSCPDICNT | tenant_id |
workspace_id | STRING | 是 | default | workspace_id |
返回參數
名稱 | 類型 | 示例 | 描述 |
data | ApiGroupPagedListVO | - | data |
代碼示例
請求示例
{
"param":{
"page_info":{
"order_infos":[
],
"page_index":1,
"page_size":10
}
},
"tenant_id":"JADDGOCN",
"workspace_id":"antdemo"
}
返回示例
{
"data":{
"page_info":{
"total":2,
"page_index":1,
"page_size":10
},
"list":[
{
"groupName":"apigroup3",
"gmtModified":"2020-03-27 01:58:40",
"apiGroupId":"gjrjknp1s4alzubn",
"domainName":"gjrjknp1s4alzubn.apigateway.inc.alipay.net",
"tenantId":"JADDGOCN",
"description":"abcd",
"gmtCreate":"2020-03-27 01:53:20",
"operator":"",
"workspaceId":"antdemo"
},
{
"groupName":"apigroup2",
"gmtModified":"2020-03-27 01:51:36",
"apiGroupId":"fifhwqgcsmqo9ycl",
"domainName":"fifhwqgcsmqo9ycl.apigateway.inc.alipay.net",
"tenantId":"JADDGOCN",
"gmtCreate":"2020-03-27 01:51:36",
"operator":"",
"workspaceId":"antdemo"
}
]
},
"result_code":"OK"
}
通過 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 |
代碼示例
請求示例
{
"param":{
"page_info":{
"page_index":1,
"page_size":10
}
},
"api_group_id":"fifhwqgcsmqo9ycl",
"tenant_id":"JADDGOCN",
"workspace_id":"antdemo"
}
返回示例
{
"data":{
"page_info":{
"total":1,
"page_index":1,
"page_size":10
},
"list":[
{
"charset":"UTF-8",
"apiName":"api-test2",
"gmtModified":"2020-03-27 14:58:34",
"method":"GET",
"sysId":"A3QV9pym9CaVKdLV0gIcQMsGNIplTZwd",
"upstreamPath":"/openapi/apigateway/test/api1",
"routerType":"PATH",
"upstreamProtocol":"HTTP",
"gmtCreate":"2020-03-27 14:12:43",
"timeout":3000,
"operator":"",
"path":"/openapi/apigateway/test/api1",
"apiGroupId":"fifhwqgcsmqo9ycl",
"appType":"STANDARD",
"downstreamProtocol":"HTTP",
"domainName":"fifhwqgcsmqo9ycl.apigateway.inc.alipay.net",
"apiGroupName":"apigroup2",
"tenantId":"JADDGOCN",
"contentType":"application/json",
"upstreamType":"SYSTEM_CLUSTER",
"apiId":"IjiuBaYgvZLz2ODOvRWiQT3OGCqSbDYu",
"apiStatus":"OPENED",
"workspaceId":"antdemo"
}
]
},
"result_code":"OK"
}
通過 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 |
代碼示例
請求示例
{
"param":{
"page_info":{
"page_index":1,
"page_size":10
}
},
"api_group_id":"fifhwqgcsmqo9ycl",
"tenant_id":"JADDGOCN",
"workspace_id":"antdemo"
}
返回示例
{
"data":{
"page_info":{
"total":1,
"page_index":1,
"page_size":10
},
"list":[
{
"charset":"UTF-8",
"apiName":"api-test2",
"gmtModified":"2020-03-27 14:58:34",
"method":"GET",
"sysId":"A3QV9pym9CaVKdLV0gIcQMsGNIplTZwd",
"upstreamPath":"/openapi/apigateway/test/api1",
"routerType":"PATH",
"upstreamProtocol":"HTTP",
"gmtCreate":"2020-03-27 14:12:43",
"timeout":3000,
"operator":"",
"path":"/openapi/apigateway/test/api1",
"apiGroupId":"fifhwqgcsmqo9ycl",
"appType":"STANDARD",
"downstreamProtocol":"HTTP",
"domainName":"fifhwqgcsmqo9ycl.apigateway.inc.alipay.net",
"apiGroupName":"apigroup2",
"tenantId":"JADDGOCN",
"contentType":"application/json",
"upstreamType":"SYSTEM_CLUSTER",
"apiId":"IjiuBaYgvZLz2ODOvRWiQT3OGCqSbDYu",
"apiStatus":"OPENED",
"workspaceId":"antdemo"
}
]
},
"result_code":"OK"
}