本文列出了授权应用相关的 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"
}- 本页导读 （0）