检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
PI网关传过来的Authorization头中签名是否一致来校验API的合法性。 图1 签名密钥流程图 在控制台创建签名密钥。 将新创建的签名密钥绑定API。 API网关将签名后的请求发送到后端服务,此时Authorization头中包含签名信息。后端服务通过不同的开发语言(例如
克隆APIG的API API网关支持克隆已创建的API,提高API创建效率。您在克隆API时需要自定义API名称和API前端路径。 克隆API暂不支持克隆绑定策略,如果需要绑定策略请手动操作。 前提条件 已创建API,如果未创建API,请通过APIG创建REST API。 克隆API
单击“创建函数”,根据下表参数说明,创建一个函数。 表1 配置函数 参数 说明 选择创建方式 默认“创建空白函数”。 函数类型 选择函数的类型,此处默认“事件函数”。 区域 选择与API网关相同区域。 项目 华为云的区域默认对应一个项目,这个项目由系统预置,用来隔离物理区域间的资源(计算资源、存储资源和
更新SSL证书不影响API的调用。 如果待更新证书已绑定独立域名,那么所有访问这个域名的客户端都会看到更新后的证书。 如果更新的SSL证书已绑定独立域名且更新的内容新增CA证书,那么独立域名侧默认关闭“支持客户端认证”即关闭HTTPS双向认证;如果更新的SSL证书已绑定独立域名且更新的内容无CA
e。 开关开启表示允许。 开关关闭表示不允许。 单击“确定”。 如果您需要复制已创建的策略,请在已创建策略的“操作”列中单击“克隆”配置参数即可。克隆策略的名称不能与已创建的策略名称重复。 策略创建后,您还需要为策略绑定API,才能使策略对API生效。 脚本配置示例 { "allow_origin":
支持的监控指标 功能说明 本节定义了API网关服务上报云监控服务的监控指标的命名空间,监控指标列表和维度定义,用户可以通过云监控服务提供管理控制台或API接口来检索API网关服务产生的监控指标和告警信息。 命名空间 共享版:SYS.APIG API网关监控指标 表1 API网关共享版支持的监控指标
输入允许或者禁止访问API的账号ID,多个账号ID之间使用英文逗号“,”隔开。 您可以单击控制台右上角的用户名,选择“我的凭证”,在“我的凭证”页面获取用户的账号ID。 单击“确定”。 如果您需要复制已创建的策略,请在已创建策略的“操作”列中单击“克隆”配置参数即可。克隆策略的名称不能与已创建的策略名称重复。
enum为枚举值,多个参数值之间用英文逗号分隔 单击“确定”。 如果您需要复制已创建的策略,请在已创建策略的“操作”列中单击“克隆”配置参数即可。克隆策略的名称不能与已创建的策略名称重复。 策略创建后,您还需要为策略绑定API,才能使策略对API生效。 脚本配置示例 { "auth_request":
当API响应中不存在指定的响应头时,添加当前响应头。 Add:新增 无论API响应中是否存在指定的响应头,都添加当前响应头。 单击“确定”。 如果您需要复制已创建的策略,请在已创建策略的“操作”列中单击“克隆”配置参数即可。克隆策略的名称不能与已创建的策略名称重复。 策略创建后,您还需要为
与“时长”配合使用,表示单位时间内的单个用户请求次数上限。 如果主账号下有多个子用户访问API,按主账号累计的调用次数进行限制。 凭据流量限制 单个凭据调用API次数上限,仅在API的安全认证方式为APP认证时适用。 不超过“用户流量限制”和“API流量限制”。 与“时长”配合使用,表示单位时间内的凭据请求次数上限。
函数代码只支持您自定义的用户数据,且格式为:event["user_data"]。 函数代码获取的请求参数与API网关自定义认证中的参数关系为:函数请求参数中的自定义用户数据对应API网关自定义认证中的用户数据,参数值在您创建API网关自定义认证时输入,用户数据格式不限制,您可以自行指定。
创建ACL策略 功能介绍 增加一个ACL策略,策略类型通过字段acl_type来确定(permit或者deny),限制的对象的类型可以为IP或者DOMAIN,这里的DOMAIN对应的acl_value的值为您的租户名称, 而非“www.exampleDomain.com”之类的网络域名。
制值。 单击“确定”。 如果您需要复制已创建的策略,请在已创建策略的“操作”列中单击“克隆”配置参数即可。克隆策略的名称不能与已创建的策略名称重复。 策略创建后,您还需要为策略绑定API,才能使策略对API生效。 脚本配置示例 { "scope": "basic", "default_interval":
类推。 时长 填写配额限制的时长,单位可选择“秒”、“分”、“时”和“天”。需与“API访问限制”配合使用,表示单位时间内客户端可调用API的总次数上限。 API访问限制 填写客户端可调用API的次数上限,与“时长”配合使用。 描述 填写客户端配额策略的描述信息。长度为1~255个字符。
创建特殊设置 功能介绍 流控策略可以限制一段时间内可以访问API的最大次数,也可以限制一段时间内单个租户和单个APP可以访问API的最大次数。 如果想要对某个特定的APP进行特殊设置,例如设置所有APP每分钟的访问次数为500次,但想设置APP1每分钟的访问次数为800次,可以通
创建签名密钥 功能介绍 为了保护API的安全性,建议租户为API的访问提供一套保护机制,即租户开放的API,需要对请求来源进行认证,不符合认证的请求直接拒绝访问。 其中,签名密钥就是API安全保护机制的一种。 租户创建一个签名密钥,并将签名密钥与API进行绑定,则API网关在请求
创建自定义认证 功能介绍 创建自定义认证 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI POST /v1.0/apigw/authorizers 请求消息 表2 参数说明 名称 是否必选 类型 说明 name
创建环境成功后,在“环境管理”页面的列表中显示新创建的环境。 用户调用开放的API时,默认是调用RELEASE环境的API。如果要访问其他环境上的API,需要在API请求中添加Header参数“X-Stage”,参数值为环境名。例如要访问环境名为“Develop”上的API,则在API请求的Header参数中添加“X-Stage:
下线APIG的API 已发布的API因为其他原因需要暂停对外提供服务,可以暂时将API从相关环境中下线。 该操作将导致此API在指定的环境无法被访问,请确保已经告知使用此API的用户。 前提条件 已创建API分组和分组内的API。 API已发布到该环境。 操作步骤 进入API网关控制台页面。
调用已发布的API 调用API 响应消息头 错误码 父主题: 共享版操作指导(仅存量用户使用)