检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
错误码 用户调用API失败时，系统返回的错误码如下所示。 表1 错误码 HTTP状态码 错误码 错误描述 解决方案 404 APIC.0101 The API does not exist or has not been published in the environment.
企业对外开放API供外部伙伴/开发者调用集成 操作场景 企业期望将自身业务能力（如实时快递查询服务）通过API接口对外开放，供外部伙伴/开发者调用集成，构建更繁荣的业务系统生态，并且触达更广泛的业务范围。 准备工作 准备好API接口文档，推荐OpenAPI 2.0/3.0格式。
流量控制：API网关代理支持从用户、IP、凭据和时间段等不同的维度限制对API的调用次数，保护后端服务。 访问控制：API网关代理支持通过设置IP地址或账户的黑白名单来禁止/允许某个IP地址或账户访问API，保护后端服务。 父主题： 安全
每个分组在任意一个环境中，最多可以创建50个环境变量。 负载通道数量 每个用户最多可以创建10个VPC通道，每个负载通道最多可以添加10个服务器。 参数数量 每个API最多可以创建50个参数。 发布历史数量 同一个API在每个环境中最多记录10条最新的发布历史。 每个API的访问频率
Internal Server Error 服务器遇到了一个未曾预料的状况，导致了它无法完成对请求的处理。通常是服务器内部产生了错误，导致处理失败。 502 Bad Gateway 代理服务器尝试执行请求时，从上游服务器接收到无效的响应。 API请求设置媒体类型和编码格式，响应内容格式需与响应设置媒体类型和编码格式一致
对于非简单请求，在正式通信之前，浏览器会增加一次HTTP查询请求，称为预检请求。浏览器询问服务器，当前页面所在的源是否在服务器的许可名单之中，以及可以使用哪些HTTP请求方法和头信息字段。预检通过后，浏览器向服务器发送简单请求。 开启跨域访问 API网关代理默认不开启跨域访问，如果您需要开启，请参考以下说明完成跨域配置。
PI描述信息长度建议不超过2000字符。 例如：发布API用于查询虚拟机列表。良好的API描述应为“通过虚拟机名称、IP地址、虚拟机型号查询当前租户下的虚拟机列表，列表包括虚拟机名称，所属VPC、虚拟机IP、虚拟机型号、操作系统版本。” API文档按照模板进行写作 本条规则是Sh
100） 03 入门 弹性云服务器（Elastic Cloud Server）是一种可随时自动获取、计算能力可弹性伸缩的云服务器。 登录云服务器 什么是ECS 创建容器应用基本流程 初始化数据盘 什么是ECS 创建容器应用基本流程 05 实践 弹性云服务器（Elastic Cloud
appId：API调用者的APP ID。 requestId：当次调用API所生成的请求ID。 serverAddr：网关服务器的地址 。 serverName：网关服务器的名称。 handleTime：本次调用API的处理时间。 providerAppId：API提供者的凭据ID。 a
可维护性 保证API日志采集的实时性及完整性 本条规则是MUST类型的基本规则，可保障API的可维护性。 在采集API调用日志过程中，需要保证API日志的实时性和完整性，以提升API分析的精准度。 API日志在传递过程中，必须保证传递日志不会出现丢失。API日志总体丢失率小于0.5%。
API接口参数传输和存储过程中，敏感信息和个人隐私数据禁止明文传输和存储，避免造成敏感信息或个人隐私数据泄露。敏感信息和个人隐私数据包括： 密码、AK/SK、Token等身份凭据。 密钥。 个人信息，如身份证号码、银行卡信息、家庭住址、健康信息等。 人与人之间的私人消息，如短信、电话通信内容。
过程中不会直接传递SignKey，同时对请求时间进行有效校验，避免重复请求攻击。 动态Token API请求可使用AppId及AppKey向Token服务器换取动态Token，在动态Token有效期内，在API请求Header中携带Token进行身份认证，由于在换取Token过程
功能总览 功能总览 全部 服务商入驻 生产API API资产分享 API网关注册 API搜索和查找 API订阅管理 API数据分析 服务商入驻 支持华为云企业用户申请入驻成为API中心服务商，然后使用API中心管理控制台的以下功能： API资产分享：通过创建API资产，将您开发好
控制。 访问控制 访问控制策略是API网关代理提供的API安全防护组件之一，主要用来控制访问API的IP地址和账户，您可以通过设置IP地址或账户的黑白名单来禁止或允许某个IP地址或账户访问API。 凭据 凭据定义了一个API调用者的身份。API中心支持将一个API授权给多个凭据，也支持将多个API授权给同一个凭据。
根据选择的密钥类型，填写不同的密钥信息。 HMAC：填写APP认证所使用密钥对的Secret。 Basic Auth：填写basic认证所使用的密码。 Aes：填写Aes认证所使用的向量。 Public Key：填写Public Key认证所使用的私钥。 确认Secret 填写与“Secret”一致的值。
服务端提供新版本API的同时，需要对老版本API提供支持。 例如：应用A更新API查询虚拟机列表，增加多个新的查询条件。在API发布之后，之前订阅该API的应用不能因为增加了新的查询条件而造成查询虚拟机列表失败。 API请求HTTP动词使用标准化且满足幂等性 本条规则是Should类型的扩展规则，可提升API的可维护性。
例如，负载中包含6台ECS，已创建一条负载通道，其中ECS 01和ECS 04已添加到负载通道中，此时API网关代理通过负载通道可以直接访问负载中的ECS 01和ECS 04。 图1 通过API网关代理访问负载通道中的ECS 前提条件 API网关代理与负载通道中的服务器之间网络互通。 创建负载通道
API资产管理 通过创建API资产，将您开发好的API分享至API中心门户网站，其他开发者就可以在API中心门户网站搜索到您分享的API，用于自己的项目开发。 前提条件 已成功申请入驻成为API中心服务商。具体操作指导参见服务商入驻。 1个服务商最多可以创建50个API资产。 1
上架API至API中心门户网站 使用场景 如果您想要将已开发好的API上架至API中心门户网站，请参考本章指导操作。 前提条件 已完成服务商入驻，具体操作指导参考《用户指南》服务商入驻章节。 操作步骤 进入API中心服务页面。 选择左侧导航栏中的“API资产管理 > API资产”。
流量控制策略说明 流量控制支持从用户、凭据和时间段等不同的维度限制对API的调用次数，保护后端服务。为了提供持续稳定的服务，您可以通过创建流控策略，针对部分API进行流量控制。 使用限制 同一个环境中，一个API只能被一个流控策略绑定，但一个流控策略可以绑定多个API。 配置参数说明
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
