全部产品

API 管理

更新时间:2021-02-05 19:02

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

创建 API 信息

sofa.apigateway.api.create 用于快速创建一个 API 服务。

请求参数

名称

类型

是否必填

示例

描述

param

ApiInfoVO

-

param

tenant_id

STRING

TSCPDICNT

租户标识

workspace_id

STRING

default

工作空间标识

返回参数

名称

类型

示例

描述

data

ApiInfoVO

-

data

代码示例

请求示例

{
"param":{
"api_group_id":"fifhwqgcsmqo****",
"api_name":"api-test",
"app_type":"STANDARD",
"path":"/openapi/apigateway/test/api",
"method":"GET",
"content_type":"application/json",
"charset":"UTF-8",
"path_rule":1,
"upstream_type":"SYSTEM_CLUSTER",
"upstream_protocol":"HTTP",
"upstream_path":"/openapi/apigateway/test/api",
"router_type":"PATH",
"sys_id":"A3QV9pym9CaVKdLV0gIcQMsGNIpl****",
"downstream_protocol":"HTTP",
"timeout":3000,
},
"tenant_id":"JADDGOCN",
"workspace_id":"antdemo"
}

返回示例

{
"data":true,
"result_code":"OK"
}

通过 ID 删除 API

sofa.apigateway.api.delete 用于通过 API 标识删除指定 API。

请求参数

名称

类型

是否必填

示例

描述

api_id

STRING

8Amfi67dmE9wpY46

API标识

tenant_id

STRING

TSCPDICNT

租户标识

workspace_id

STRING

default

工作空间标识

返回参数

名称

类型

示例

描述

data

BOOLEAN

true, false

data

代码示例

请求示例

{
"api_id":"p4UXmtfxcjkzAKIi9Zgqzr598oa3****",
"tenant_id":"JADDGOCN",
"workspace_id":"antdemo"
}

返回示例

{
"data":true,
"result_code":"OK"
}

更新 API 信息

sofa.apigateway.api.update 用于更新 API 信息。

请求参数

名称

类型

是否必填

示例

描述

param

ApiInfoVO

-

param

tenant_id

STRING

TSCPDICNT

租户标识

workspace_id

STRING

default

工作空间标识

返回参数

名称

类型

示例

描述

data

BOOLEAN

true, false

data

代码示例

请求示例

{
"param":{
"api_group_id":"fifhwqgcsmq****",
"api_name":"api-test2",
"app_type":"STANDARD",
"path":"/openapi/apigateway/test/api1",
"method":"GET",
"content_type":"application/json",
"charset":"UTF-8",
"path_rule":1,
"upstream_type":"SYSTEM_CLUSTER",
"upstream_protocol":"HTTP",
"upstream_path":"/openapi/apigateway/test/api",
"router_type":"PATH",
"sys_id":"A3QV9pym9CaVKdLV0gIcQMsGNIpl****",
"downstream_protocol":"HTTP",
"timeout":3000,
"api_id":"IjiuBaYgvZLz2ODOvRWiQT3OGCqS****"
},
"tenant_id":"JADDGOCN",
"workspace_id":"antdemo"
}

返回示例

{
"data":true,
"result_code":"OK"
}

通过 ID 查询 API

sofa.apigateway.api.get 用于通过 API ID 查询获取指定 API 信息。

请求参数

名称

类型

是否必填

示例

描述

api_id

STRING

8Amfi67dmE9wpY46

API标识

tenant_id

STRING

TSCPDICNT

租户标识

workspace_id

STRING

default

工作空间标识

返回参数

名称

类型

示例

描述

data

ApiInfoVO

-

data

代码示例

请求示例

{
"api_id":"IjiuBaYgvZLz2ODOvRWiQT3OGCqSbDYu",
"tenant_id":"JADDGOCN",
"workspace_id":"antdemo"
}

返回示例

