检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
创建API API提供者把API接口配置在API网关代理中,开放后端能力。创建API主要分为两个步骤: 前端配置 支持配置前端定义、安全配置和请求参数。 后端配置 支持配置默认后端、策略后端和返回结果。 API网关代理是基于REST的API架构,API的开放和调用需要遵循RESTful相关规范。
凭据名称 凭据的名称。 描述 凭据的介绍。 (可选)单击“自定义配置”后面的,展开自定义配置区域,可以自定义配置AppKey和AppSecret。AppKey是身份标识,需要保证全局唯一。 如果没有特殊需求,不建议使用“自定义配置”,系统会默认生成全局标识,可在凭据详情中查看。 单击“确定”,创建凭据。
进入API中心服务页面。 选择左侧导航栏中的“API资产管理 > API资产”。 单击页面右上角的“创建API资产”。 填写API资产信息。 根据表1参数信息,配置选择导入API。 表1 选择导入API 参数名称 说明 导入方式 支持以下6种方式,上架API文件至API中心门户网站: OpenAPI:支持导入符合OpenAPI
进入API中心服务页面。 选择左侧导航栏中的“API资产管理 > API资产”。 单击页面右上角的“创建API资产”。 填写API资产信息。 根据表1参数信息,配置选择导入API。 表1 选择导入API 参数名称 说明 导入方式 支持以下6种方式,上架API文件至API中心门户网站: OpenAPI:支持导入符合OpenAPI
标签主要用于对API添加分类属性,方便在创建了大量API后,快速过滤和查找。 描述 API的描述。 根据下表参数信息,配置安全配置。 表3 定义API请求 参数 配置说明 安全认证 选择API认证方式,此处选择“APP认证”。 支持简易认证 简易认证不需要对请求内容签名,API网关
分发算法包含如下几种: 加权轮询 加权最小连接 源地址哈希 URI哈希 配置通道内服务器。 创建服务器分组,填写分组名称、权重和描述。 添加后端服务器地址,填写后端服务地址,设置是否启用备用节点。 配置健康检查。 表2 基本信息配置 信息项 描述 协议 使用以下协议,对负载中主机执行健康检查。
debug,且API配置了API流量控制时,返回此参数 X-Apig-RateLimit-user 用户流量限制信息 示例:remain:9,limit:10,time:10 second 仅在请求消息头包含X-Apig-Mode: debug,且API配置了用户流量限制时,返回此参数
在“域名管理”区域,单击“绑定独立域名”,并在弹窗中配置域名信息。 表1 独立域名配置 信息项 描述 域名 填写要绑定的域名。 支持最小TLS版本 选择域名访问所使用的最小TLS版本,TLS1.1或TLS1.2,推荐使用TLS1.2。 该配置仅对HTTPS生效,不影响HTTP或者其他访问方式。
PI。 仅在“导入方式”选择“选择已有分组”时,需要选择是否覆盖。 (可选)单击“全局配置(可选)”。 安全配置。请参考安全配置。 后端请求配置。请参考1。 确认无误后,单击“完成”,完成配置。 单击“立即导入”,在弹窗中选择是否现在发布API到环境。 如果选择“现在发布”,还需
址的访问控制策略绑定。 同一个环境中,一个API只能被一个限制账号名的访问控制策略绑定。 一个访问控制策略可以绑定多个API。 配置参数说明 表1 配置参数说明 信息项 描述 策略名称 访问控制策略的名称。 类型 控制访问API的类型。 IP地址:允许/禁止访问API的IP地址。
aaS和SaaS类各项云服务内部的安全以及对租户定制配置进行安全有效的管理,包括但不限于虚拟网络、虚拟主机和访客虚拟机的操作系统,虚拟防火墙、API网关和高级安全服务,各项云服务,租户数据,以及身份账号和密钥管理等方面的安全配置。 《华为云安全白皮书》详细介绍华为云安全性的构建思
准备好API接口文档,推荐OpenAPI 2.0/3.0格式。 准备好API使用指南,说明API凭据获取方式、以及提供API使用时的补充说明信息。 API对应的后端服务已部署上线,并且推荐提供服务域名或IP地址,有助于伙伴/开发者便捷地在线调试API。 已注册华为账号并开通华为云,并已完成企业实名认证。 操作流程
在“凭据管理”页面,单击凭据名称,进入详情页面。 在“AppCodes”区域,单击“添加AppCode”。 在弹窗中配置AppCode,完成后单击“确定”。 表1 配置AppCode 信息项 描述 生成方式 选择AppCode的生成方式。 自动生成:由系统随机生成AppCode。 手动输入:自定义AppCode。
configurations do not exist. 联系技术支持。 400 APIC.0106 Orchestration error. 检查API配置的前后端参数是否合理。 400 APIC.0201 Bad request. 使用合法的请求。 413 APIC.0201 Request
)进行签名,通过比对签名结果和API网关代理传过来的Authorization头中签名是否一致,来校验API网关代理的合法性。 配置参数说明 表1 配置参数说明 信息项 描述 密钥名称 自定义名称,用于识别不同的密钥。 类型 选择签名密钥的认证类型,可选择“HMAC”、“Basic
进入API中心服务页面。 在左侧导航栏选择“API网关代理 > API列表”。 单击待调试的API名称,进入“API运行”页面。 单击“调试”。 配置API请求参数后,单击“调试”。 在页面下方返回结果回显区域打印API调用的Response信息。 调用成功时,返回HTTP状态码为“200”和Response信息。
{Address}:请求地址,需替换为获取API的请求信息中获取的域名地址。 API网关代理使用分组分配的子域名或分组绑定的域名调用API,无需另外配置。 {Path}:请求路径,需替换为获取API的请求信息中获取的URL。 {Query}:查询参数,可选,格式为“参数名=参数取值”,例如
创建API资产时,不需要填写API来源。 公测 API资产管理 3 修改API网关代理中部分配置项的限制值 修改API网关代理中后端策略、流量控制策略、访问控制策略、签名密钥策略和环境的最大可配置数量。 公测 约束与限制 4 服务商入驻优化 没有入驻API中心服务商的开发者,可以看到
在左侧导航栏选择“API网关代理 > API策略”。 在“策略管理”页面,单击“创建策略”。 单击需要创建的策略类型。 传统策略 不同的策略类型,策略内容的配置不同: 流量控制策略说明 访问控制策略说明 签名密钥策略说明 单击“确定”。 策略创建后,您还需要为API绑定策略,才能使策略对API生效。
服务器发送简单请求。 开启跨域访问 API网关代理默认不开启跨域访问,如果您需要开启,请参考以下说明完成跨域配置。 简单请求的跨域访问 如果是创建新的API,在“安全配置”时,打开“支持跨域(CORS)”开关。详细的使用指导,可参考简单请求。 非简单请求的跨域访问 非简单请求的跨