全部产品

结构体说明

更新时间:2020-04-21 11:33:46

本文介绍 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 - query

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 subAppCompany
sub_app_desc STRING sub_app_desc1 subAppDesc
sub_app_id STRING sub_app_id 订阅方应 ID
sub_app_info AppInfoVO - sub_app_info
sub_tenant_id STRING sub_tenant_id1 subTenantId
sub_workspace_id STRING sub_workspace_id1 subWorkspaceId

AuthAppInfoQueryVO

名称 类型 是否必填 示例 描述
page_info PageInfo - 分页信息
query AuthAppInfoVO - query

AuthAppInfoPagedListVO

名称 类型 是否必填 示例 描述
list ARRAY[AuthAppInfoVO] - list
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_create
gmt_modified DATE 2018-10-10T10:10:00Z gmt_modified
host ARRAY[STRING] 系统host地址
lb_type STRING RAMDOM / ROUND_ROBIN 负载均衡策略类型
operator STRING scott 创建人
sys_id STRING 8Amfi67dmE9wpY46 sys_id
sys_name STRING test_sys sys_name
sys_type STRING URL / SOFA 系统类型(手工配置/SOFA 注册中心/ZooKeeper)
tenant_id STRING TSCPDICNT tenant_id
upstream_protocol STRING HTTP / MRPC / SOFA upstream_protocol
workspace_id STRING default workspace_id

SystemClusterQueryVO

名称 类型 是否必填 示例 描述
page_info PageInfo - page_info
query SystemClusterVO - query

SystemClusterPagedListVO

名称 类型 是否必填 示例 描述
list ARRAY[SystemClusterVO] - list
page_info PageInfo - page_info

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 contentType
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 超时时间
upstream_path STRING upstream_path1 upstreamPath
upstream_protocol STRING HTTP / MRPC / SOFA / SOFA_VPC 后端协议类型
upstream_type STRING NONE / MOCK / SYSTEM_CLUSTER 后端服务类型
workspace_id STRING default 工作空间标识

ApiInfoQueryVO

名称 类型 是否必填 示例 描述
page_info PageInfo - 分页信息
query ApiInfoVO - query

ApiInfoPagedListVO

名称 类型 是否必填 示例 描述
list ARRAY[ApiInfoVO] - list
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 https://3grofekygwdqrddt.shprod.antfinapigw.com-east-2 域名
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 - page_info
query ApiGroupVO - query

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_id
router_name STRING router_name1 routerName
router_type STRING PATH / HEADER / WEIGHT routerType
upstream_protocol STRING HTTP / MRPC / SOFA / SOFA_VPC 后端协议类型

RouterInfoQueryVO

名称 类型 是否必填 示例 描述
page_info PageInfo - 分页信息
query RouterInfoVO - query

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 更新时间
mail STRING kelly.cq@antfin.com 电子邮箱
name STRING kelly 联系人姓名
tel STRING 0571-81234567 电话号码
tenant_id STRING TSCPDICNT 租户标识
workspace_id STRING default 工作空间标识

ContactInfoQueryVO

名称 类型 是否必填 示例 描述
page_info PageInfo - 分页信息
query ContactInfoVO - query

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] - 允许暴露的 reponse 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 - query

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 value

MonitorData

名称 类型 是否必填 示例 描述
timestamp NUMBER - 时间点
value NUMBER - value

MonitoryRequest

名称 类型 是否必填 示例 描述
api_id STRING h4ZWfWe9anCJn4Tye3tPMiGJZJ2PeGWq API标识
app_id STRING Oo2llCf0MkkhGtgL 应用 ID
code STRING code1 code
end_time NUMBER - 结束时间
start_time NUMBER - 开始时间

MonitoryAggregationVO

名称 类型 是否必填 示例 描述
byte_in ARRAY[MonitorData] - byte_in
byte_out ARRAY[MonitorData] - byte_out
err_code ARRAY[MonitorData] - 错误码
err_rate ARRAY[MonitorData] - 错误率
invoke_num ARRAY[MonitorData] - invoke_num
qps ARRAY[MonitorData] - qps
rt ARRAY[MonitorData] - rt