{
"data":{
"gmt_create":"2020-03-27 14:12:43",
"tenant_id":"JADDGOCN",
"charset":"UTF-8",
"api_id":"IjiuBaYgvZLz2ODOvRWiQT3OGCqS****",
"app_type":"STANDARD",
"upstream_type":"SYSTEM_CLUSTER",
"gmt_modified":"2020-03-27 14:17:30",
"timeout":3000,
"operator":"",
"system_cluster":{
"tenant_id":"JADDGOCN",
"gmt_create":"2020-03-27 10:46:33",
"workspace_id":"antdemo",
"sys_id":"A3QV9pym9CaVKdLV0gIcQMsGNIpl****",
"upstream_protocol":"HTTP",
"host":[
"192.157.0.3:80",
"192.168.0.3:80"
],
"sys_name":"sys2",
"api_count":1,
"sys_type":"URL",
"gmt_modified":"2020-03-27 14:17:30",
"lb_type":"ROUND_ROBIN",
"operator":""
},
"workspace_id":"antdemo",
"upstream_path":"/openapi/apigateway/test/api1",
"sys_id":"A3QV9pym9CaVKdLV0gIcQMsGNIplTZwd",
"path":"/openapi/apigateway/test/api1",
"domain_name":"fifhwqgcsmqo9ycl.apigateway.inc.alipay.net",
"content_type":"application/json",
"api_group_name":"apigroup2",
"downstream_protocol":"HTTP",
"history_version_list":[],
"method":"GET",
"api_status":"CLOSED",
"api_group_id":"fifhwqgcsmqo9ycl",
"edit_version":{
"gmt_create":"2020-03-27 14:12:43",
"version_no":"20200327141243487-B0XAffhP",
"api_id":"IjiuBaYgvZLz2ODOvRWiQT3OGCqSbDYu",
"gmt_edit":"2020-03-27 14:17:30",
"version_id":"3VdYOmSsKAD07DuvX6EHvsnheXONfF80",
"gmt_modified":"2020-03-27 14:17:30"
},
"upstream_protocol":"HTTP",
"api_name":"api-test2",
"router_type":"PATH"
},
"result_code":"OK"
}

查询 API 列表

sofa.apigateway.api.all 用于快速查询 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
},
"query":{}
},
"tenant_id":"JADDGOCN",
"workspace_id":"antdemo"
}

返回示例

{
"data":[
{
"charset":"UTF-8",
"apiName":"api-test2",
"gmtModified":"2020-03-27 14:17:30",
"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",
"tenantId":"JADDGOCN",
"contentType":"application/json",
"upstreamType":"SYSTEM_CLUSTER",
"apiId":"IjiuBaYgvZLz2ODOvRWiQT3OGCqSbDYu",
"apiStatus":"CLOSED",
"workspaceId":"antdemo"
},
{
"charset":"UTF-8",
"apiName":"rrrwe",
"gmtModified":"2020-03-26 11:58:29",
"method":"GET",
"upstreamPath":"/werwer",
"routerType":"HEADER",
"upstreamProtocol":"HTTP",
"gmtCreate":"2020-03-25 15:15:12",
"timeout":3000,
"operator":"",
"path":"/werwer",
"apiGroupId":"dumebnn9gbnyy02y",
"appType":"STANDARD",
"routerId":"aPdifmIr852vfqE4",
"downstreamProtocol":"HTTP",
"tenantId":"JADDGOCN",
"operationType":"wer.wer",
"contentType":"application/json",
"upstreamType":"SYSTEM_CLUSTER",
"apiId":"1h3WttiKTeTUtZpWn5Xg5P5bu2UBGjrP",
"apiStatus":"CLOSED",
"workspaceId":"antdemo"
}
],
"result_code":"OK"
}

查询 API 分页列表

sofa.apigateway.api.list 用于快速查询 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":{}
},
"tenant_id":"JADDGOCN",
"workspace_id":"antdemo"
}

返回示例

