结构体说明
本文介绍 API 网关产品涉及的所有 API 结构体字段及其示例、说明等。
AppInfoVO
名称 | 类型 | 是否必填 | 示例 | 描述 |
api_count | NUMBER | 否 | 1 | API 数量 |
app_id | STRING | 否 | app_id | APPID |
app_name | STRING | 否 | app_name | 应用名称 |
app_secret | STRING | 否 | app_secret1 | appSecret |
app_type | STRING | 否 | STANDARD / MPAAS | 应用类型 |
authentication_config | AuthenticationConfigVO | 否 | - | 授权配置 |
description | STRING | 否 | description | 应用描述 |
encrypt_config | EncryptConfigVO | 否 | - | 加密配置 |
gmt_create | DATE | 否 | 2018-10-10T10:10:00Z | 创建时间 |
gmt_modified | DATE | 否 | 2018-10-10T10:10:00Z | 更改时间 |
operator | STRING | 否 | scott | 操作人 |
tenant_id | STRING | 否 | tenant_id | 租户 ID |
workspace_id | STRING | 否 | workspace_id | 工作空间 ID |
AppInfoQueryVO
名称 | 类型 | 是否必填 | 示例 | 描述 |
page_info | PageInfo | 否 | - | 分页信息 |
query | AppInfoVO | 否 | - | 查询 |
AppInfoPagedListVO
名称 | 类型 | 是否必填 | 示例 | 描述 |
list | ARRAY[AppInfoVO] | 否 | - | list |
page_info | PageInfo | 否 | - | 分页信息 |
AuthAppInfoVO
名称 | 类型 | 是否必填 | 示例 | 描述 |
api_count | NUMBER | 否 | 1 | API 数量 |
app_type | STRING | 否 | MPAAS/STANDARD | 应用类型 |
authentication_type | STRING | 否 | NONE / SECRET | 认证方式 |
auth_app_info_id | STRING | 否 | 8Amfi67dmE9wpY46 | 授权应用 ID |
auth_app_type | STRING | 否 | OUTER / INNER | 授权应用来源（内部应用/外部应用） |
encrypt_type | STRING | 否 | NONE / RSA / ECC / SM | 加密类型 |
gmt_create | DATE | 否 | 2018-10-10T10:10:00Z | 创建时间 |
gmt_modified | DATE | 否 | 2018-10-10T10:10:00Z | 更改时间 |
operator | STRING | 否 | scott | 操作人 |
sub_app_company | STRING | 否 | sub_app_company1 | 订阅方应用公司信息 |
sub_app_desc | STRING | 否 | sub_app_desc1 | 订阅方应用描述 |
sub_app_id | STRING | 否 | sub_app_id | 订阅方应用 ID |
sub_app_info | AppInfoVO | 否 | - | 订阅方应用信息 |
sub_tenant_id | STRING | 否 | sub_tenant_id1 | 订阅方应用租户 ID |
sub_workspace_id | STRING | 否 | sub_workspace_id1 | 订阅方应用工作空间标识 |
AuthAppInfoQueryVO
名称 | 类型 | 是否必填 | 示例 | 描述 |
page_info | PageInfo | 否 | - | 分页信息 |
query | AuthAppInfoVO | 否 | - | 查询 |
AuthAppInfoPagedListVO
名称 | 类型 | 是否必填 | 示例 | 描述 |
list | ARRAY[AuthAppInfoVO] | 否 | - | 列表 |
page_info | PageInfo | 否 | - | 分页信息 |
SystemClusterVO
名称 | 类型 | 是否必填 | 示例 | 描述 |
api_count | NUMBER | 否 | 1 | API 数量 |
authentication_config | AuthenticationConfigVO | 否 | - | 认证配置 |
authentication_type | STRING | 否 | SECRET/NONE | 认证方式 |
description | STRING | 否 | 测试系统 | 描述 |
gmt_create | DATE | 否 | 2018-10-10T10:10:00Z | 创建时间 |
gmt_modified | DATE | 否 | 2018-10-10T10:10:00Z | 修改时间 |
host | ARRAY[STRING] | 否 | - | 系统 host 地址 |
lb_type | STRING | 否 | RAMDOM / ROUND_ROBIN | 负载均衡策略类型 |
operator | STRING | 否 | scott | 创建人 |
sys_id | STRING | 否 | 8Amfi67dmE9wpY46 | 系统ID |
sys_name | STRING | 否 | test_sys | 系统名称 |
sys_type | STRING | 否 | URL / SOFA | 系统类型（手工配置/SOFA 注册中心/ZooKeeper） |
tenant_id | STRING | 否 | TSCPDICNT | 租户 ID |
upstream_protocol | STRING | 否 | HTTP / SOFA | 后端协议类型 |
workspace_id | STRING | 否 | default | 工作空间标识 |
SystemClusterQueryVO
名称 | 类型 | 是否必填 | 示例 | 描述 |
page_info | PageInfo | 否 | - | 分页信息 |
query | SystemClusterVO | 否 | - | 查询 |
SystemClusterPagedListVO
名称 | 类型 | 是否必填 | 示例 | 描述 |
list | ARRAY[SystemClusterVO] | 否 | - | 列表 |
page_info | PageInfo | 否 | - | 分页信息 |
ApiInfoVO
名称 | 类型 | 是否必填 | 示例 | 描述 |
api_cache_model | ApiCacheVO | 否 | - | API 缓存模型 |
api_group_id | STRING | 否 | api_group_id1 | API 分组标识 |
api_group_name | STRING | 否 | api_group_name1 | 所属 API 分组名称 |
api_id | STRING | 否 | 8Amfi67dmE9wpY46 | API 标识 |
api_limit_config | LimitConfigVO | 否 | - | API 限流配置 |
api_mock_config | ApiMockConfigVO | 否 | api_mock_config | API MOCK 配置 |
api_name | STRING | 否 | apiname1 | API 名称 |
api_status | STRING | 否 | OPENED / CLOSED | API 状态 |
app_type | STRING | 否 | MPAAS/STANDARD/STANDARD_AND_MPAAS | 授权应用类型 |
authentication_type | STRING | 否 | NONE / SECRET | API 认证方式 |
auth_app_count | NUMBER | 否 | 2 | 授权应用数量 |
can_delete | BOOLEAN | 否 | true, false | 是否可以删除 |
charset | STRING | 否 | UTF-8 | 报文编码 |
content_type | STRING | 否 | content_type1 | 内容类型 |
cors_info | CorsInfoVO | 否 | - | API CORS 信息 |
description | STRING | 否 | description1 | API 描述 |
domain_name | STRING | 否 | test.apigateway.com | API 分组域名 |
downstream_protocol | STRING | 否 | HTTP | 前端协议类型 |
edit_version | ApiVersionVO | 否 | 编辑中的版本 | 编辑中的版本 |
edit_version_no | STRING | 否 | edit_version_no1 | 编辑中的 API 版本号 |
function_name | STRING | 否 | getUserID | 方法名 |
gmt_create | DATE | 否 | 2018-10-10T10:10:00Z | 创建时间 |
gmt_modified | DATE | 否 | 2018-10-10T10:10:00Z | 更改时间 |
history_version_list | ARRAY[ApiVersionVO] | 否 | 历史版本列表 | 历史版本列表 |
interface_name | STRING | 否 | com.alipay.HelloFacade:1.0@DEFAULT | 接口名称 |
method | STRING | 否 | method1 | 方法 |
online_version | ApiVersionVO | 否 | 线上版本 | 线上版本 |
online_version_no | STRING | 否 | online_version_no1 | 发布中的 API 版本号 |
operation_type | STRING | 否 | operation_type1 | operationType |
operator | STRING | 否 | operator | 创建人 |
path | STRING | 否 | path1 | path |
path_match_type | STRING | 否 | ABSOLUTE / PREFIX | 路径匹配类型 |
req_params | ARRAY[ApiParamVO] | 否 | - | 请求参数 |
router_id | STRING | 否 | 8Amfi67dmE9wpY46 | router_id |
router_info | RouterInfoVO | 否 | - | 路由规则 |
router_type | STRING | 否 | PATH / HEADER / WEIGHT | 路由策略类型 |
rsq_param | ApiParamVO | 否 | - | rsqParam |
system_cluster | SystemClusterVO | 否 | - | 系统集群 |
sys_id | STRING | 否 | 8Amfi67dmE9wpY46 | 系统集群 ID |
tenant_id | STRING | 否 | tenant1 | 租户标识 |
timeout | NUMBER | 否 | 123 | 超时时间（ms） |
upstream_path | STRING | 否 | upstream_path1 | upstreamPath |
upstream_protocol | STRING | 否 | HTTP / SOFA / SOFA_VPC | 后端协议类型 |
upstream_type | STRING | 否 | NONE / MOCK / SYSTEM_CLUSTER | 后端服务类型 |
workspace_id | STRING | 否 | default | 工作空间标识 |
ApiInfoQueryVO
名称 | 类型 | 是否必填 | 示例 | 描述 |
page_info | PageInfo | 否 | - | 分页信息 |
query | ApiInfoVO | 否 | - | 查询 |
ApiInfoPagedListVO
名称 | 类型 | 是否必填 | 示例 | 描述 |
list | ARRAY[ApiInfoVO] | 否 | - | 列表 |
page_info | PageInfo | 否 | - | 分页信息 |
ApiVersionVO
名称 | 类型 | 是否必填 | 示例 | 描述 |
api_id | STRING | 否 | api_id1 | API 标识 |
edit_operator | STRING | 否 | scott | editOperator |
gmt_create | DATE | 否 | 2018-10-10T10:10:00Z | 创建时间 |
gmt_edit | DATE | 否 | 2018-10-10T10:10:00Z | 编辑时间 |
gmt_modified | DATE | 否 | 2018-10-10T10:10:00Z | 更改时间 |
gmt_offline | DATE | 否 | 2018-10-10T10:10:00Z | gmtOffline |
gmt_online | DATE | 否 | 2018-10-10T10:10:00Z | gmtOnline |
offline_desc | STRING | 否 | offline_desc1 | offlineDesc |
offline_operator | STRING | 否 | scott | 下线操作人 |
online_desc | STRING | 否 | online_desc1 | 发布原因 |
online_operator | STRING | 否 | online_operator1 | 上线操作人 |
version_id | STRING | 否 | 4438Y8yXxU0cYrgS | 版本 ID |
version_no | STRING | 否 | 1.2 | 版本号 |
version_status | STRING | 否 | EDIT / ONLINE / OFFLINE | 版本状态 |
ApiRspCodeVO
名称 | 类型 | 是否必填 | 示例 | 描述 |
error_code | STRING | 否 | error_code | 错误码 |
error_desc | STRING | 否 | error_desc | 描述 |
error_msg | STRING | 否 | error_msg | 错误信息 |
ApiParamVO
名称 | 类型 | 是否必填 | 示例 | 描述 |
api_id | STRING | 否 | api_id1 | API标识 |
default_value | STRING | 否 | value1 | default_value |
description | STRING | 否 | description1 | 描述 |
failure_demo | STRING | 否 | failure_demo | failure_demo |
location | STRING | 否 | Query / Path / Header / … | location |
name | STRING | 否 | name1 | name |
ref_type | STRING | 否 | String | 引用的模型类型 |
required | BOOLEAN | 否 | - | 是否必填 |
rsp_code_list | ARRAY[ApiRspCodeVO] | 否 | - | rsp_code_list |
success_demo | STRING | 否 | success_demo | success_demo |
type | STRING | 否 | String / Int / Long / Float / Double / Boolean / … | 数据类型 |
workspace_id | STRING | 否 | default | 工作空间标识 |
ApiMockConfigVO
名称 | 类型 | 是否必填 | 示例 | 描述 |
mock_data | STRING | 否 | mock_data | MOCK 数据 |
ApiTestParamVO
名称 | 类型 | 是否必填 | 示例 | 描述 |
key | STRING | 否 | key1 | key |
location | STRING | 否 | HEADER/QUERY | location |
value | STRING | 否 | value1 | value |
ApiTestReqVO
名称 | 类型 | 是否必填 | 示例 | 描述 |
api_id | STRING | 否 | api_id1 | API 标识 |
app_id | STRING | 否 | app_id1 | 应用标识 |
auth_app_info_id | STRING | 否 | auth_app_info_id1 | 授权应用 ID |
params | ARRAY[ApiTestParamVO] | 否 | - | params |
payload | STRING | 否 | payload1 | payload |
tenant_id | STRING | 否 | tenant_id | 租户 ID |
workspace_id | STRING | 否 | default | 工作空间 ID |
ApiTestRspVO
名称 | 类型 | 是否必填 | 示例 | 描述 |
code | STRING | 否 | code1 | code |
cost | NUMBER | 否 | 1000 | cost |
headers | ARRAY[ApiTestParamVO] | 否 | - | headers |
payload | STRING | 否 | payload1 | payload |
size | NUMBER | 否 | 1000 | size |
ApiCacheKeyVO
名称 | 类型 | 是否必填 | 示例 | 描述 |
key | STRING | 否 | key1 | key |
location | STRING | 否 | HEADER/QUERY/BODY | location |
value | STRING | 否 | value1 | value |
ApiCacheVO
名称 | 类型 | 是否必填 | 示例 | 描述 |
cache_keys | ARRAY[ApiCacheKeyVO] | 否 | - | cacheKeys |
need_cache | BOOLEAN | 否 | true, false | 是否需要缓存 |
ttl | NUMBER | 否 | 10000 | TTL |
ApiGroupVO
名称 | 类型 | 是否必填 | 示例 | 描述 |
api_count | NUMBER | 否 | - | API 数量 |
api_group_id | STRING | 否 | 3778911001abc | 分组标识（全局唯一） |
description | STRING | 否 | 这是一段描述信息 | 描述 |
domain_name | STRING | 否 | - | 域名 |
gmt_create | DATE | 否 | 2018-10-10T10:10:00Z | 创建时间 |
gmt_modified | DATE | 否 | 2018-10-10T10:10:00Z | 更改时间 |
group_name | STRING | 否 | test_group | 分组名 |
operator | STRING | 否 | scott | 创建人 |
tenant_id | STRING | 否 | TSCPDICNT | 租户标识 |
workspace_id | STRING | 否 | default | 工作空间标识 |
ApiGroupQueryVO
名称 | 类型 | 是否必填 | 示例 | 描述 |
page_info | PageInfo | 否 | - | 分页信息 |
query | ApiGroupVO | 否 | - | 查询 |
ApiGroupPagedListVO
名称 | 类型 | 是否必填 | 示例 | 描述 |
list | ARRAY[ApiGroupVO] | 否 | - | 当前页的数据 |
page_info | PageInfo | 否 | - | 分页信息 |
RouterInfoVO
名称 | 类型 | 是否必填 | 示例 | 描述 |
api_count | NUMBER | 否 | - | API 数量 |
can_delete | BOOLEAN | 否 | true, false | 是否可以删除 |
gmt_create | DATE | 否 | 2018-10-10T10:10:00Z | 创建时间 |
gmt_modified | DATE | 否 | 2018-10-10T10:10:00Z | 更改时间 |
operator | STRING | 否 | scott | operator |
router_configs | ARRAY[RouterConfigVO] | 否 | - | routerConfigs |
router_id | STRING | 否 | 8Amfi67dmE9wpY46 |
|
router_name | STRING | 否 | router_name1 | routerName |
router_type | STRING | 否 | PATH / HEADER / WEIGHT | routerType |
upstream_protocol | STRING | 否 | HTTP / SOFA / SOFA_VPC | 后端协议类型 |
RouterInfoQueryVO
名称 | 类型 | 是否必填 | 示例 | 描述 |
page_info | PageInfo | 否 | - | 分页信息 |
query | RouterInfoVO | 否 | - | 查询 |
RouterInfoPagedListVO
名称 | 类型 | 是否必填 | 示例 | 描述 |
list | ARRAY[RouterInfoVO] | 否 | - | list |
page_info | PageInfo | 否 | - | 分页信息 |
RouterConfigVO
名称 | 类型 | 是否必填 | 示例 | 描述 |
arg_key | STRING | 否 | arg_key1 | argKey |
arg_value | STRING | 否 | arg_value1 | argValue |
match_type | STRING | 否 | IN /EQUAL | 匹配方式 |
router_type | STRING | 否 | PATH / HEADER / WEIGHT | router_type |
system_cluster | SystemClusterVO | 否 | - | 系统集群 |
sys_id | STRING | 否 | z8qkEoU6QlfNQlsQ | sys_id |
weight | NUMBER | 否 | - | 权重 |
ContactInfoVO
名称 | 类型 | 是否必填 | 示例 | 描述 |
auth_app_info_id | STRING | 否 | a0VIPBXUI4rc25gR | 授权应用 ID |
company | STRING | 否 | antfinancial | 公司名称 |
contact_id | STRING | 否 | a0VIPBcUI4rd25gR | 联系方式标识 |
gmt_create | DATE | 否 | 2018-10-10T10:10:00Z | 创建时间 |
gmt_modified | DATE | 否 | 2018-10-10T10:10:00Z | 更新时间 |
STRING | 否 | kelly.cq@antxxx.com | 电子邮箱 | |
name | STRING | 否 | kelly | 联系人姓名 |
tel | STRING | 否 | 0571-812xxxxx | 电话号码 |
tenant_id | STRING | 否 | TSCPDICNT | 租户标识 |
workspace_id | STRING | 否 | default | 工作空间标识 |
ContactInfoQueryVO
名称 | 类型 | 是否必填 | 示例 | 描述 |
page_info | PageInfo | 否 | - | 分页信息 |
query | ContactInfoVO | 否 | - | 查询 |
ContactInfoPagedListVO
名称 | 类型 | 是否必填 | 示例 | 描述 |
list | ARRAY[ContactInfoVO] | 否 | - | 联系方式列表 |
page_info | PageInfo | 否 | - | 分页信息 |
PageInfo
名称 | 类型 | 是否必填 | 示例 | 描述 |
order_infos | ARRAY[OrderInfo] | 否 | - | 排序信息 |
page_index | NUMBER | 否 | 2 | 当前页 |
page_size | NUMBER | 否 | 10 | 每页记录数 |
total | NUMBER | 否 | 10 | 总数 |
EncryptConfigVO
名称 | 类型 | 是否必填 | 示例 | 描述 |
app_id | STRING | 否 | app1 | app_id |
encrypt_type | STRING | 否 | NONE / RSA / ECC / SM | 加密算法 |
key_pair | STRING | 否 | keypair1 | key_pair |
private_key | STRING | 否 | key1 | private_key |
pub_key | STRING | 否 | key1 | pub_key |
workspace_id | STRING | 否 | default | 工作空间 ID |
OrderInfo
名称 | 类型 | 是否必填 | 示例 | 描述 |
key | STRING | 是 | groupName | 要排序的字段 |
order | STRING | 是 | asc / desc | 升序或降序 |
ActionResult
名称 | 类型 | 是否必填 | 示例 | 描述 |
code | STRING | 否 | code1 | 错误码 |
error_message | STRING | 否 | error_message1 | 报错信息 |
id | STRING | 否 | id1 | id |
success | BOOLEAN | 否 | true, false | 是否挂载成功 |
BatchActionResult
名称 | 类型 | 是否必填 | 示例 | 描述 |
failed_count | NUMBER | 否 | 5 | failed_count |
results | ARRAY[ActionResult] | 否 | - | 批量挂载结果 |
success_count | NUMBER | 否 | 5 | success_count |
total_count | NUMBER | 否 | 10 | total_count |
CorsInfoVO
名称 | 类型 | 是否必填 | 示例 | 描述 |
allow_credentials | BOOLEAN | 否 | true, false | 是否允许发送 COOKIE |
allow_headers | ARRAY[STRING] | 否 | - | 允许的 request headers |
allow_methods | ARRAY[STRING] | 否 | - | 允许的 http method |
allow_origins | ARRAY[STRING] | 否 | - | 允许的 ORIGIN |
api_count | NUMBER | 否 | 2 | API 数量 |
cors_id | STRING | 否 | cors_id1 | CORS 标识 |
cors_name | STRING | 否 | cors_name1 | CORS 名称 |
cors_scop | STRING | 否 | WORKSPACE/API | cors_scop |
cors_status | STRING | 否 | CLOSED/OPENED | CORS 状态 |
expose_headers | ARRAY[STRING] | 否 | - | 允许暴露的 response header |
gmt_create | DATE | 否 | 2018-10-10T10:10:00Z | 创建时间 |
gmt_modified | DATE | 否 | 2018-10-10T10:10:00Z | 更新时间 |
max_age | NUMBER | 否 | 10 | 预检请求的有效期 |
operator | STRING | 否 | scott | 创建人 |
tenant_id | STRING | 否 | TSCPDICNT | 租户标识 |
workspace_id | STRING | 否 | default | 工作空间标识 |
CorsInfoQueryVO
名称 | 类型 | 是否必填 | 示例 | 描述 |
page_info | PageInfo | 否 | - | 分页信息 |
query | CorsInfoVO | 否 | - | 查询 |
CorsInfoPagedListVO
名称 | 类型 | 是否必填 | 示例 | 描述 |
list | ARRAY[CorsInfoVO] | 否 | - | CORS 列表 |
page_info | PageInfo | 否 | - | 分页信息 |
ApiCacheVO
名称 | 类型 | 是否必填 | 示例 | 描述 |
cache_keys | ARRAY[ApiCacheKeyVO] | 否 | - | 缓存键值 |
need_cache | BOOLEAN | 否 | true, false | 是否需要缓存 |
ttl | NUMBER | 否 | 10000 | TTL |
ApiCacheKeyVO
名称 | 类型 | 是否必填 | 示例 | 描述 |
key | STRING | 否 | key1 | 缓存键值 |
location | STRING | 否 | HEADER/QUERY/BODY | 缓存位置 |
LimitConfigVO
名称 | 类型 | 是否必填 | 示例 | 描述 |
limit | NUMBER | 否 | - | 限制阈值 |
limit_rsp_type | STRING | 否 | DEFAULT/MSG | 限制响应类型 |
need_limit | BOOLEAN | 否 | true, false | 是否需要限制 |
rsp_msg | STRING | 否 | rsp_msg1 | 响应信息 |
ApiTestReqVO
名称 | 类型 | 是否必填 | 示例 | 描述 |
api_id | STRING | 否 | api_id1 | API 标识 |
app_id | STRING | 否 | app_id1 | 应用标识 |
auth_app_info_id | STRING | 否 | auth_app_info_id1 | 授权应用 ID |
params | ARRAY[ApiTestParamVO] | 否 | - | API 调试参数 |
payload | STRING | 否 | payload1 | payload |
tenant_id | STRING | 否 | tenant_id | 租户标识 |
workspace_id | STRING | 否 | default | 工作空间标识 |
ApiTestRspVO
名称 | 类型 | 是否必填 | 示例 | 描述 |
code | STRING | 否 | code1 | code |
cost | NUMBER | 否 | 1000 | cost |
headers | ARRAY[ApiTestParamVO] | 否 | - | headers |
payload | STRING | 否 | payload1 | payload |
size | NUMBER | 否 | 1000 | size |
ApiTestParamVO
名称 | 类型 | 是否必填 | 示例 | 描述 |
key | STRING | 否 | key1 | 键值 |
location | STRING | 否 | HEADER/QUERY | 位置 |
value | STRING | 否 | value1 | 值 |
MonitorData
名称 | 类型 | 是否必填 | 示例 | 描述 |
timestamp | NUMBER | 否 | - | 时间点 |
value | NUMBER | 否 | - | 值 |
MonitoryRequest
名称 | 类型 | 是否必填 | 示例 | 描述 |
api_id | STRING | 否 | h4ZWfWe9anCJn4Tye3tPMiGJZJ2PeGWq | API标识 |
app_id | STRING | 否 | Oo2llCf0MkkhGtgL | 应用 ID |
code | STRING | 否 | code1 | 密码 |
end_time | NUMBER | 否 | - | 结束时间 |
start_time | NUMBER | 否 | - | 开始时间 |
MonitoryAggregationVO
名称 | 类型 | 是否必填 | 示例 | 描述 |
byte_in | ARRAY[MonitorData] | 否 | - | 字节导入 |
byte_out | ARRAY[MonitorData] | 否 | - | 字节导出 |
err_code | ARRAY[MonitorData] | 否 | - | 错误码 |
err_rate | ARRAY[MonitorData] | 否 | - | 错误率 |
invoke_num | ARRAY[MonitorData] | 否 | - | invoke数值 |
qps | ARRAY[MonitorData] | 否 | - | qps值 |
rt | ARRAY[MonitorData] | 否 | - | rt值 |