检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
最多可以访问1000次。您也可以通过关闭“调试域名开关”来关闭调试域名,关闭后将隐藏调试域名,且不能通过调试域名调用API。 实例创建后,有一个DEFAULT分组,可直接通过虚拟私有云地址调用默认分组中的API。 前提条件 已创建实例。 直接创建 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。
在左侧导航栏选择“帮助中心”。 单击“SDK使用指引”页签。 在待下载的语言中,单击“下载SDK”,下载SDK包(SDK主要包含SDK代码和示例代码,不同语言SDK包不同)。 如需查看文档,请单击“SDK文档”。
aaa.com”,子域名可以为“default.aaa.com”和 “1.aaa.com”等。 单击“调试”。 在页面下方返回结果回显区域打印API调用的Response信息。 调用成功时,返回HTTP状态码为“2xx”和Response信息。 调试失败时,返回HTTP状态码为4xx或5xx,具体错误信息请参见错误码。
在“SSL证书管理”页签中,单击“创建SSL证书”。 表1 配置单向认证的证书信息 参数 配置说明 证书名称 填写证书名称,建议您按照一定的命名规则填写,方便您快速识别和查找。 可见范围 此处选择“当前实例”。 证书内容 -----Start certificate----- MIICXgIBAAKBgQC6ndRHy5Dv5TcZiVzT6qF
APIG使用流程 API网关(API Gateway)是为您提供高性能、高可用、高安全的API托管服务,帮助您轻松构建、管理和部署任意规模的API。借助API网关的开放API和调用API功能,可以简单、快速、低成本、低风险地实现内部系统集成、业务能力开放。 开放API 企业或开发者通过API网关开放自身的服务与数据。
包括API分组的创建、修改、删除、查询详情和列表等接口。 环境管理 包括环境的创建、修改、删除和查询列表等接口。 环境变量管理 包括环境变量的新建、修改、删除、查询详情和列表等接口。 流控策略管理 包括流控策略的创建、修改、删除、查看详情和列表等接口。 API管理 包括API的创建
服务端已定义proto文件,即在proto文件中定义API的Request和Response。proto文件是用于定义数据结构和服务接口的文件,通常在gRPC中使用。它基于Protobuf语言,用于描述数据的结构和交互方式,充当客户端和服务端之间通信的合同。 创建API 登录API网关控制台页面。
创建用户并授权使用APIG。 在创建APIG实例前,确保已存在可用的VPC和子网。 APIG实例可以使用当前账号下已创建的VPC和子网,也可以使用新创建的VPC和子网,请根据实际需要进行配置。 创建VPC和子网的操作指导,请参考创建虚拟私有云和子网。请注意:创建的VPC与APIG实例必须在相同的区域。
Gateway)是为您提供高性能、高可用、高安全的API托管服务,帮助您轻松构建、管理和部署任意规模的API。借助API网关可以简单、快速、低成本、低风险地实现内部系统集成、业务能力开放及业务能力变现。 API网关支持专享版和共享版(存量用户)功能。专享版功能操作指导请参考API管理~云审计服务
V2:VPC网络架构 version 否 String 函数版本 当函数别名URN和函数版本同时传入时,函数版本将被忽略,只会使用函数别名URN 最大长度:64 alias_urn 否 String 函数别名URN 当函数别名URN和函数版本同时传入时,函数版本将被忽略,只会使用函数别名URN timeout
服务的访问方式设置为VPC内网访问,在API网关中创建API时,通过VPC通道访问部署在VPC内的此服务。创建VPC通道和API的详细步骤请参见创建负载通道和创建API。 父主题: 其他
将实例的配置参数“app_route”和“app_secret”设置为“on”。开启“app_route”之后,同一凭据不能授权给相同请求路径和方法的API。 在请求消息中添加Header参数“X-HW-ID”和“X-HW-APPKEY”,参数值为API所授权凭据的Key和Secret。 须知:
审计日志查询 审计日志转储 事件文件加密 关键操作通知 查看关键操作列表 通过云审计服务,您可以记录与API网关相关的操作事件,便于日后的查询、审计和回溯。 表1 云审计服务支持的API Gateway操作列表 操作名称 资源类型 事件名称 创建API分组 ApiGroup createApiGroup
基本信息配置。 表1 基本信息配置 参数 配置说明 通道名称 填写负载通道名称,根据规划自定义。建议您按照一定的命名规则填写负载通道名称,方便您快速识别和查找。此处填写“VPC_demo”。 端口 填写已创建工作负载的容器端口,指工作负载中pod里业务直接对外开放的接口。此处填写“80”,80端口默认为http协议端口。
在API网关中导入或者导出API时,限制与兼容性如下所示: 限制说明 API网关参数限制,如下所示。 API网关暂不支持formData和body位置的请求参数定义。 API网关暂不支持consumes和produces定义。 API网关中,header位置的参数名称,不区分大小写。 后端策略限制,如下所示。
API网关支持WebSocket API,其创建过程和创建HTTP API一致。WebSocket是一种全双工通信协议,建立在单个TCP连接上,允许在客户端和服务器之间进行双向通信。WebSocket的设计旨在解决HTTP协议在实时性和交互性方面的不足。它广泛应用于实时聊天、在线游戏、金融行业的实时数据更新等场景。
SL_DOMAIN String API分组的子域名,由API网关分配,用户不可填写和修改 R - SL_DOMAINS Array of strings API分组的子域名列表,由API网关分配,用户不可填写和修改 R - PROJECT_ID String 创建该API分组的租户编号,即API分组的所有者
身份认证服务API参考》的获取用户Token接口: {iam_endpoint}请参见地区和终端节点获取。 {user_name}和{password}分别替换为连接IAM服务器的用户名和密码。 {project_id}为项目ID。在管理控制台,将鼠标移至用户名,在下拉列表中单击“我的凭证”,查看“项目ID”。
IAM认证信息错误 IAM认证信息错误有: Incorrect IAM authentication information: verify aksk signature fail Incorrect IAM authentication information: AK access
text字段,字段中包含键值对。其中键值对的值只支持字符串、布尔、整型三种数值类型,键值对对应“系统参数-前端认证参数”策略条件的参数名称和条件值。 图1 自定义认证函数 已创建前端自定义认证。如果未创建,请参考自定义认证章节创建。 配置API前端 登录API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。