检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
字符长度不超过255 origin类别为REQUEST时,此字段值为req_params中的参数名称; origin类别为CONSTANT时,此字段值为参数真正的值; origin类别为SYSTEM时,此字段值为系统参数名称,系统参数分为网关内置参数、前端认证参数和后端认证参数,当
过滤查询结果 查询资源列表时(例如,查询API列表),系统支持按照查询对象的属性过滤查询结果。 示例: GET /v1.0/apigw/apis?id=xxxx 父主题: 附录
API认证鉴权 如果使用APP认证,Key和Secret是否正确。 API控制策略 访问控制策略是否设置正确。 是否超过了流量控制范围。系统默认的流控策略是单个API的访问不超过200次/秒,如果您未创建流控策略,API网关会执行默认流控策略。
当请求到达网关时,由于API的流量控制、访问控制策略以及认证失败,网关直接返回的响应信息。有关网关响应的详细指导,请参考自定义API的错误响应信息。 一种是后端服务响应。响应信息由后端API服务(即API的提供者)定义,API网关只做透传。 父主题: 开放API
安全认证 选择API认证方式,此处选择“无认证”。(无认证模式,安全级别低,所有用户均可访问,不推荐在实际业务中使用) 单击“下一步”,配置后端信息。 表2 后端配置 参数 配置说明 后端服务类型 此处选择“HTTP&HTTPS”。
path:API请求的URI,系统默认配置。 method:API请求方法,系统默认配置。 Header:请求头的key值。建议不要设置敏感信息,以防泄露。 Query:QueryString的key值。 System:系统参数。 参数:用于判断与规则匹配中的参数值是否匹配。
权限获取请参考统一身份认证服务(IAM)的帮助指导。
在绑定域名前,您需要理解以下2个概念: 子域名:API分组创建后,系统为分组自动分配一个内部测试用的子域名,此子域名唯一且不可更改,每天最多可以访问1000次。 独立域名:您自定义的域名,最多可以添加5个独立域名,不限访问次数。API调用者通过访问独立域名来调用您开放的API。
安全认证 选择API认证方式,此处选择“无认证”。(无认证模式,安全级别低,所有用户均可访问,不推荐在实际业务中使用) 根据下表参数说明,配置后端信息。配置完成后,单击“完成”。 表2 后端配置 参数 配置说明 负载通道 选择“不使用”负载通道访问后端服务。
当用户的API采用http协议访问时,由于http没有传输安全与认证安全保障,可以使用API网关的重定向功能将API升级为安全的https协议访问,同时兼容已有的http协议。
表1 导入API 参数名称 说明 导入方式 导入方式包含以下2种: 生成新的分组:将API定义导入到一个新的分组,导入过程中系统会自动创建一个新的API分组,并将导入的API归属到该分组。
注意事项 仅支持导入未开启安全认证的微服务引擎。 您需保证当前实例与微服务实例地址网络可达,否则导入后调用API会出现失败场景。 未选择服务契约时,导入后会生成一个请求方法为ANY、请求路径为/且匹配模式为前缀匹配的API。
vpc_name_modifiable 负载通道名称是否可修改,默认可修改。 须知: 负载通道名称可修改时,当前实例的负载通道无法通过项目级负载通道管理接口操作。 app_jwt_enable app_jwt认证方式开关,默认关闭。
如果API未绑定流控策略,共享版API网关系统默认流控限制为200次/秒。 前提条件 需要绑定的API已发布。 创建流控策略 进入共享版控制台。 选择“开放API > 流量控制”,进入到流量控制信息页面。 单击“创建流控策略”,弹出“创建流控策略”对话框。输入如表1所示信息。
GB 测量对象:单个API 测量维度:api_id 1分钟 output_throughput 流出流量 该指标用于统计测量api接口返回流量 ≥0 单位:Byte/KB/MB/GB 测量对象:单个API 测量维度:api_id 1分钟 node_system_load 网关节点系统负载
否 - - - - - policy_sys_param 策略后端条件来源是否支持系统参数。 否 - - - - - breaker 是否支持断路器。
在CTS事件列表查看云审计事件 操作场景 用户进入云审计服务创建管理类追踪器后,系统开始记录云服务资源的操作。在创建数据类追踪器后,系统开始记录用户对OBS桶中数据的操作。云审计服务管理控制台会保存最近7天的操作记录。
账单上报周期 包年/包月计费模式的资源完成支付后,会实时上报一条账单到计费系统进行结算。 按需计费模式的资源按照固定周期上报使用量到计费系统进行结算。按需计费模式产品根据使用量类型的不同,分为按小时、按天、按月三种周期进行结算,具体扣费规则可以参考按需产品周期结算说明。
x 自定义认证数量 每个用户最多创建20个自定义认证。 √
表1 常用最佳实践 实践 描述 使用函数服务开发自定义认证 在API的安全认证方面,API网关提供IAM认证、APP认证等方式,帮助用户快速开放API,同时API网关也支持用户使用自己的认证方式(以下简称自定义认证),以便更好地兼容已有业务能力。