对象模型

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

表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	否
response_id	String	分组自定义响应ID	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	否

表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	是

**表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	-

父主题： API管理