检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
责任共担 华为云秉承“将公司对网络和业务安全性保障的责任置于公司的商业利益之上”。针对层出不穷的云安全挑战和无孔不入的云安全威胁与攻击,华为云在遵从法律法规业界标准的基础上,以安全生态圈为护城河,依托华为独有的软硬件优势,构建面向不同区域和行业的完善云服务安全保障体系。 安全性是华为云与您的共同责任
修订记录 发布日期 修订记录 2023-09-27 第八次正式发布。 新增如下章节: 附录-API治理规范指导 2023-07-14 第七次正式发布。 优化如下章节: 约束与限制 2023-05-22 第六次正式发布。 新增如下章节: 图解API中心 优化如下章节: 产品优势 2023
操作步骤 进入API中心服务页面。 在左侧导航栏选择“API网关代理 > API列表”。 在API所在行,单击“操作”列的“更多 > 授权”。 单击“添加授权”。 选择API授权环境,查询并勾选凭据后,单击“确定”。在“授权历史”弹窗中展示已授权的凭据。
响应消息头 调用API时,API网关代理增加如下响应消息头。 X-Apig-Mode: debug表示响应消息头增加API网关代理调试信息。 响应消息头 描述 说明 X-Request-Id 请求ID 所有合法请求,都会返回此参数 X-Apig-Latency 从API网关代理接收请求到后端返回消息头的用时
热点咨询 服务商入驻 为什么要申请入驻服务商? 申请入驻API中心服务商有哪些入口? 服务商入驻审核多久通过? 服务商入驻成功后可以取消入驻吗? 服务商入驻成功后信息还可以修改吗? API网关代理 是否必须使用API中心的网关代理功能? 哪些API支持在线调测? 如何获取API调用凭据
导入Swagger文件 进入API中心服务页面。 在左侧导航栏选择“API网关代理 > API分组”。 单击右上角的“创建API分组”,选择下拉框中的“导入Swagger文件”。 在弹窗中选择本地路径下的API文件,然后单击“打开”导入文件。 填写导入信息。
创建环境 进入API中心服务页面。 在左侧导航栏选择“API网关代理 > API策略”。 单击“环境管理”页签。 单击“创建环境”,填写环境信息。 表1 环境信息 信息项 描述 环境名称 API环境名称。 描述 环境描述信息。 单击“确定”,创建环境。
签名密钥策略说明 签名密钥用于后端服务验证API网关代理的身份,在API网关代理请求后端服务时,保障后端服务的安全。 签名密钥由一对Key和Secret组成,签名密钥需要绑定到API才能生效。当签名密钥绑定API后,API网关代理向后端服务发送此API的请求时,会增加相应的签名信息
安全性 API使用合适的认证模式 本条规则是Should类型的扩展规则,可提升API的安全性。 根据具体业务场景,选择API调用的认证模式,具体说明如表1所示。 表1 认证模式说明 认证模式 认证描述 AppKey 在API请求Header或者Query中携带AppId和AppKey
概述 API网关代理包括API的创建、发布、下线和删除所经历的完整生命周期过程,为您提供高性能、高可用、高安全的API托管服务,能快速将企业服务能力包装成标准API服务,帮助您轻松构建、管理和部署任意规模的API。借助API网关代理,可以简单、快速、低成本、低风险地实现内部系统集成
操作步骤 进入API中心服务页面。 在左侧导航栏选择“API网关代理 > API列表”。 单击页面右上角的“导出API”,设置导出参数。 表1 导出API 信息项 描述 API分组 选择待导出API所在的API分组。 运行环境 选择待导出API所在的环境。
负载通道 负载通道主要用于将服务通过API网关代理开放给外部访问,它的优势在于使用VPC的内部子网通信,网络时延更低,同时负载通道具有负载均衡功能,从而实现后端服务的负载均衡。 创建负载通道后,在创建API,且后端服务类型为HTTP/HTTPS时,后端服务地址可以直接使用已创建的负载通道
身份认证与访问控制 身份认证 服务认证:API网关代理提供AK/SK、Token等多种方式进行服务认证,只允许授权的访问。 签名密钥:API网关代理提供签名密钥,用于后端服务校验API网关代理是否合法。 访问控制 流量控制:API网关代理支持从用户、IP、凭据和时间段等不同的维度限制对
创建策略 进入API中心服务页面。 在左侧导航栏选择“API网关代理 > API策略”。 在“策略管理”页面,单击“创建策略”。 单击需要创建的策略类型。 传统策略 不同的策略类型,策略内容的配置不同: 流量控制策略说明 访问控制策略说明 签名密钥策略说明 单击“确定”。
API资产管理 通过创建API资产,将您开发好的API分享至API中心门户网站,其他开发者就可以在API中心门户网站搜索到您分享的API,用于自己的项目开发。 前提条件 已成功申请入驻成为API中心服务商。具体操作指导参见服务商入驻。 1个服务商最多可以创建50个API资产。 1个服务商创建的所有
企业对外开放API供外部伙伴/开发者调用集成 操作场景 企业期望将自身业务能力(如实时快递查询服务)通过API接口对外开放,供外部伙伴/开发者调用集成,构建更繁荣的业务系统生态,并且触达更广泛的业务范围。 准备工作 准备好API接口文档,推荐OpenAPI 2.0/3.0格式。 准备好
生成APPCode 进入API中心服务页面。 在左侧导航栏选择“API网关代理 > API凭据管理”。 在“凭据管理”页面,单击凭据名称,进入详情页面。 在“AppCodes”区域,单击“添加AppCode”。 在弹窗中配置AppCode,完成后单击“确定”。
调试API API创建后需要验证服务是否正常,管理控制台提供调试功能,您可以添加HTTP头部参数与body体参数,调试API接口。 后端路径中含有环境变量的API,不支持调试。 如果API已绑定流控策略,在调试API时,流控策略无效。 前提条件 已搭建完成后端服务。 操作步骤 进入
上架API至API中心门户网站 使用场景 如果您想要将已开发好的API上架至API中心门户网站,请参考本章指导操作。 前提条件 已完成服务商入驻,具体操作指导参考《用户指南》服务商入驻章节。 操作步骤 进入API中心服务页面。 选择左侧导航栏中的“API资产管理 > API资产”。
API分组 创建API分组 域名管理 环境变量 父主题: API网关代理