检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
100) 03 入门 弹性云服务器(Elastic Cloud Server)是一种可随时自动获取、计算能力可弹性伸缩的云服务器。 登录云服务器 什么是ECS 创建容器应用基本流程 初始化数据盘 什么是ECS 创建容器应用基本流程 05 实践 弹性云服务器(Elastic Cloud
例如:发布API用于查询虚拟机列表。良好的API描述应为“通过虚拟机名称、IP地址、虚拟机型号查询当前租户下的虚拟机列表,列表包括虚拟机名称,所属VPC、虚拟机IP、虚拟机型号、操作系统版本。” API文档按照模板进行写作 本条规则是Should类型的扩展规则,可提升API调用者的使用体验。
对于非简单请求,在正式通信之前,浏览器会增加一次HTTP查询请求,称为预检请求。浏览器询问服务器,当前页面所在的源是否在服务器的许可名单之中,以及可以使用哪些HTTP请求方法和头信息字段。预检通过后,浏览器向服务器发送简单请求。 开启跨域访问 API网关代理默认不开启跨域访问,如果您需要开启,请参考以下说明完成跨域配置。
调用API API发布到环境后,即支持被其他用户调用。根据API所使用的安全认证方式不同,调用API的操作有所差异。 约束与限制 如果您使用系统分配的默认子域名访问API,该子域名每天最多可以访问1000次。 前提条件 在调用API前,确保您所在网络与API的访问域名或地址互通。
服务端提供新版本API的同时,需要对老版本API提供支持。 例如:应用A更新API查询虚拟机列表,增加多个新的查询条件。在API发布之后,之前订阅该API的应用不能因为增加了新的查询条件而造成查询虚拟机列表失败。 API请求HTTP动词使用标准化且满足幂等性 本条规则是Should类型的扩展规则,可提升API的可维护性。
华为云租户的安全责任在于对使用的IaaS、PaaS和SaaS类各项云服务内部的安全以及对租户定制配置进行安全有效的管理,包括但不限于虚拟网络、虚拟主机和访客虚拟机的操作系统,虚拟防火墙、API网关和高级安全服务,各项云服务,租户数据,以及身份账号和密钥管理等方面的安全配置。 《华为云安全白皮书》
如何获取API调用凭据? 如果是来源于华为云服务的API,您可通过token认证或AK/SK认证进行API的在线调测和调用。在线调测时,用户登录华为云账号后,API中心会为您自动获取Token或者自动生成临时AK/SK,帮助您直接进行在线调测;调用API时,可根据参数填写项的提示
企业对外开放API供外部伙伴/开发者调用集成 操作场景 企业期望将自身业务能力(如实时快递查询服务)通过API接口对外开放,供外部伙伴/开发者调用集成,构建更繁荣的业务系统生态,并且触达更广泛的业务范围。 准备工作 准备好API接口文档,推荐OpenAPI 2.0/3.0格式。
响应消息头 调用API时,API网关代理增加如下响应消息头。 X-Apig-Mode: debug表示响应消息头增加API网关代理调试信息。 响应消息头 描述 说明 X-Request-Id 请求ID 所有合法请求,都会返回此参数 X-Apig-Latency 从API网关代理接收请求到后端返回消息头的用时
Internal Server Error 服务器遇到了一个未曾预料的状况,导致了它无法完成对请求的处理。通常是服务器内部产生了错误,导致处理失败。 502 Bad Gateway 代理服务器尝试执行请求时,从上游服务器接收到无效的响应。 API请求设置媒体类型和编码格式,响应内容格式需与响应设置媒体类型和编码格式一致
cannot call itself. 修改API后端配置,递归调用层数不能超过10层。 500 APIC.0705 Backend signature calculation failed. 联系技术支持。 父主题: 调用已发布的API
安全性 API使用合适的认证模式 本条规则是Should类型的扩展规则,可提升API的安全性。 根据具体业务场景,选择API调用的认证模式,具体说明如表1所示。 表1 认证模式说明 认证模式 认证描述 AppKey 在API请求Header或者Query中携带AppId和AppK
sourceIp:API调用者的源地址。 stage:API调用的部署环境。 apiId:API的ID。 appId:API调用者的APP ID。 requestId:当次调用API所生成的请求ID。 serverAddr:网关服务器的地址 。 serverName:网关服务器的名称。 ha
说明 为API分组绑定独立域名 在开放API前,您需要为API分组绑定独立域名,API调用者通过独立域名访问分组内的API。 添加环境变量 通过创建环境变量,实现同一个API,在不同环境中调用不同的后端服务。 修改分组信息 在分组所在行“操作”列,单击“编辑”,对分组名称及描述进行修改。
每个流控策略最多可以创建30个特殊应用。 特殊租户 每个流控策略最多可以创建30个特殊租户。 子域名访问次数 每个子域名每天最多可以访问1000次。 调用请求包的大小 API每次最大可以调用12M的请求包。 TLS协议 支持TLS1.1和TLS1.2,推荐使用TLS1.2。 本章描述的“用户”指的都是华为云账号。
例如,负载中包含6台ECS,已创建一条负载通道,其中ECS 01和ECS 04已添加到负载通道中,此时API网关代理通过负载通道可以直接访问负载中的ECS 01和ECS 04。 图1 通过API网关代理访问负载通道中的ECS 前提条件 API网关代理与负载通道中的服务器之间网络互通。 创建负载通道
调用已发布的API 调用API 响应消息头 错误码 父主题: API网关代理
管理控制台的“调试”功能,固定为调试环境,不支持携带环境变量调试。 后续操作 创建完环境和环境变量后,您可以将API发布到环境,以便API调用者调用。 父主题: API策略
定义环境中。 调用不同环境的API,一般通过在API调用的请求头增加指定的头部参数,头部参数名固定为x-stage,它的取值为环境名,用以区分不同的环境。 环境变量 在环境上创建可管理的一种变量,该变量固定在环境上。通过创建环境变量,实现同一个API在不同环境中调用不同的后端服务。
Arts”页签。 如果您的Markdown压缩包中文件的数量超过100个,导致文件无法导入,您可以通过向系统提交工单来寻求帮助。 上传文件 选择本地API文件上传。 API分组 当“导入方式”选择“API网关”时,支持选择API网关代理中的API分组。 API接口 当“导入方式”为下面