资源编排服务 RFS-APIG.API:模型属性

时间：2025-02-12 14:53:03

资源编排服务 RFS

模型属性

表1 模型定义属性说明
属性	是否必选	描述
mockInfo	否	mock后端详情参数类型：APIG.MockInfo 取值说明：详见datatype定义默认值：{} 使用建议：无
reqMethod	是	API的请求方式参数类型：string 取值说明：支持Method类型包括：GET, POST, PATCH, DELETE, OPTIONS, PUT, HEAD, ANY 默认值：GET 取值约束：可取"GET", "POST", "DELETE", "PUT", "PATCH", "HEAD", "OPTIONS", "ANY" 使用建议：无
name	是	API分组的名称参数类型：string 取值说明：用户自定义取值约束：长度为3 - 64位的字符串，字符串由中文、英文字母、数字、_ 组成,且以英文字母开头使用建议：无
backendType	是	后端类型参数类型：string 取值说明：HTTP：web后端，FUNCTION：函数工作流，MOCK：模拟的后端默认值：HTTP 取值约束：可取"HTTP", "FUNCTION", "MOCK" 使用建议：无
remark	否	API描述参数类型：string 取值说明：API描述，字符长度不超过255 取值约束：长度不超过255 使用建议：无
backendApi	否	web后端详情参数类型：APIG.BackendApi 取值说明：详见datatype定义默认值：{u'reqUri': u'unset', u'reqMethod': u'GET', u'urlDomain': u'unset', u'reqProtocol': u'HTTP'} 使用建议：无
groupId	是	API所属的API分组参数类型：HuaweiCloud.APIG.ApiGroup.Id 取值说明：支持使用已有或新建API分组。如果使用新建的，需在模板中定义API分组对象并建立依赖关系。建议通过拖拽到API分组内自动生成使用建议：1. 将该字段通过get_input函数传入，在AOS界面创建堆栈填写输入参数时可自动选择2. 通过get_reference获取由本堆栈创建的APIG.ApiGroup元素，使用设计器建立依赖关系时会自动指定3. 在APIG服务界面获取已经创建好的API分组ID
reqUri	是	API的访问地址参数类型：string 取值说明：API的访问地址取值约束：长度不超过255 使用建议：需要服从URI规范
authType	是	API的认证方式参数类型：string 取值说明：NONE：无认证，APP：APP认证， IAM ：IAM认证默认值：IAM 取值约束：可取NONE，APP，IAM 使用建议：推荐使用IAM认证方式
matchMode	是	API的匹配方式参数类型：string 取值说明：SWA：前缀匹配，NORMAL：正常匹配（绝对匹配）默认值：NORMAL 取值约束：可取"SWA", "NORMAL" 使用建议：无
cors	是	是否支持跨域访问参数类型：boolean 取值说明：true-支持跨域访问；false-不支持跨域访问默认值：False 使用建议：从安全角度考虑，一般不建议开启跨域访问，除非业务需要
funcInfo	否	函数计算后端详情参数类型：APIG.FuncInfo 取值说明：详见datatype定义默认值：{u'functionUrn': u'', u'invocationType': u'async'} 使用建议：无
type	是	API类型参数类型：string 取值说明：public-公有API，private-私有API 默认值：public 取值约束：可取"public", "private" 使用建议：无
strategyId	否	API所使用的流程策略参数类型：string 取值说明：支持使用已有或新建流控策略。如果使用新建的，需在模板中定义API策略对象并建立依赖关系。建议通过拖拽连接API与API策略对接实现使用建议：1. 将该字段通过get_input函数传入，在AOS界面创建堆栈填写输入参数时可自动选择2. 通过get_reference获取由本堆栈创建的APIG.Throttle元素，使用设计器建立依赖关系时会自动指定3. 在APIG服务界面获取已经创建好的API流控ID
reqProtocol	是	API的协议类型参数类型：string 取值说明：支持 HTTP 和 HTTPS 两种，HTTP-仅支持HTTP协议；HTTPS-仅支持HTTPS协议；BOTH-同时支持两种协议默认值：HTTP 取值约束：可取""HTTP", "HTTPS", "BOTH" 使用建议：如果涉及敏感信息的传递，建议使用HTTPS