{
"data":{
"page_info":{
"total":2,
"page_index":1,
"page_size":10
},
"list":[
{
"charset":"UTF-8",
"apiName":"api-test2",
"gmtModified":"2020-03-27 14:17:30",
"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",
"tenantId":"JADDGOCN",
"contentType":"application/json",
"upstreamType":"SYSTEM_CLUSTER",
"apiId":"IjiuBaYgvZLz2ODOvRWiQT3OGCqSbDYu",
"apiStatus":"CLOSED",
"workspaceId":"antdemo"
},
{
"charset":"UTF-8",
"apiName":"rrrwe",
"gmtModified":"2020-03-26 11:58:29",
"method":"GET",
"upstreamPath":"/werwer",
"routerType":"HEADER",
"upstreamProtocol":"HTTP",
"gmtCreate":"2020-03-25 15:15:12",
"timeout":3000,
"operator":"",
"path":"/werwer",
"apiGroupId":"dumebnn9gbnyy02y",
"appType":"STANDARD",
"routerId":"aPdifmIr852vfqE4",
"downstreamProtocol":"HTTP",
"tenantId":"JADDGOCN",
"operationType":"wer.wer",
"contentType":"application/json",
"upstreamType":"SYSTEM_CLUSTER",
"apiId":"1h3WttiKTeTUtZpWn5Xg5P5bu2UBGjrP",
"apiStatus":"CLOSED",
"workspaceId":"antdemo"
}
]
},
"result_code":"OK"
}

通过 API ID 查询授权应用列表

sofa.apigateway.api.authapp.all 用于查询指定 API 的所有授权应用列表。

请求参数

名称

类型

是否必填

示例

描述

api_id

STRING

8Amfi67dmE9wpY46

API 标识

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":{}
},
"api_id":"h4ZWfWe9anCJn4Tye3tPMiGJZJ2PeGWq",
"tenant_id":"JADDGOCN",
"workspace_id":"antdemo"
}

返回示例

{
"data":[
{
"gmtModified":"2020-03-25 15:06:51",
"authAppType":"INNER",
"apiCount":1,
"gmtCreate":"2020-03-25 15:05:42",
"subWorkspaceId":"antdemo",
"operator":"",
"subTenantId":"JADDGOCN",
"appType":"STANDARD",
"subAppInfo":{
"gmtModified":"2020-03-25 15:06:51",
"appName":"test_lq",
"appId":"Oo2llCf0MkkhGtgL",
"tenantId":"JADDGOCN",
"apiCount":1,
"gmtCreate":"2020-03-25 15:04:30",
"operator":"",
"workspaceId":"antdemo"
},
"authAppInfoId":"H71mhS7Co7CyY6YI",
"authenticationType":"SECRET",
"encryptType":"NONE",
"subAppId":"Oo2llCf0MkkhGtgL"
}
],
"result_code":"OK"
}

通过 API ID 查询授权应用分页列表

sofa.apigateway.api.authapp.list 用于查询指定 API 的所有授权应用的分页列表。

请求参数

名称

类型

是否必填

示例

描述

api_id

STRING

8Amfi67dmE9wpY46

API 标识

param

AuthAppInfoQueryVO

-

param

tenant_id

STRING

TSCPDICNT

租户标识

workspace_id

STRING

default

工作空间标识

返回参数

名称

类型

示例

描述

data

AuthAppInfoPagedListVO

-

data

代码示例

请求示例

{
"param":{
"page_info":{
"page_index":1,
"page_size":10
},
"query":{}
},
"api_id":"h4ZWfWe9anCJn4Tye3tPMiGJZJ2PeGWq",
"tenant_id":"JADDGOCN",
"workspace_id":"antdemo"
}

返回示例

