检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
术语 API API（Application Programming Interface，应用程序接口）是一些预先定义的函数，目的是提供应用程序与开发人员基于某软件或硬件得以访问一组例程的能力，而又无需访问源码，或理解内部工作机制的细节。 API Gateway API Gateway（Application
什么是API中心 API（Application Programing Interface，应用程序接口）是一些预先定义的函数，目的是提供应用程序与开发人员基于软件或硬件得以访问一组例程的能力，而又无需访问源码或理解内部工作机制的细节。API中心是为API开发者和应用开发者构建的
基本概念 API API（Application Programming Interface，应用程序编程接口）是一些预先定义的函数，应用将自身的服务能力封装成API，并通过API网关代理开放给用户调用。 API包括基本信息、前后端的请求路径、参数以及请求相关协议。 API分组
对于非简单请求，在正式通信之前，浏览器会增加一次HTTP查询请求，称为预检请求。浏览器询问服务器，当前页面所在的源是否在服务器的许可名单之中，以及可以使用哪些HTTP请求方法和头信息字段。预检通过后，浏览器向服务器发送简单请求。 开启跨域访问 API网关代理默认不开启跨域访问，如果您需要开启，请参考以下说明完成跨域配置。
客户端请求语义有误，当前请求无法被服务器理解或请求参数有误。 401 Unauthorized 当前请求需要用户验证，需要用户提供Token进行认证。 403 Forbidden 禁止访问某些资源，如权限不足时无法查询对应的信息。 404 Not Found 无法找到对应资源，如资源不存在。
例如，负载中包含6台ECS，已创建一条负载通道，其中ECS 01和ECS 04已添加到负载通道中，此时API网关代理通过负载通道可以直接访问负载中的ECS 01和ECS 04。 图1 通过API网关代理访问负载通道中的ECS 前提条件 API网关代理与负载通道中的服务器之间网络互通。 创建负载通道
100） 03 入门 弹性云服务器（Elastic Cloud Server）是一种可随时自动获取、计算能力可弹性伸缩的云服务器。 登录云服务器 什么是ECS 创建容器应用基本流程 初始化数据盘 什么是ECS 创建容器应用基本流程 05 实践 弹性云服务器（Elastic Cloud
错误码 用户调用API失败时，系统返回的错误码如下所示。 表1 错误码 HTTP状态码 错误码 错误描述 解决方案 404 APIC.0101 The API does not exist or has not been published in the environment.
每个分组在任意一个环境中，最多可以创建50个环境变量。 负载通道数量 每个用户最多可以创建10个VPC通道，每个负载通道最多可以添加10个服务器。 参数数量 每个API最多可以创建50个参数。 发布历史数量 同一个API在每个环境中最多记录10条最新的发布历史。 每个API的访问频率
在页面下方返回结果回显区域打印API调用的Response信息。 调用成功时，返回HTTP状态码为“200”和Response信息。 调试失败时，返回HTTP状态码为4xx或5xx，具体错误信息请参见错误码。 您可以通过调整请求参数与参数值，发送不同的请求，验证API服务。 后续操作
参数的名称，如果参数在“Path”位置，参数名称会同步“路径”中的名称。 说明： 参数名不能是x-apig- 、x-sdk-开头，不区分大小写。 参数名不能是x-stage，不区分大小写。 参数位置为HEADER时，参数名不能是“Authorization”和“X-Auth-Token”，不区分大小写，也不支持下划线。
传递SignKey，同时对请求时间进行有效校验，避免重复请求攻击。 动态Token API请求可使用AppId及AppKey向Token服务器换取动态Token，在动态Token有效期内，在API请求Header中携带Token进行身份认证，由于在换取Token过程中传递AppK
服务端提供新版本API的同时，需要对老版本API提供支持。 例如：应用A更新API查询虚拟机列表，增加多个新的查询条件。在API发布之后，之前订阅该API的应用不能因为增加了新的查询条件而造成查询虚拟机列表失败。 API请求HTTP动词使用标准化且满足幂等性 本条规则是Should类型的扩展规则，可提升API的可维护性。
对于需要下线的API，需要梳理订阅该API的用户，并通过公告等方式向订阅API的用户进行提醒。通知需要在服务下线前至少6个月启动，并在公告服务下线时间后1个月内对API调用进行监控，当没有API调用流量之后，才启动正式下线。待该API到了正式下线后，API中心不再展示下线的API。 父主题： API开放
新一次。 API请求总数 API网关代理中，已发布的所有API被调用的总次数。数据10分钟刷新一次。 API请求失败总数 API网关代理中，已发布的所有API被调用失败的总次数。数据10分钟刷新一次。 在“API监控”区域，展开API右侧的下拉框，选择您想要查看调用情况的API。
为您提供高性能、高可用、高安全的API托管服务。 API数据分析：查看API网关代理中已发布的API被调用的情况，如被请求调用的次数，调用失败的次数等。 只允许华为云企业账号申请成为API中心服务商。 父主题： 服务商入驻
在“返回结果基础定义”页面，定义返回结果。 表5 定义返回结果 信息项 描述 成功响应示例 成功调用API时，返回的响应信息示例。 失败响应示例 调用API失败时，返回的响应信息示例。 单击“完成”，完成API的创建。 步骤4：调试API 在左侧导航栏选择“API网关代理 > API分组”。
与“时长”配合使用，表示“时长”时间内的单个API请求次数上限。 用户流量限制 单个用户调用API次数上限，仅在API的安全认证方式为“华为IAM认证”时适用。 不能大于“API流量限制”的值。 与“时长”配合使用，表示“时长”时间内的单个用户请求次数上限。 如果主账号下有多个子用户访问API，按主账号累计的调用次数进行限制。
PI描述信息长度建议不超过2000字符。 例如：发布API用于查询虚拟机列表。良好的API描述应为“通过虚拟机名称、IP地址、虚拟机型号查询当前租户下的虚拟机列表，列表包括虚拟机名称，所属VPC、虚拟机IP、虚拟机型号、操作系统版本。” API文档按照模板进行写作 本条规则是Sh
独立域名：您自定义的域名，API调用者通过访问独立域名来调用您开放的API。 独立域名不能重复。 前提条件 已有独立域名。可通过域名注册服务申请新的域名。 已备案独立域名，未备案的独立域名无法被访问。备案时长需几个工作日，建议您提前进行备案。 已将独立域名CNAME解析到分组的子
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
