检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
创建API API提供者把API接口配置在API网关代理中,开放后端能力。创建API主要分为两个步骤: 前端配置 支持配置前端定义、安全配置和请求参数。 后端配置 支持配置默认后端、策略后端和返回结果。 API网关代理是基于REST的API架构,API的开放和调用需要遵循RESTful相关规范。
PI描述信息长度建议不超过2000字符。 例如:发布API用于查询虚拟机列表。良好的API描述应为“通过虚拟机名称、IP地址、虚拟机型号查询当前租户下的虚拟机列表,列表包括虚拟机名称,所属VPC、虚拟机IP、虚拟机型号、操作系统版本。” API文档按照模板进行写作 本条规则是Sh
Internal Server Error 服务器遇到了一个未曾预料的状况,导致了它无法完成对请求的处理。通常是服务器内部产生了错误,导致处理失败。 502 Bad Gateway 代理服务器尝试执行请求时,从上游服务器接收到无效的响应。 API请求设置媒体类型和编码格式,响应内容格式需与响应设置媒体类型和编码格式一致
例如,负载中包含6台ECS,已创建一条负载通道,其中ECS 01和ECS 04已添加到负载通道中,此时API网关代理通过负载通道可以直接访问负载中的ECS 01和ECS 04。 图1 通过API网关代理访问负载通道中的ECS 前提条件 API网关代理与负载通道中的服务器之间网络互通。 创建负载通道
称为预检请求。浏览器询问服务器,当前页面所在的源是否在服务器的许可名单之中,以及可以使用哪些HTTP请求方法和头信息字段。预检通过后,浏览器向服务器发送简单请求。 开启跨域访问 API网关代理默认不开启跨域访问,如果您需要开启,请参考以下说明完成跨域配置。 简单请求的跨域访问 如
100) 03 入门 弹性云服务器(Elastic Cloud Server)是一种可随时自动获取、计算能力可弹性伸缩的云服务器。 登录云服务器 什么是ECS 创建容器应用基本流程 初始化数据盘 什么是ECS 创建容器应用基本流程 05 实践 弹性云服务器(Elastic Cloud
aaS和SaaS类各项云服务内部的安全以及对租户定制配置进行安全有效的管理,包括但不限于虚拟网络、虚拟主机和访客虚拟机的操作系统,虚拟防火墙、API网关和高级安全服务,各项云服务,租户数据,以及身份账号和密钥管理等方面的安全配置。 《华为云安全白皮书》详细介绍华为云安全性的构建思
服务端提供新版本API的同时,需要对老版本API提供支持。 例如:应用A更新API查询虚拟机列表,增加多个新的查询条件。在API发布之后,之前订阅该API的应用不能因为增加了新的查询条件而造成查询虚拟机列表失败。 API请求HTTP动词使用标准化且满足幂等性 本条规则是Should类型的扩展规则,可提升API的可维护性。
进入API中心服务页面。 选择左侧导航栏中的“API资产管理 > API资产”。 单击页面右上角的“创建API资产”。 填写API资产信息。 根据表1参数信息,配置选择导入API。 表1 选择导入API 参数名称 说明 导入方式 支持以下6种方式,上架API文件至API中心门户网站: OpenAPI:支持导入符合OpenAPI
凭据名称 凭据的名称。 描述 凭据的介绍。 (可选)单击“自定义配置”后面的,展开自定义配置区域,可以自定义配置AppKey和AppSecret。AppKey是身份标识,需要保证全局唯一。 如果没有特殊需求,不建议使用“自定义配置”,系统会默认生成全局标识,可在凭据详情中查看。 单击“确定”,创建凭据。
进入API中心服务页面。 选择左侧导航栏中的“API资产管理 > API资产”。 单击页面右上角的“创建API资产”。 填写API资产信息。 根据表1参数信息,配置选择导入API。 表1 选择导入API 参数名称 说明 导入方式 支持以下6种方式,上架API文件至API中心门户网站: OpenAPI:支持导入符合OpenAPI
标签主要用于对API添加分类属性,方便在创建了大量API后,快速过滤和查找。 描述 API的描述。 根据下表参数信息,配置安全配置。 表3 定义API请求 参数 配置说明 安全认证 选择API认证方式,此处选择“APP认证”。 支持简易认证 简易认证不需要对请求内容签名,API网关
debug,且API配置了API流量控制时,返回此参数 X-Apig-RateLimit-user 用户流量限制信息 示例:remain:9,limit:10,time:10 second 仅在请求消息头包含X-Apig-Mode: debug,且API配置了用户流量限制时,返回此参数
传递SignKey,同时对请求时间进行有效校验,避免重复请求攻击。 动态Token API请求可使用AppId及AppKey向Token服务器换取动态Token,在动态Token有效期内,在API请求Header中携带Token进行身份认证,由于在换取Token过程中传递AppK
在“域名管理”区域,单击“绑定独立域名”,并在弹窗中配置域名信息。 表1 独立域名配置 信息项 描述 域名 填写要绑定的域名。 支持最小TLS版本 选择域名访问所使用的最小TLS版本,TLS1.1或TLS1.2,推荐使用TLS1.2。 该配置仅对HTTPS生效,不影响HTTP或者其他访问方式。
PI。 仅在“导入方式”选择“选择已有分组”时,需要选择是否覆盖。 (可选)单击“全局配置(可选)”。 安全配置。请参考安全配置。 后端请求配置。请参考1。 确认无误后,单击“完成”,完成配置。 单击“立即导入”,在弹窗中选择是否现在发布API到环境。 如果选择“现在发布”,还需
址的访问控制策略绑定。 同一个环境中,一个API只能被一个限制账号名的访问控制策略绑定。 一个访问控制策略可以绑定多个API。 配置参数说明 表1 配置参数说明 信息项 描述 策略名称 访问控制策略的名称。 类型 控制访问API的类型。 IP地址:允许/禁止访问API的IP地址。
每个分组在任意一个环境中,最多可以创建50个环境变量。 负载通道数量 每个用户最多可以创建10个VPC通道,每个负载通道最多可以添加10个服务器。 参数数量 每个API最多可以创建50个参数。 发布历史数量 同一个API在每个环境中最多记录10条最新的发布历史。 每个API的访问频率
)进行签名,通过比对签名结果和API网关代理传过来的Authorization头中签名是否一致,来校验API网关代理的合法性。 配置参数说明 表1 配置参数说明 信息项 描述 密钥名称 自定义名称,用于识别不同的密钥。 类型 选择签名密钥的认证类型,可选择“HMAC”、“Basic
configurations do not exist. 联系技术支持。 400 APIC.0106 Orchestration error. 检查API配置的前后端参数是否合理。 400 APIC.0201 Bad request. 使用合法的请求。 413 APIC.0201 Request