API网关 APIGAPI网关 APIG

更新时间:2021/09/29 GMT+08:00
分享

对象模型

本节介绍API及后端服务的对象模型。

  • “操作类型”用于描述字段的属性,表示对应字段的值可进行的操作:

    C:创建;U:更新;R:读取。

  • “是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。
表1 API对象模型

参数

类型

说明

操作类型

是否必选

id

String

API的编号

R

-

name

String

API的名称

CRU

group_id

String

API所属分组的编号

CR

type

Integer

API的类型:

  • 1:公有API
  • 2:私有API

CRU

status

Integer

API的状态:

  • 1:启用
  • 2:禁用
  • 3:已删除

默认1

该字段已废弃

R

-

version

String

API的版本

CRU

req_protocol

String

API的访问协议

  • HTTP
  • HTTPS
  • BOTH:同时支持HTTP和HTTPS

默认:HTTPS

CRU

req_method

String

API的访问方式

  • GET
  • POST
  • PUT
  • DELETE
  • HEAD
  • PATCH
  • OPTIONS
  • ANY

CRU

req_uri

String

API的访问地址,不含域名、端口号、请求协议等,是URI

CRU

auth_type

String

API的认证方式

  • NONE:无认证
  • APP:APP认证
  • IAM:IAM认证
  • AUTHORIZER:自定义认证

CRU

authorizer_id

String

前端自定义认证对象的ID

CRU

match_mode

String

API的路由匹配方式:

  • SWA:前缀匹配
  • NORMAL:正常匹配

CRU

arrange_necessary

Integer

是否需要编排

  • 1:是
  • 2:否

目前默认为:2

R

-

backend_type

String

后端服务类型:

  • HTTP:web后端
  • FUNCTION:函数服务
  • MOCK: MOCK

CRU

register_time

Timestamp

API注册时间

R

-

update_time

Timestamp

API修改时间

R

-

remark

String

API描述

CRU

tag

String

API标签

CRU

cors

String

是否支持跨域

  • TRUE 支持
  • FALSE 不支持

默认:FALSE

CRU

表2 web后端对象模型

参数

类型

说明

操作类型

是否必选

id

String

编号

R

-

status

Integer

状态:

  • 1:启用
  • 2:禁用
  • 3:已删除

默认1

该字段已废弃

R

-

version

String

版本

CRU

url_domain

String

后端endpoint

CRU

req_protocol

String

访问协议

  • HTTP
  • HTTPS

CRU

req_method

String

请求方式

  • GET
  • POST
  • PUT
  • DELETE
  • HEAD
  • PATCH
  • OPTIONS
  • ANY

CRU

req_uri

String

访问地址,是URI

CRU

timeout

Integer

超时时间,单位:毫秒(1-60000)

CRU

front_api_id

String

对应的API编号

R

-

register_time

Timestamp

注册时间

R

-

update_time

Timestamp

修改时间

R

-

remark

String

描述

CRU

vpc_status

Integer

是否使用VPC通道

  • 1:使用
  • 2:不使用

CRU

否,默认不使用

vpc_info

String

VPC通道信息

CRU

如果vpc_status=1,即:使用VPC通道,则该字段必填

authorizer_id

String

后端自定义认证对象的ID

CRU

表3 MOCK后端对象模型

参数

类型

说明

操作类型

是否必选

id

String

编号

R

-

front_api_id

String

对应的API编号

R

-

status

Integer

状态:

  • 1:启用
  • 2:禁用
  • 3:已删除

默认1

该字段已废弃

R

-

version

String

版本

CRU

result_content

String

返回结果

CRU

register_time

Timestamp

注册时间

R

-

update_time

Timestamp

修改时间

R

-

remark

String

描述

CRU

表4 函数工作流对象模型

参数

类型

说明

操作类型

是否必选

id

String

编号

R

-

front_api_id

String

对应的API编号

R

-

status

Integer

状态:

  • 1:启用
  • 2:禁用
  • 3:已删除

默认1

该字段已废弃

R

-

version

String

函数版本号

CRU

function_urn

String

函数的URN

CRU

invocation_type

String

函数类型:async|sync(异步|同步)

CRU

timeout

Integer

超时时间(1-60000),单位:毫秒

CRU

register_time

Date

注册时间

R

-

update_time

Date

修改时间

R

-

remark

String

描述

CRU

表5 请求参数对象模型

