检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
布的环境名称。 API认证鉴权 如果使用APP认证,Key和Secret是否正确。 API控制策略 访问控制策略是否设置正确。 是否超过了流量控制范围。系统默认的流控策略是单个API的访问不超过200次/秒,如果您未创建流控策略,API网关会执行默认流控策略。您可以在实例控制台“
为什么跨域调用API失败? 可能原因 API的跨域共享配置不正确。 解决方法 检查是否开启CORS。 进入API详情,单击“编辑”,查看是否开启CORS。如果没开启CORS,请开启。 检查是否创建OPTIONS方式的API,每个分组只需创建一个OPTIONS方式的API。 参数配置如下:
bandwidth_charging_mode 否 String 出公网带宽计费类型: bandwidth:按带宽计费 traffic:按流量计费 缺省值:bandwidth 响应参数 状态码: 400 表4 响应Body参数 参数 参数类型 描述 error_code String
对象模型 本节介绍环境变量的对象模型,如下表所示: “操作类型”用于描述字段的属性,表示对应字段的值可进行的操作: C:创建;U:更新;R:读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 表1 环境变量对象模型 参数 类型 说明 操作类型 是否必选
对象模型 本节介绍流控策略与API的绑定关系的对象模型,如下表所示。 “操作类型”用于描述字段的属性,表示对应字段的值可进行的操作: C:创建;U:更新;R:读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 表1 流控策略限定关系对象模型 参数
对象模型 本节介绍特殊流控的对象模型,如下表所示: “操作类型”用于描述字段的属性,表示对应字段的值可进行的操作: C:创建;U:更新;R:读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 表1 特殊流控对象模型 参数 类型 说明 操作类型 是否必选
对象模型 API发布后,如果不想API被某些IP地址访问到,可以将这些IP地址加入黑名单,或者想API被某些特性的IP地址访问到,也可以将这些IP地址加入白名单。这样可以提高API的访问安全性,保护API免受攻击。本节介绍API的黑白名单(ACL策略)管理的对象模型,如表1 ACL策略对象模型所示。
对象模型 本节介绍VPC通道的对象模型。 “操作类型”用于描述字段的属性,表示对应字段的值可进行的操作: C:创建;U:更新;R:读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 表1 VPC通道对象模型 参数 类型 说明 操作类型 是否必选
后端双向认证。在创建API时,配置双向认证,在API网关和后端服务间启用双向认证。配置请参考创建API章节中的“TLS双向认证”参数说明。 共享版:不支持,API网关仅做HTTPS的单向认证。 父主题: API认证
为后端服务,在API网关中开放API,提供给API调用者使用。 如果当前实例不支持“导入CCE工作负载”,请联系客服。 注意事项 仅支持华为云CCE Turbo集群、VPC网络模型的CCE集群。 您需要确保当前实例与CCE集群所属同一个VPC中,或通过其他方式保证两者网络可达,否则导入后调用API会出现失败场景。
查看专享版实例详情 功能介绍 查看专享版实例详情 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String
API的描述信息 schemes 是 Object API的请求协议对象数组定义,支持http、https tags 否 Object API标签对象数组定义 parameters 否 Object 请求参数对象数组定义,参考表 前端parameters参数说明 responses
API的描述信息 schemes 是 Object API的请求协议对象数组定义,支持http、https tags 否 Object API标签对象数组定义 parameters 否 Object 请求参数对象数组定义,参考表 前端parameters参数说明 responses
plugin_type String 插件类型。 cors:跨域资源共享 set_resp_headers:HTTP响应头管理 kafka_log:Kafka日志推送 breaker:断路器 rate_limit: 流量控制 third_auth: 第三方认证 proxy_cache:
plugin_type String 插件类型。 cors:跨域资源共享 set_resp_headers:HTTP响应头管理 kafka_log:Kafka日志推送 breaker:断路器 rate_limit: 流量控制 third_auth: 第三方认证 proxy_cache:
bandwidth_charging_mode 否 String 入公网带宽计费类型: bandwidth:按带宽计费 traffic:按流量计费 缺省值:bandwidth 响应参数 状态码: 202 表4 响应Body参数 参数 参数类型 描述 instance_id String
bandwidth_charging_mode 否 String 入公网带宽计费类型: bandwidth:按带宽计费 traffic:按流量计费 缺省值:bandwidth 响应参数 状态码: 202 表4 响应Body参数 参数 参数类型 描述 instance_id String
对响应请求使用gzip压缩,用于减少公网流量。默认未配置gzip压缩,配置后1分钟生效,请谨慎修改。 启用后,可配置comp_level参数,comp_level表示压缩级别,值越大表示性能消耗越大,一般默认为6。 须知: 响应请求体大于1KB时,您可以使用gzip压缩文件(即1KB以下的文件不做压缩)。
API调用是否存在带宽限制 共享版API网关按照流控策略以及单个请求的最大Body体(12M)进行管控,没有直接限制带宽。 专享版API网关存在带宽限制,在创建实例时可以选择公网入口以及出口带宽。 父主题: API策略
子域名:所在分组的调试域名。 路径:需要根据实际业务从以下三种配置方式中选择配置。 / /{包名}.{服务名} /{包名}.{服务名}/{方法名} 说明: 包名、服务名、方法名从proto文件中获取。 当前端路径设置“/{包名}.{服务名}/{方法名}”时,API的匹配模式才可以使用“绝对匹配”。