检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
在“API运行”页面单击“调试”,调试已创建的API。 响应结果中显示“200 OK”,表示API调用成功,并且返回值中有“策略后端”字样,表示设置的策略后端的匹配条件成功匹配到前端自定义认证函数返回体中的context字段中的键值对,API调用策略后端成功。否则,请参考错误码章节处理。 在“API运行”页面,单击“编辑”,进入API设置页面。
您需保证当前实例与微服务实例地址网络可达,否则导入后调用API会出现失败场景。 未选择服务契约时,导入后会生成一个请求方法为ANY、请求路径为/且匹配模式为前缀匹配的API。 导入后会生成相应的API以及微服务类型的负载通道,负载通道会监测微服务下所有在线实例的地址变化,并更新到负载通道中。 前提条件
是否支持跨域 TRUE:支持 FALSE:不支持 缺省值:false match_mode String API的匹配方式 SWA:前缀匹配 NORMAL:正常匹配(绝对匹配) 默认:NORMAL backend_type String 后端类型 HTTP:web后端 FUNCTIO
authorizer_id String 前端自定义认证对象的ID CRU 否 match_mode String API的路由匹配方式: SWA:前缀匹配 NORMAL:正常匹配 CRU 是 arrange_necessary Integer 是否需要编排 1:是 2:否 目前默认为:2 R
authorizer_id String 前端自定义认证对象的ID CRU 否 match_mode String API的路由匹配方式: SWA:前缀匹配 NORMAL:正常匹配 CRU 是 arrange_necessary Integer 是否需要编排 1:是 2:否 目前默认为:2 R
ORCHESTRATION_PARAMETER_NOT_FOUND: 没有入参进行参数编排规则匹配,参数编排失败 ORCHESTRATION_FAILURE: 有入参进行参数编排规则匹配,但是匹配不上编排规则,参数编排失败 每项错误类型均为一个JSON体 表4 ResponseInfo
ORCHESTRATION_PARAMETER_NOT_FOUND: 没有入参进行参数编排规则匹配,参数编排失败 ORCHESTRATION_FAILURE: 有入参进行参数编排规则匹配,但是匹配不上编排规则,参数编排失败 每项错误类型均为一个JSON体 表4 ResponseInfo
ORCHESTRATION_PARAMETER_NOT_FOUND: 没有入参进行参数编排规则匹配,参数编排失败 ORCHESTRATION_FAILURE: 有入参进行参数编排规则匹配,但是匹配不上编排规则,参数编排失败 每项错误类型均为一个JSON体 id String 响应ID default
请求协议:选择与已开启CORS的API相同的请求协议。 请求路径:选择与已开启CORS的API相同的请求路径或者与已开启CORS的API匹配的请求路径。 匹配模式:选择前缀匹配。 安全认证:“无认证”模式安全级别低,所有用户均可访问,不推荐使用。 支持跨域CORS:勾选。 父主题: 开放API
例如,2018年8月1日发布在RELEASE环境的API匹配模式设置为“绝对匹配”,2018年8月20日修改API匹配模式设置为“前缀匹配”,并发布到RELEASE环境。然后设置2018年8月1日发布的版本为当前版本,此时API调用者调用此API时,API的匹配模式为“绝对匹配”。 发布API相关的FAQ 对API的修改是否需要重新发布?
reeter服务名。 网关响应 API网关未能成功处理API请求,从而产生的错误响应。 默认的网关响应为“default”。 匹配模式 此处选择“前缀匹配”。 安全认证 选择API认证方式,此处选择“无认证”。(无认证模式,安全级别低,所有用户均可访问,不推荐在实际业务中使用)
例如,2018年8月1日发布在RELEASE环境的API匹配模式设置为“绝对匹配”,2018年8月20日修改API匹配模式设置为“前缀匹配”,并发布到RELEASE环境。然后设置2018年8月1日发布的版本为当前版本,此时API调用者调用此API时,API的匹配模式为“绝对匹配”。 发布API相关的FAQ 对API的修改是否需要重新发布?
ORCHESTRATION_PARAMETER_NOT_FOUND: 没有入参进行参数编排规则匹配,参数编排失败 ORCHESTRATION_FAILURE: 有入参进行参数编排规则匹配,但是匹配不上编排规则,参数编排失败 每项错误类型均为一个JSON体 id String 响应ID default
误 后端不可用 502 后端不可用,网络不可达错误 默认4XX - 其它4XX类错误 默认5XX - 其它5XX类错误 未找到匹配的API 404 未匹配到API 请求参数错误 400 请求参数校验失败、不支持的HTTP方法 调用次数超出阈值 429 API调用次数超出所配置的流量策略阈值
member_group_name 否 String VPC通道后端云服务组的名称 precise_search 否 String 指定需要精确匹配查找的参数名称,多个参数需要支持精确匹配时参数之间使用“,”隔开。 当前支持member_group_name。 请求参数 表3 请求Header参数 参数 是否必选
member_group_id 否 String 后端服务器组编号 precise_search 否 String 指定需要精确匹配查找的参数名称,多个参数需要支持精确匹配时参数之间使用“,”隔开。 目前支持name,member_group_name。 请求参数 表3 请求Header参数
55个字符。 API路径 API的请求路径。请求路径可以包含请求参数,请求参数使用{}标识,例如/a/{b},也可以通过配置“+”号做前缀匹配,例如:/a/{b+}。注意,请求路径中的字母区分大小写。 后续操作 API克隆完成后,通过调试API,验证服务是否正常。 父主题: 管理API
参数名称 说明 协议 仅在“请求协议”为“HTTP&HTTPS”时,支持修改。 方法 仅在“Method”为“ANY”时,支持修改。 路径 仅在“匹配模式”为“前缀模式”时,支持自定义路径。 路径参数 仅在“Path”中存在“{}”时,支持修改。 请求头 HTTP Headers的参数与参数值。
String API的访问地址。 type = path时必填 match_mode 否 String API的匹配方式 SWA:前缀匹配 NORMAL:正常匹配(绝对匹配) type = path时必填 group_id 否 String 分组ID。 校验分组下API定义是否重复时必填
Array of TmsMatchesKeyValue objects 搜索字段,key为要匹配的字段,当前限定为resource_name。value为匹配的值。 根据key的值确认是否需要模糊匹配,如resource_name需要实现前缀搜索。 表4 TmsKeyValues 参数