参数

类型

说明

操作类型

是否必选

id

String

编号

R

-

front_api_id

String

对应的API编号

R

-

name

String

参数名称

CRU

type

String

参数类型:

  • string
  • number

CRU

location

String

参数位置:

  • PATH
  • QUERY
  • HEADER
  • FORMDATA

CRU

default_value

String

参数默认值

CRU

sample_value

String

参数示例值

CRU

required

Integer

参数是否必须:

  • 1:是
  • 2:否

CRU

valid_enable

Integer

是否开启参数校验:

  • 1:是
  • 2:否

CRU

remark

String

参数描述

CRU

enumerations

String

参数枚举值

CRU

min_num

String

参数最小值

CRU

max_num

String

参数最大值

CRU

min_size

Integer

参数最小长度

CRU

max_size

Integer

参数最大长度

CRU

regular

String

正则校验规则(暂不支持)

CRU

json_schema

String

JSON校验规则(暂不支持)

CRU

表6 后端参数对象模型

参数

类型

说明

操作类型

是否必选

id

String

编号

R

-

front_api_id

String

对应的API编号

R

-

req_param_id

String

对应的请求参数的编号

R

-

name

String

参数名称

CRU

location

String

参数位置:

  • PATH
  • QUERY
  • HEADER
  • FORMDATA

CRU

origin

String

参数类型:

  • REQUEST
  • CONSTANT
  • SYSTEM

CRU

value

String

参数值:

  • 类型为REQUEST时,值为请求参数的参数名称。
  • 类型为SYSTEM时,值为网关参数名称。
  • 类别为CONSTANT时,值为参数真正的值。

CRU

remark

String

描述

CRU

policy_id

String

关联的策略条件编号

CRU

表7 WEB策略后端对象模型

参数

类型

说明

操作类型

是否必选

id

String

编号

R

-

front_api_id

String

对应的API编号

R

-

name

String

策略后端名称

CRU

url_domain

String

后端endpoint

CRU

req_protocol

String

访问协议

  • HTTP
  • HTTPS

CRU

req_method

String

请求方式

  • GET
  • POST
  • PUT
  • DELETE
  • HEAD
  • PATCH
  • OPTIONS
  • ANY

CRU

req_uri

String

访问地址,是URI

CRU

timeout

Integer

超时时间,单位:毫秒(1-60000)

CRU

vpc_status

Integer

是否使用VPC通道

  • 1:使用
  • 2:不使用

CRU

否,默认不使用

vpc_info

String

VPC通道信息

CRU

如果vpc_status=1,即:使用VPC通道,则该字段必填

effect_mode

String

关联的策略组合模式

  • ALL
  • ANY

CRU

表8 MOCK策略后端对象模型

参数

类型

说明

操作类型

是否必选

id

String

编号

R

-

front_api_id

String

对应的API编号

R

-

name

String

策略后端名称

CRU

result_content

String

返回结果

CRU

effect_mode

String

关联的策略组合模式

  • ALL
  • ANY

CRU

表9 函数工作流策略后端对象模型

参数

类型

说明

操作类型

是否必选

id

String

编号

R

-

front_api_id

String

对应的API编号

R

-

name

String

策略后端名称

CRU

version

String

函数版本号

CRU

function_urn

String

函数的URN

CRU

invocation_type

String

函数类型:async|sync(异步|同步)

CRU

timeout

Integer

超时时间(1-60000),单位:毫秒

CRU

effect_mode

String

关联的策略组合模式

  • ALL
  • ANY

CRU

表10 策略后端条件对象模型

参数

类型

说明

操作类型

是否必选

id

String

策略后端条件对象的编号

R

-

condition_type

String

策略条件:

  • exact:绝对匹配
  • enum:枚举
  • pattern:正则

CRU

condition_value

String

策略值

CRU

condition_origin

String

策略类型:

  • param:参数
  • source:源IP

CRU

req_param_id

String

关联的请求参数对象编号

R

-

policy_backend_id

String

关联的策略后端对象编号

CRU

表11 认证方式参数对象模型

参数

类型

说明

操作类型

是否必选

app_code_auth_type

String

AppCode简易认证类型,仅在auth_type为APP时生效,默认为DISABLE:

  • DISABLE:不开启简易认证
  • HEADER:开启简易认证且AppCode位置在HEADER

CRU

-

分享:

    相关文档

    相关产品