检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
扣款日,如到期前6日、到期前5日等等。 更多关于自动续费的规则介绍请参见自动续费规则说明。 前提条件 请确认包年/包月实例还未到期。 操作步骤 方式一:在API网关控制台的实例管理中开通自动续费。 进入API网关控制台页面。 在左侧导航栏选择“实例管理”。 在待续费的实例上单击“更多
后端路径中含有环境变量的API,不支持调试。 如果API已绑定流控策略,在调试API时,流控策略无效。 前提条件 已创建API分组和分组内的API。 已搭建完成后端服务。 操作步骤 进入共享版控制台。 单击“开放API > API管理”,进入到API管理信息页面。 通过以下任意一种方法,进入API调试页面。 在待调试的API所在行,单击“更多
er扩展定义。如果“扩展定义”中未包含需要的定义,请提前在API网关中创建。 导入API前,请确保API分组和API的配额满足需求。 操作步骤 进入共享版控制台。 单击“开放API > API管理”,进入到API管理信息页面。 单击“导入API”,进入“导入API”界面。 选择如表1所示参数。
可达。如果下游存在跨VPC调用的场景时,需要通过VPC终端节点对接到APIG专享版的VPC终端节点服务上,以保证网络可达。具体操作详见实施步骤。 调试域名的变化 原共享版的分组调试域名{group-id}.apig.{region-id}.huaweicloudapis.com将会更新为{group-id}
通过自定义认证调用API 前提条件 已在函数工作流服务中完成函数创建。 用户还需具备FunctionGraph Administrator角色权限。 操作步骤 进入共享版控制台。 在“开放API > 自定义认证”页签,单击“创建自定义认证”,弹出“创建自定义认证”对话框。 填写如表1所示信息。 表1
如果API分组中的API支持HTTPS请求协议,那么在独立域名中需要添加SSL证书,请您提前准备SSL证书。此证书不支持导入,您需要填写证书的名称、内容和密钥。 操作步骤 进入共享版控制台。 单击“开放API > API分组”,进入到API分组信息页面。 通过以下任意一种方式,进入“域名管理”页签。 单击“
间,并且没有ping/pong保活,则连接会被自动断开。 前提条件 准备一个已做ping/pong保活的WebSocket服务后端。 操作步骤 登录API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > API列表”。 单击“创建API >
查看或编辑APIG实例信息 实例创建完成后,可在控制台查看和编辑实例的配置信息。 操作步骤 进入API网关控制台页面。 在左侧导航栏选择“实例管理”。 在待查看或编辑的实例上,单击“查看控制台”或实例名称。 在“实例信息”页签,查看或编辑实例的配置信息。 表1 实例信息 可编辑项
服务接口的文件,通常在gRPC中使用。它基于Protobuf语言,用于描述数据的结构和交互方式,充当客户端和后端服务之间通信的合同。 操作步骤 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > API分组”。 单击分组名称。 在“API运行”页面,单击“创建API
类型说明。 响应内容支持调用API网关运行时变量($context变量),具体见API网关运行时可获取变量。 前提条件 已创建分组。 操作步骤 进入共享版控制台。 单击“开放API > API分组”,进入到API分组信息页面。 找到您要新增或编辑修改网关响应的分组,单击并进入分组详情页。
JSON视图创建自定义策略:可以在选择策略模板后,根据具体需求编辑策略内容;也可以直接在编辑框内编写JSON格式的策略内容。 具体创建步骤请参见:创建自定义策略。本章为您介绍常用的API网关自定义策略样例。 APIG自定义策略样例 示例1:授权用户创建API、调试API的权限
使用自定义认证调用API的流程如下图所示: 图2 使用自定义认证调用API 自定义认证依赖函数服务。如果当前Region没有上线函数服务,则不支持使用自定义认证。 操作步骤 在FunctionGraph中开发函数。 下面以python2.7为例,函数代码需要满足如下条件: 函数代码只支持您自定义的用户数据,且
网关响应所定义的错误类型固定且不可修改,具体见网关错误响应类型说明。 响应内容支持调用API网关运行时变量($context变量),具体见API网关运行时可获取变量。 操作步骤 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > API分组”。 单击分组名称。 单击“分组信息”页签。
创建自定义认证 在API网关控制台页面,创建自定义认证,类型选择“前端”,函数地址选择上一步创建的函数。 创建自定义认证的API 创建API,具体步骤请参见创建API。将“安全认证”修改为“自定义认证”,并选择上一步创建的自定义认证。编辑完成之后发布API。 设置错误响应 调用API如果输入错误的认证信息,则返回结果如下:
使用自定义认证调用API的流程如下图所示: 图2 自定义认证调用API 自定义认证依赖函数服务。如果当前Region没有上线函数服务,则不支持使用自定义认证。 操作步骤 在FunctionGraph中开发函数。 下面以python2.7语言为例,函数代码需要满足如下条件: 函数代码支持三种请求参数定义,格式为:
如果不再需要此域名时,在域名所在行,单击“解绑域名”。 绑定SSL证书(可选) 如果API分组中的API支持HTTPS请求协议,则需要为独立域名绑定SSL证书。否则跳过此步骤。 在域名所在行单击“选择SSL证书”。 在选择SSL证书弹窗中勾选要绑定的SSL证书,然后单击“确定”,完成SSL证书的绑定。 如果选择
改配置参数,可以调整组件的相关功能。 约束与限制 修改实例配置参数会引起APIG业务中断,建议在无业务运行或业务低峰时修改配置参数。 操作步骤 进入API网关控制台页面。 在左侧导航栏选择“实例管理”。 在待配置参数的实例上,单击“查看控制台”或实例名称。 单击“配置参数”页签,
放开后端服务地址与API调用端口。 如果API的前后端服务与实例绑定了相同的安全组、相同的虚拟私有云,则无需专门为实例开放上述端口。 操作步骤 进入购买实例页面。 除墨西哥城一、北京一区域外,在其他区域购买实例后默认开启ELB负载。开启ELB负载的实例的安全组不生效,如需禁用部分IP请使用访问控制策略。