检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
基础定义:包括API前端请求定义和响应定义,不包括后端服务定义。其中API前端请求定义除了Swagger规范定义项外,还包括API网关的一些Swagger扩展字段。适用于生成Swagger或OpenAPI格式的API文档定义。 全量定义:包括API前端请求定义、后端服务定义和响应定义。适用于将API定
访问控制策略的IP地址不一定取客户端的IP地址。 APIG的访问控制是根据$remote_addr的值进行校验。$remote_addr代表客户端的IP,它的值是服务端根据客户端的IP指定的,当客户端访问APIG时,如果中间没有任何代理,那么就会把remote_addr设为客户端IP;如果使用了某个代理
创建的凭据绑定API后,才可以使用APP认证调用API。客户端(API调用者)在调用API过程中,把密钥对替换SDK中的密钥对,API网关服务根据密钥对进行身份核对,完成鉴权。关于使用APP认证的方法,具体请参考《开发指南》。 使用无认证、华为IAM认证的API、自定义认证,无需创建凭据。
自定义APIG的客户端访问端口 API网关提供自定义实例入端口功能,支持客户端通过不同的端口来访问不同的后端服务。 约束与限制 新增端口时,一个端口仅允许配置一种协议。当前仅支持HTTP和HTTPS协议。 独立域名与端口相关约束与限制内容,请参考约束与限制。 自定义客户端访问端口
境1中调用此API时,后端服务请求Path为“/Stage/test”。在环境2中创建了变量名“Path”,变量值“/Stage/AA”,则API在发布到环境2时,使用“/Stage/AA”代替“Path”,API调用者在环境2中调用此API时,后端服务请求Path为“/Stage/AA”。
在API网关提供的安全认证模式下,用户可根据业务需求,灵活实现自定义认证,保障API的安全性。 约束与限制 API网关支持的自定义认证需要借助函数工作流服务实现。 父主题: 使用APIG的APP认证和自定义认证实现API的双重认证
ppSecret)。将创建的应用绑定API后,才可以使用APP认证调用API。在API调用过程中,把密钥对替换SDK中的密钥对,API网关服务根据密钥对进行身份核对,完成鉴权。关于使用APP认证的方法,具体请参考《API网关开发指南》。 从云商店购买的API,系统自动创建一个应用,无需单独创建应用。
请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 orchestration_name
图1 前端自定义认证示意图 使用自定义认证调用API的流程如下图所示: 图2 自定义认证调用API 自定义认证依赖函数服务。如果当前Region没有上线函数服务,则不支持使用自定义认证。 操作步骤 在FunctionGraph中开发函数。 下面以python2.7语言为例,函数代码需要满足如下条件:
删除流控策略 操作场景 当已创建的流控策略不再提供服务时,可以将此流控策略删除。 前提条件 已创建流控策略。 操作步骤 进入共享版控制台。 选择“开放API > 流量控制”,进入到流量控制信息页面。 通过以下任意一种方式,弹出“删除流控策略”对话框。 在待删除的流控策略所在行,单击“删除”。
描述 使用函数服务开发自定义认证 在API的安全认证方面,API网关提供IAM认证、APP认证等方式,帮助用户快速开放API,同时API网关也支持用户使用自己的认证方式(以下简称自定义认证),以便更好地兼容已有业务能力。 API网关支持的自定义认证需要借助函数工作流服务实现,用户在
导入HTTP类型后端服务API示例 导入HTTP VPC类型后端服务API示例 导入FUNCTION类型后端服务API示例 导入MOCK类型后端服务API示例 导入HTTP类型后端服务API示例 包含IAM认证和请求参数编排的GET方法API定义,后端服务类型为HTTP。 Swagger示例:
填写策略的描述信息。长度为1~255个字符。 策略内容 策略的配置内容,支持表单配置和脚本配置两种方式。 镜像协议 镜像请求协议。指定的镜像服务协议须与用户的镜像业务协议保持一致。 镜像地址 镜像服务的地址。由IP/域名和端口号组成,总长度不超过255。格式为主机:端口(如:xxx.xxx.xxx:7443)
从IP地址(或地址区间)以及账号等不同维度,设置白名单/黑名单。 将API绑定流控策略,通过流控策略保护API。 API网关默认API流量控制为每秒200次,如果您的后端服务不能支撑单个API 200次/秒的调用请求,可设置流量控制策略,将限额调低。 父主题: 产品咨询
通过负载通道访问CCE工作负载中的实例地址。 (可选)配置工作负载标签实现灰度发布 通过CCE工作负载的标签配置,实现灰度发布。灰度发布是服务发布策略之一,旨在通过调整流量分配权重,逐步将流量从旧版本引导到新版本实例上。 父主题: 使用APIG专享版开放云容器引擎CCE工作负载
自己需要的环境。 单击“确定”,API发布成功后,“发布最新版本”按钮左上角的红色感叹号消失。 已发布的API因为其他原因需要暂停对外提供服务,可以暂时将API从相关环境中下线。该操作将导致此API在指定的环境无法被访问,请确保已经告知使用此API的用户后,选择待下线的API,单击“下线”即可。
虚拟私有云访问地址 弹性IP地址 如果实例未绑定弹性IP地址,您可以单击地址右侧的“立即启用”,绑定弹性IP地址。 如果实例已绑定弹性IP地址,您可以单击地址右侧的复制地址信息。 如果实例已绑定弹性IP地址,您可以编辑公网带宽。公网带宽费用按小时计算,以弹性公网IP服务的价格为准。
在左侧导航栏选择“实例管理”。 单击待变更实例右侧的“更多 > 规格变更”。 实例参数信息请参考表1,选择升级规格,单击“下一步”。 确认信息无误后,勾选服务协议,单击“去支付”后开始变更,变更时长15~30分钟左右。 “包年/包月”计费模式的实例,选择要变更的目标规格后,需补齐差价。 “按需计
请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 plugin_name
upstream_response_time 从开始与后端建立连接到从后端获取到最后一个字节所用时间(单位:秒)。 24 region_id 云服务区ID。 25 all_upstream_response_time 从开始与后端建立连接到从后端获取到最后一个字节所用时间(单位:秒)。发生重试时,为所用时间总和。