授權應用
本文列出了授權應用相關的 API 及其請求參數、返回參數。
創建授權應用
sofa.apigateway.authapp.create
用于創建一個授權應用。
請求參數
名稱 | 類型 | 是否必填 | 示例 | 描述 |
param | AuthAppInfoVO | 是 | - | param |
tenant_id | STRING | 是 | TSCPDICNT | 租戶標識 |
workspace_id | STRING | 是 | default | 工作空間標識 |
返回參數
名稱 | 類型 | 示例 | 描述 |
data | AuthAppInfoVO | - | data |
代碼示例
請求示例
{
"param":{
"auth_app_type":"INNER",
"sub_app_id":"qcbA92upcnVlaYiF",
"authentication_type":"SECRET",
"encrypt_type":"NONE",
"sub_workspace_id":"antdemo",
"sub_tenant_id":"JADDGOCN",
},
"tenant_id":"JADDGOCN",
"workspace_id":"antdemo"
}
返回示例
{
"data":{
"auth_app_type":"OUTER",
"encrypt_type":"NONE",
"app_type":"STANDARD",
"sub_app_id":"qcbA92upcnVlaYiF",
"auth_app_info_id":"MQr68JtMFFFzLJe0",
"sub_app_info":{
"tenant_id":"JADDGOCN",
"gmt_create":"2020-03-27 10:47:01",
"workspace_id":"antdemo",
"app_name":"app6",
"gmt_modified":"2020-03-27 10:47:01",
"app_id":"qcbA92upcnVlaYiF",
"operator":""
},
"sub_tenant_id":"JADDGOCN",
"authentication_type":"SECRET",
"sub_workspace_id":"antdemo",
"operator":""
},
"result_code":"OK"
}
刪除授權應用
sofa.apigateway.authapp.delete
用于刪除一個授權應用。
請求參數
名稱 | 類型 | 是否必填 | 示例 | 描述 |
auth_app_info_id | STRING | 是 | 8Amfi67dmE9wpY46 | 授權應用信息標識 |
tenant_id | STRING | 是 | TSCPDICNT | 租戶標識 |
workspace_id | STRING | 是 | default | 工作空間標識 |
返回參數
名稱 | 類型 | 示例 | 描述 |
data | BOOLEAN | true, false | data |
代碼示例
請求示例
{
"auth_app_info_id":"OzygEdYzwFLRruxg",
"tenant_id":"JADDGOCN",
"workspace_id":"antdemo"
}
返回示例
{
"data":true,
"result_code":"OK"
}
更新授權應用
sofa.apigateway.authapp.update
用于更新一個授權應用信息。
請求參數
名稱 | 類型 | 是否必填 | 示例 | 描述 |
auth_app_info_id | STRING | 是 | 8Amfi67dmE9wpY46 | 授權應用信息標識 |
tenant_id | STRING | 是 | TSCPDICNT | 租戶標識 |
workspace_id | STRING | 是 | default | 工作空間標識 |
返回參數
名稱 | 類型 | 示例 | 描述 |
data | AuthAppInfoVO | - | data |
代碼示例
請求示例
{
"param":{
"auth_app_type":"OUTER",
"sub_app_id":"qcbA92upcnVlaYiF",
"authentication_type":"SECRET",
"encrypt_type":"ECC",
"sub_workspace_id":"antdemo",
"sub_tenant_id":"JADDGOCN",
"auth_app_info_id":"MQr68JtMFFFzLJe0",
},
"tenant_id":"JADDGOCN",
"workspace_id":"antdemo"
}
返回示例
{
"data":true,
"result_code":"OK"
}
通過 ID 查詢授權應用
sofa.apigateway.authapp.get
用于查詢指定授權應用 ID 的授權對象信息。
請求參數
名稱 | 類型 | 是否必填 | 示例 | 描述 |
auth_app_info_id | STRING | 是 | 8Amfi67dmE9wpY46 | 授權應用信息標識 |
tenant_id | STRING | 是 | TSCPDICNT | 租戶標識 |
workspace_id | STRING | 是 | default | 工作空間標識 |
返回參數
名稱 | 類型 | 示例 | 描述 |
data | AuthAppInfoVO | - | data |
代碼示例
請求示例
{
"auth_app_info_id":"MQr68JtMFFFzLJe0",
"tenant_id":"JADDGOCN",
"workspace_id":"antdemo"
}
返回示例
{
"data":{
"gmt_create":"2020-03-27 15:33:18",
"auth_app_type":"OUTER",
"encrypt_type":"ECC",
"app_type":"STANDARD",
"sub_app_id":"qcbA92upcnVlaYiF",
"auth_app_info_id":"MQr68JtMFFFzLJe0",
"sub_app_info":{
"tenant_id":"JADDGOCN",
"gmt_create":"2020-03-27 10:47:01",
"workspace_id":"antdemo",
"app_name":"app6",
"gmt_modified":"2020-03-27 10:47:01",
"app_id":"qcbA92upcnVlaYiF",
"operator":""
},
"sub_tenant_id":"JADDGOCN",
"gmt_modified":"2020-03-27 15:39:29",
"authentication_type":"SECRET",
"sub_workspace_id":"antdemo",
"operator":""
},
"result_code":"OK"
}
查詢授權應用分頁列表
sofa.apigateway.authapp.list
用于查詢授權應用的分頁列表。
請求參數
名稱 | 類型 | 是否必填 | 示例 | 描述 |
param | AuthAppInfoQueryVO | 否 | - | param |
tenant_id | STRING | 是 | TSCPDICNT | 租戶標識 |
workspace_id | STRING | 是 | default | 工作空間標識 |
返回參數
名稱 | 類型 | 示例 | 描述 |
data | AuthAppInfoPagedListVO | - | data |
代碼示例
請求示例
{
"param":{
"page_info":{
"page_index":1,
"page_size":10
},
"query":{}
},
"tenant_id":"JADDGOCN",
"workspace_id":"antdemo"
}
返回示例
{
"data":{
"page_info":{
"total":4,
"page_index":1,
"page_size":10
},
"list":[
{
"subTenantId":"JADDGOCN",
"gmtModified":"2020-03-27 15:39:29",
"appType":"STANDARD",
"subAppInfo":{
"gmtModified":"2020-03-27 10:47:01",
"appName":"app6",
"appId":"qcbA92upcnVlaYiF",
"tenantId":"JADDGOCN",
"gmtCreate":"2020-03-27 10:47:01",
"operator":"",
"workspaceId":"antdemo"
},
"authAppInfoId":"MQr68JtMFFFzLJe0",
"authAppType":"OUTER",
"authenticationType":"SECRET",
"gmtCreate":"2020-03-27 15:33:18",
"subWorkspaceId":"antdemo",
"encryptType":"ECC",
"operator":"",
"subAppId":"qcbA92upcnVlaYiF"
},
{
"subTenantId":"JADDGOCN",
"gmtModified":"2020-03-25 16:40:11",
"appType":"STANDARD",
"subAppInfo":{
"gmtModified":"2020-03-25 16:39:51",
"appName":"app2",
"appId":"zQf1Pk34kku03wxP",
"tenantId":"JADDGOCN",
"gmtCreate":"2020-03-25 16:39:51",
"operator":"",
"workspaceId":"antdemo"
},
"authAppInfoId":"oxLIMO8MKn7x6nxy",
"authAppType":"OUTER",
"authenticationType":"SECRET",
"gmtCreate":"2020-03-25 16:40:11",
"subWorkspaceId":"antdemo",
"encryptType":"NONE",
"operator":"",
"subAppId":"zQf1Pk34kku03wxP"
}
]
},
"result_code":"OK"
}
查詢授權應用列表
sofa.apigateway.authapp.all
用于查詢授權應用的所有列表。
請求參數
名稱 | 類型 | 是否必填 | 示例 | 描述 |
param | AuthAppInfoQueryVO | 否 | - | param |
tenant_id | STRING | 是 | TSCPDICNT | 租戶標識 |
workspace_id | STRING | 是 | default | 工作空間標識 |
返回參數
名稱 | 類型 | 示例 | 描述 |
data | ARRAY[AuthAppInfoVO] | - | data |
代碼示例
請求示例
{
"param":{
"page_info":{
"page_index":1,
"page_size":10
},
"query":{}
},
"tenant_id":"JADDGOCN",
"workspace_id":"antdemo"
}
返回示例
{
"data":{
"page_info":{
"total":2,
"page_index":1,
"page_size":10
},
"list":[
{
"subTenantId":"JADDGOCN",
"gmtModified":"2020-03-27 15:39:29",
"appType":"STANDARD",
"subAppInfo":{
"gmtModified":"2020-03-27 10:47:01",
"appName":"app6",
"appId":"qcbA92upcnVlaYiF",
"tenantId":"JADDGOCN",
"gmtCreate":"2020-03-27 10:47:01",
"operator":"",
"workspaceId":"antdemo"
},
"authAppInfoId":"MQr68JtMFFFzLJe0",
"authAppType":"OUTER",
"authenticationType":"SECRET",
"gmtCreate":"2020-03-27 15:33:18",
"subWorkspaceId":"antdemo",
"encryptType":"ECC",
"operator":"",
"subAppId":"qcbA92upcnVlaYiF"
},
{
"subTenantId":"JADDGOCN",
"gmtModified":"2020-03-25 16:40:11",
"appType":"STANDARD",
"subAppInfo":{
"gmtModified":"2020-03-25 16:39:51",
"appName":"app2",
"appId":"zQf1Pk34kku03wxP",
"tenantId":"JADDGOCN",
"gmtCreate":"2020-03-25 16:39:51",
"operator":"",
"workspaceId":"antdemo"
},
"authAppInfoId":"oxLIMO8MKn7x6nxy",
"authAppType":"OUTER",
"authenticationType":"SECRET",
"gmtCreate":"2020-03-25 16:40:11",
"subWorkspaceId":"antdemo",
"encryptType":"NONE",
"operator":"",
"subAppId":"zQf1Pk34kku03wxP"
}
]
},
"result_code":"OK"
}
通過授權應用 ID 查詢 API 分頁列表
sofa.apigateway.authapp.api.list
用于查詢指定授權應用下的獲得授權的 API 分頁列表。
請求參數
名稱 | 類型 | 是否必填 | 示例 | 描述 |
auth_app_info_id | STRING | 是 | 8Amfi67dmE9wpY46 | 授權 API 標識 |
param | ApiInfoQueryVO | 否 | - | param |
tenant_id | STRING | 是 | TSCPDICNT | 租戶標識 |
workspace_id | STRING | 是 | default | 工作空間標識 |
返回參數
名稱 | 類型 | 示例 | 描述 |
data | ApiInfoPagedListVO | data |
代碼示例
請求示例
{
"param":{
"page_info":{
"page_index":1,
"page_size":10
},
"query":{}
},
"auth_app_info_id":"MQr68JtMFFFzLJe0",
"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 15:51:48",
"sysId":"A3QV9pym9CaVKdLV0gIcQMsGNIplTZwd",
"routerType":"PATH",
"upstreamProtocol":"HTTP",
"timeout":3000,
"operator":"",
"path":"/openapi/apigateway/test/api1",
"apiGroupId":"fifhwqgcsmqo9ycl",
"appType":"STANDARD",
"contentType":"application/json",
"apiId":"IjiuBaYgvZLz2ODOvRWiQT3OGCqSbDYu",
"workspaceId":"antdemo",
"method":"GET",
"authAppCount":1,
"upstreamPath":"/openapi/apigateway/test/api1",
"gmtCreate":"2020-03-27 14:12:43",
"onlineVersion":{
"versionId":"3VdYOmSsKAD07DuvX6EHvsnheXONfF80",
"gmtModified":"2020-03-27 14:58:34",
"versionNo":"20200327141243487-B0XAffhP",
"gmtOnline":"2020-03-27 14:58:34",
"gmtCreate":"2020-03-27 14:12:43",
"gmtEdit":"2020-03-27 14:17:30",
"apiId":"IjiuBaYgvZLz2ODOvRWiQT3OGCqSbDYu"
},
"downstreamProtocol":"HTTP",
"domainName":"fifhwqgcsmqo9ycl.apigateway.inc.alipay.net",
"apiGroupName":"apigroup2",
"tenantId":"JADDGOCN",
"upstreamType":"SYSTEM_CLUSTER",
"apiStatus":"OPENED"
}
]
},
"result_code":"OK"
}
通過授權應用 ID 查詢 API 列表
sofa.apigateway.authapp.api.all
用于查詢指定授權應用下的所有獲得授權的 API 列表。
請求參數
名稱 | 類型 | 是否必填 | 示例 | 描述 |
auth_app_info_id | STRING | 是 | 8Amfi67dmE9wpY46 | 授權應用標識 |
param | ApiInfoQueryVO | 否 | - | param |
tenant_id | STRING | 是 | TSCPDICNT | 租戶標識 |
workspace_id | STRING | 是 | default | 工作空間標識 |
返回參數
名稱 | 類型 | 示例 | 描述 |
data | ARRAY[ApiInfoVO] | - | data |
代碼示例
請求示例
{
"param":{
"page_info":{
"page_index":1,
"page_size":10
},
"query":{}
},
"auth_app_info_id":"MQr68JtMFFFzLJe0",
"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 15:51:48",
"sysId":"A3QV9pym9CaVKdLV0gIcQMsGNIplTZwd",
"routerType":"PATH",
"upstreamProtocol":"HTTP",
"timeout":3000,
"operator":"",
"path":"/openapi/apigateway/test/api1",
"apiGroupId":"fifhwqgcsmqo9ycl",
"appType":"STANDARD",
"contentType":"application/json",
"apiId":"IjiuBaYgvZLz2ODOvRWiQT3OGCqSbDYu",
"workspaceId":"antdemo",
"method":"GET",
"authAppCount":1,
"upstreamPath":"/openapi/apigateway/test/api1",
"gmtCreate":"2020-03-27 14:12:43",
"onlineVersion":{
"versionId":"3VdYOmSsKAD07DuvX6EHvsnheXONfF80",
"gmtModified":"2020-03-27 14:58:34",
"versionNo":"20200327141243487-B0XAffhP",
"gmtOnline":"2020-03-27 14:58:34",
"gmtCreate":"2020-03-27 14:12:43",
"gmtEdit":"2020-03-27 14:17:30",
"apiId":"IjiuBaYgvZLz2ODOvRWiQT3OGCqSbDYu"
},
"downstreamProtocol":"HTTP",
"domainName":"fifhwqgcsmqo9ycl.apigateway.inc.alipay.net",
"apiGroupName":"apigroup2",
"tenantId":"JADDGOCN",
"upstreamType":"SYSTEM_CLUSTER",
"apiStatus":"OPENED"
}
]
},
"result_code":"OK"
}