检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
响应消息头 调用API时,API网关增加如下响应消息头。 X-Apig-Mode: debug表示响应消息头增加API网关调试信息。
数据保护技术 安全通道:APIG支持HTTPs协议,保证网络传输安全,同时支持创建安全通道访问后端服务。 防重放、防篡改:APIG通过内部算法,从数据入口屏蔽恶意调用。 父主题: 安全
用户开通云审计服务后,系统将开始记录APIG资源的操作事件,并为您保存最近7天的操作记录。CTS支持记录的APIG操作请参见云审计服务支持APIG操作列表。 图1 云审计服务 CTS的详细介绍和开通配置方法,请参见CTS快速入门。
匹配: test.apig.com, 先匹配com, 匹配成功继续遍历apig, 匹配成功遍历test, 无test, 遍历*号, 匹配目标: *.apig.com URL的匹配为前序匹配跟域名的匹配模式相反,但是遍历算法一致。
API网关将包含常量参数的请求发送给后端服务前,会对特殊参数值进行百分号编码,请确保后端服务支持百分号编码。例如,参数值[apig],在百分号编码后变为%5Bapig%5D。 “PATH”位置的参数值会对如下字符进行百分号编码:ASCII码为0到31的字符、?
获取SDK 请登录API网关控制台,参考《API网关用户指南》的“SDK”章节,进入SDK页面并下载SDK。
发布API 对API的修改是否需要重新发布? API发布到RELEASE环境可以正常访问,发布到非RELEASE环境无法访问如何处理? API发布到不同环境后,会调用不同的后端服务吗? 调试API的时候,如何指定环境?
填充为API认证方式 结合x-apigateway-auth-type 表2 请求参数类型和API网关参数类型差异 OAS类型Swagger类型 API网关类型 支持的参数属性字段 integer long float double number maximum minimum
API网关支持单个API导出和批量API导出。 云商店购买的API不支持导出。 前提条件 已创建API分组和API。 操作步骤 进入共享版控制台。 单击“导出API”,进入“导出API”界面。 设置如表1所示参数。
准备环境 已在API网关控制台创建签名密钥,并绑定API,具体请参见创建并使用签名密钥。 已获取签名密钥的Key和Secret,请参见签名前准备获取。 请登录API网关控制台,参考《API网关用户指南》的“SDK”章节,进入SDK页面并下载SDK。或直接下载SDK的最新版本。
建议先在API网关控制台界面创建一个API,将其导出作为API文件的模板。 可能原因3:YAML文件格式问题,需要检查和修正。 可能原因4:本地proxy网络限制,更换网络环境。 可能原因5:定义API请求中,不允许在Header定义“X-Auth-Token”字段。
响应消息头 调用API时,API网关代理增加如下响应消息头。 X-Apig-Mode: debug表示响应消息头增加API网关代理调试信息。
导入API设计文件 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > API分组”。 单击“创建API分组 > 导入API设计文件”。 在弹窗中选择本地路径下的API文件,然后单击“打开”导入文件。 填写导入信息。
如何调用API 构造请求 认证鉴权 返回结果
通过APIG创建GRPC API API网关支持创建GRPC API。gRPC是RPC(远程过程调用)的一种,只需定义每个API的Request和Response,剩下的gRPC框架就可以完成。
APIG是否支持WebSocket数据传输? API的策略后端有多个时,怎么匹配和执行API请求? 如何通过APIG访问公网后端服务?
创建并使用签名密钥 操作场景 签名密钥用于后端服务验证API网关的身份,在API网关请求后端服务时,保障后端服务的安全。 签名密钥是由一对Key和Secret组成,签名密钥需要绑定到API才能生效。
通过API设计文件导入API 将Swagger或OpenAPI定义的API导入到API网关,支持导入到新分组和导入到已有分组两种方式。导入前您需要在API定义中补全API网关的扩展定义。 注意事项 API网关中API分组和API的配额满足需求。
在左侧导航栏选择“API网关代理 > API列表”。 单击待查看发布历史的API名称,进入“API运行”页面。 单击“更多 > 发布历史”。 在版本所在行,单击“查看版本”,弹出此版本详细信息对话框。
示例: GET /v1.0/apigw/apis?id=xxxx 父主题: 附录