{
"data":{
"page_info":{
"total":1,
"page_index":1,
"page_size":10
},
"list":[
{
"gmtModified":"2020-03-25 15:06:51",
"authAppType":"INNER",
"apiCount":1,
"gmtCreate":"2020-03-25 15:05:42",
"subWorkspaceId":"antdemo",
"operator":"",
"subTenantId":"JADDGOCN",
"appType":"STANDARD",
"subAppInfo":{
"gmtModified":"2020-03-25 15:06:51",
"appName":"test_lq",
"appId":"Oo2llCf0MkkhGtgL",
"tenantId":"JADDGOCN",
"apiCount":1,
"gmtCreate":"2020-03-25 15:04:30",
"operator":"",
"workspaceId":"antdemo"
},
"authAppInfoId":"H71mhS7Co7CyY6YI",
"authenticationType":"SECRET",
"encryptType":"NONE",
"subAppId":"Oo2llCf0MkkhGtgL"
}
]
},
"result_code":"OK"
}

API 挂载授权应用

sofa.apigateway.api.authapp.mount 用于挂载指定 API 的授权应用。

请求参数

名称

类型

是否必填

示例

描述

api_id

STRING

8Amfi67dmE9wpY46

API 标识

auth_app_info_id_list

ARRAY[STRING]

-

授权应用标识列表

tenant_id

STRING

TSCPDICNT

租户标识

workspace_id

STRING

default

工作空间标识

返回参数

名称

类型

示例

描述

data

BOOLEAN

true, false

data

代码示例

请求示例

{
"auth_app_info_id_list":[
"hg42jDqSYGREHHKN"
],
"api_id":"h4ZWfWe9anCJn4Tye3tPMiGJZJ2PeGWq",
"tenant_id":"JADDGOCN",
"workspace_id":"antdemo"
}

返回示例

{
"data":true,
"result_code":"OK"
}

API 解除授权应用

sofa.apigateway.api.authapp.unmount 用于解除绑定指定 API 的授权应用。

请求参数

名称

类型

是否必填

示例

描述

api_id

STRING

api_id

API 标识

auth_app_info_id_list

ARRAY[STRING]

-

auth_app_info_id_list

tenant_id

STRING

tenant_id

tenant_id

workspace_id

STRING

workspace_id

workspace_id

返回参数

名称

类型

示例

描述

data

BOOLEAN

true, false

data

代码示例

请求示例

{
"api_id":"h4ZWfWe9anCJn4Tye3tPMiGJZJ2PeGWq",
"auth_app_info_id_list":[
"H71mhS7Co7CyY6YI"
],
"tenant_id":"JADDGOCN",
"workspace_id":"antdemo"
}

返回示例

{
"data":true,
"result_code":"OK"
}

上线 API

sofa.apigateway.api.online 用于上线指定 API。

请求参数

名称

类型

是否必填

示例

描述

api_id_list

ARRAY[STRING]

-

要上线的 API 标识列表

online_desc

STRING

online_desc1

上线描述

tenant_id

STRING

TSCPDICNT

租户标识

workspace_id

STRING

default

工作空间标识

返回参数

名称

类型

示例

描述

data

BOOLEAN

true, false

data

代码示例

请求示例

{
"api_id_list":[
"xN0YItcXFg9Ny6BRLFXaFv4fGHjt24P2"
],
"tenant_id":"JADDGOCN",
"workspace_id":"antdemo"
}

返回示例

{
"data":true,
"result_code":"OK"
}

下线 API

sofa.apigateway.api.offline 用于下线一个 API 服务。

请求参数

名称

类型

是否必填

示例

描述

api_id_list

ARRAY[STRING]

-

要上线的 API 标识列表

offline_desc

STRING

offline_desc1

下线描述

tenant_id

STRING

TSCPDICNT

租户标识

workspace_id

STRING

default

工作空间标识

返回参数

名称

类型

示例

描述

data

BOOLEAN

true, false

data

代码示例

请求示例

{
"api_id_list":[
"h4ZWfWe9anCJn4Tye3tPMiGJZJ2P****"
],
"tenant_id":"JADDGOCN",
"workspace_id":"antdemo"
}

返回示例

{
"data":true,
"result_code":"OK"
}

获取指定版本的 API

sofa.apigateway.api.versionapi.get 用于查询获取指定版本的 API 信息。

