检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
对API的修改是否需要重新发布? 需要。 API发布后,如果再次编辑API参数,需要重新发布才能将修改后的信息同步到环境中。 关于API重新发布的详细指导,请参考发布API。 父主题: 发布API
使用JavaScript语言调用APP认证的API时,您需要先获取SDK,然后新建工程,最后参考API调用示例调用API。 JavaScript SDK支持Node.js、浏览器等运行环境。 关于开发环境搭建,本章节以IntelliJ IDEA 2018.3.5版本、搭建Node.js环境为例。浏览器只提供代码示例说明。
调试APIG创建的API API创建后需要验证服务是否正常,管理控制台提供调试功能,您可以添加HTTP头部参数与body体参数,调试API接口。 后端路径中含有环境变量的API,不支持调试。 如果API绑定了插件策略或传统策略,在调试API时,策略均不生效。 调试API时,后端超时时间最大支持60s。
API创建后需要验证服务是否正常,管理控制台提供调试功能,您可以添加HTTP头部参数与body体参数,调试API接口。 后端路径中含有环境变量的API,不支持调试。 如果API已绑定流控策略,在调试API时,流控策略无效。 前提条件 已创建API分组和分组内的API。 已搭建完成后端服务。
查看实例特性列表 功能介绍 查看实例特性列表。注意:实例不支持以下特性的需要联系技术支持升级实例版本。 支持配置的特性列表及特性配置示例请参考本手册中的“附录 > 实例支持的APIG特性”章节。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/
配置说明 后端服务类型 选择后端服务类型,此处选择“Mock”,实际请求不会调用到后端服务,通常用于后端服务没有搭建好的API联调环境。如果已有搭建好的后端服务,根据实际需要配置其他后端服务类型,操作详情请参考创建API。 Mock自定义返回码 选择API响应的HTTP状态码,此处默认“200”。
新增的API导入分组。 API分组 仅在选择“选择已有分组”时,需要选择API分组。 是否覆盖 勾选后,当导入的API名称与已有的API名称相同时,导入的API会覆盖已有的API。 仅在选择“选择已有分组”时,需要选择是否覆盖。 扩展覆盖 勾选后,当导入API扩展定义项名称(AC
绑定域名 功能介绍 用户自定义的域名,需要CNAME到API分组的子域名上才能生效,具体方法请参见增加CNAME类型记录集。 每个API分组下最多可绑定5个域名。绑定域名后,用户可通过自定义域名调用API。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI
续费概述 包年/包月实例到期后会影响实例正常运行。如果您想继续使用,需要在指定的时间内为实例续费,否则实例资源会自动释放,数据丢失且不可恢复。 续费操作仅适用于包年/包月实例,按需计费实例不需要续费,只需要保证账户余额充足即可。 包年/包月实例在到期前续费成功,所有资源得以保留,
单击“API名称”,进入“总览”页面。 查看API的各项监控指标。 单击“查看更多监控”,进入云监控界面,查看更多监控数据。 监控数据保留周期为两天,如果需要长时间保留,需要配置OBS桶,将监控数据保存至OBS桶中,具体步骤请参见配置OBS数据存储。 父主题: 监控
支持配置传统策略和插件策略。 API网关基于REST的API架构,API的开放和调用需要遵循RESTful相关规范。 前提条件 已创建API分组。如果未创建API分组,请创建API分组。 如果后端服务需要使用负载通道,请创建负载通道。 如果需要使用自定义认证方式进行API的安全认证,请创建自定义认证。 前端配置
如果您使用调试域名(创建API分组时系统分配的调试域名)访问API,该调试域名每天最多可以访问1000次。 获取API的调用信息 在调用API前,您需要向API提供者获取API的调用信息。 获取API的请求信息 在API网关控制台选择“开放API > API管理”,单击API的名称进入“调
支持单向认证和双向认证两种认证方式。 单向认证:客户端与服务端连接时,客户端需要验证所连接的服务端是否正确。 双向认证:客户端与服务端连接时,除了客户端需要验证所连接的服务器是否正确之外,服务端也需要验证接入的客户端是否正确。 前提条件 仅支持添加pem编码格式的SSL证书。
查询监控数据 功能介绍 查询指定时间范围指定指标的指定粒度的监控数据,可以通过参数指定需要查询的数据维度。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/metric-data 表1
云审计服务支持的APIG操作列表 开通云审计服务 如果您需要收集、记录或者查询API网关服务的操作日志,用于支撑安全分析、审计、问题定位等常见应用场景时,那么需要先开通云审计服务。 云审计服务包含以下功能: 记录审计日志 审计日志查询 审计日志转储 事件文件加密 关键操作通知 查看关键操作列表
云审计服务支持的APIG操作列表 开通云审计服务 如果您需要收集、记录或者查询API网关服务的操作日志,用于支撑安全分析、审计、问题定位等常见应用场景时,那么需要先开通云审计服务。 云审计服务包含以下功能: 记录审计日志 审计日志查询 审计日志转储 事件文件加密 关键操作通知 查看关键操作列表
连通云专线与API网关 创建VPC。 具体操作请参考《虚拟私有云 VPC》。 专享版API网关需要绑定1个VPC,将本地数据中心与VPC之间建立云专线后,API网关即可访问本地数据中心的服务。 图2 创建VPC示例参考 需要为API网关规划1个子网段。 一条云专线只能打通本地数据中心到1个VPC的网
如果在API调试过程中,遇到后端响应超时之类的错误,请适当调大后端超时时间,以便排查原因。 后端认证 当您的后端服务需要对API调用增加自己的认证,则需要开启后端认证。 后端认证需要先添加一个自定义认证,自定义认证通过函数工作流服务实现,在函数工作流服务中编写一个函数,实现您的认证鉴权流程,或者使用函数调用您的统一鉴权服务。
克隆APIG的API API网关支持克隆已创建的API,提高API创建效率。您在克隆API时需要自定义API名称和API前端路径。 克隆API暂不支持克隆绑定策略,如果需要绑定策略请手动操作。 前提条件 已创建API,如果未创建API,请通过APIG创建REST API。 操作步骤
获取账号名和账号名ID 在调用接口的时候,部分URL中需要填入账号名和账号ID,所以需要先在管理控制台上获取到账号名和账号ID。账号名和账号ID获取步骤如下: 登录管理控制台。 将鼠标移至用户名,在下拉列表中单击“我的凭证”。 查看账号名和账号ID。 父主题: 附录