请求参数

名称

类型

是否必填

示例

描述

api_id

STRING

api_id

API 标识

tenant_id

STRING

tenant_id

租户 ID

version_id

STRING

version_id

版本号

workspace_id

STRING

workspace_id

工作空间 ID

返回参数

名称

类型

示例

data

ApiInfoVO

data

代码示例

请求示例

{
"api_id":"IjiuBaYgvZLz2ODOvRWiQT3OGCqSbDYu",
"version_id":"3VdYOmSsKAD07DuvX6EHvsnheXO****",
"tenant_id":"JADDGOCN",
"workspace_id":"antdemo"
}

返回示例

{
"data":{
"gmt_create":"2020-03-27 14:12:43",
"tenant_id":"JADDGOCN",
"charset":"UTF-8",
"api_id":"IjiuBaYgvZLz2ODOvRWiQT3OGCqSbDYu",
"app_type":"STANDARD",
"method":"GET",
"upstream_type":"SYSTEM_CLUSTER",
"api_status":"CLOSED",
"gmt_modified":"2020-03-27 14:17:30",
"timeout":3000,
"operator":"",
"system_cluster":{
"tenant_id":"JADDGOCN",
"gmt_create":"2020-03-27 10:46:33",
"workspace_id":"antdemo",
"sys_id":"A3QV9pym9CaVKdLV0gIcQMsGNIplTZwd",
"upstream_protocol":"HTTP",
"host":[
"192.157.1.3:80",
"192.168.2.3:80"
],
"sys_name":"sys2",
"api_count":1,
"sys_type":"URL",
"gmt_modified":"2020-03-27 14:17:30",
"lb_type":"ROUND_ROBIN",
"operator":""
},
"upstream_path":"/openapi/apigateway/test/api1",
"api_group_id":"fifhwqgcsmqo9ycl",
"workspace_id":"antdemo",
"sys_id":"A3QV9pym9CaVKdLV0gIcQMsGNIplTZwd",
"path":"/openapi/apigateway/test/api1",
"domain_name":"fifhwqgcsmqo9ycl.apigateway.inc.alipay.net",
"upstream_protocol":"HTTP",
"content_type":"application/json",
"api_group_name":"apigroup2",
"api_name":"api-test2",
"downstream_protocol":"HTTP",
"router_type":"PATH"
},
"result_code":"OK"
}

更新 API 版本号

sofa.apigateway.api.versionno.update 用于更新一个 API 的版本号。

请求参数

名称

类型

是否必填

示例

描述

api_id

STRING

8Amfi67dmE9wpY46

API 标识

tenant_id

STRING

TSCPDICNT

租户标识

version_no

STRING

version_no1

版本号

workspace_id

STRING

default

工作空间标识

返回参数

名称

类型

示例

描述

data

BOOLEAN

true, false

data

代码示例

请求示例

{
"api_id":"IjiuBaYgvZLz2ODOvRWiQT3OGCqSbDYu",
"version_no":"20200327141243487-B0XAffhP",
"tenant_id":"JADDGOCN",
"workspace_id":"antdemo"
}

返回示例

{
"data":true,
"result_code":"OK"
}

调试 API

sofa.apigateway.test.http.exec 用于对 API 进行调试。

请求参数

名称

类型

是否必填

示例

描述

param

ApiTestReqVO

-

API 调试参数

tenant_id

STRING

TSCPDICNT

租户标识

workspace_id

STRING

default

工作空间标识

返回参数

名称

类型

示例

描述

data

ApiTestRspVO

-

data

查询 API 监控信息

sofa.apigateway.monitor.query 用于查看 API 监控信息。

请求参数

名称

类型

是否必填

示例

描述

param

MonitoryRequest

-

查询的 API 监控请求参数

tenant_id

STRING

TSCPDICNT

租户标识

workspace_id

STRING

default

工作空间标识

返回参数定义

名称

类型

示例

描述

data

MonitoryAggregationVO

-

data