检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
调用已发布的API 调用API 响应消息头 错误码 父主题： API网关代理
修订记录 发布日期 修订记录 2023-07-14 第九次正式发布。 优化如下章节： 服务商入驻 变更服务商信息 API资产管理 2023-05-06 第八次正式发布。 新增如下章节： 取消入驻服务商 优化如下章节： 服务商入驻 变更服务商信息 负载通道 2023-03-31 第七次正式发布。
API生产 安全性 可用性 易用性 可维护性 父主题： 规范要求
API开放 安全性 可用性 可维护性 生命周期管理 父主题： 规范要求
对于非简单请求，在正式通信之前，浏览器会增加一次HTTP查询请求，称为预检请求。浏览器询问服务器，当前页面所在的源是否在服务器的许可名单之中，以及可以使用哪些HTTP请求方法和头信息字段。预检通过后，浏览器向服务器发送简单请求。 开启跨域访问 API网关代理默认不开启跨域访问，如果您需要开启，请参考以下说明完成跨域配置。
appId：API调用者的APP ID。 requestId：当次调用API所生成的请求ID。 serverAddr：网关服务器的地址 。 serverName：网关服务器的名称。 handleTime：本次调用API的处理时间。 providerAppId：API提供者的凭据ID。 a
例如，负载中包含6台ECS，已创建一条负载通道，其中ECS 01和ECS 04已添加到负载通道中，此时API网关代理通过负载通道可以直接访问负载中的ECS 01和ECS 04。 图1 通过API网关代理访问负载通道中的ECS 前提条件 API网关代理与负载通道中的服务器之间网络互通。 创建负载通道
Internal Server Error 服务器遇到了一个未曾预料的状况，导致了它无法完成对请求的处理。通常是服务器内部产生了错误，导致处理失败。 502 Bad Gateway 代理服务器尝试执行请求时，从上游服务器接收到无效的响应。 API请求设置媒体类型和编码格式，响应内容格式需与响应设置媒体类型和编码格式一致
将分组内已发布的API上架至门户网站 任选以下三种方式之一操作，即可上架分组内已发布的API至API中心门户网站。 方式一：在分组所在行“操作”列，单击“更多>上架”，跳转至“创建API资产”页面。 方式二：单击分组名称，在“API运行”页面，单击右上角的“上架”，跳转至“创建API资产”页面。
上架API至API中心门户网站 使用场景 如果您想要将已开发好的API上架至API中心门户网站，请参考本章指导操作。 前提条件 已完成服务商入驻，具体操作指导参考《用户指南》服务商入驻章节。 操作步骤 进入API中心服务页面。 选择左侧导航栏中的“API资产管理 > API资产”。
华为云租户的安全责任在于对使用的IaaS、PaaS和SaaS类各项云服务内部的安全以及对租户定制配置进行安全有效的管理，包括但不限于虚拟网络、虚拟主机和访客虚拟机的操作系统，虚拟防火墙、API网关和高级安全服务，各项云服务，租户数据，以及身份账号和密钥管理等方面的安全配置。 《华为云安全白皮
参数名称 说明 导入方式 支持以下6种方式，上架API文件至API中心门户网站： OpenAPI：支持导入符合OpenAPI 2.0/3.0标准的txt、yml、yaml、json格式的API文件。 API网关：支持将API网关代理中已发布的API，上架至API中心门户网站。 Postman
参数名称 说明 导入方式 支持以下6种方式，上架API文件至API中心门户网站： OpenAPI：支持导入符合OpenAPI 2.0/3.0标准的txt、yml、yaml、json格式的API文件。 API网关：支持将API网关代理中已发布的API，上架至API中心门户网站。 Postman
传递SignKey，同时对请求时间进行有效校验，避免重复请求攻击。 动态Token API请求可使用AppId及AppKey向Token服务器换取动态Token，在动态Token有效期内，在API请求Header中携带Token进行身份认证，由于在换取Token过程中传递AppK
每个分组在任意一个环境中，最多可以创建50个环境变量。 负载通道数量 每个用户最多可以创建10个VPC通道，每个负载通道最多可以添加10个服务器。 参数数量 每个API最多可以创建50个参数。 发布历史数量 同一个API在每个环境中最多记录10条最新的发布历史。 每个API的访问频率
PI描述信息长度建议不超过2000字符。 例如：发布API用于查询虚拟机列表。良好的API描述应为“通过虚拟机名称、IP地址、虚拟机型号查询当前租户下的虚拟机列表，列表包括虚拟机名称，所属VPC、虚拟机IP、虚拟机型号、操作系统版本。” API文档按照模板进行写作 本条规则是Sh
如何获取API调用凭据？ 如果是来源于华为云服务的API，您可通过token认证或AK/SK认证进行API的在线调测和调用。在线调测时，用户登录华为云账号后，API中心会为您自动获取Token或者自动生成临时AK/SK，帮助您直接进行在线调测；调用API时，可根据参数填写项的提示
服务端提供新版本API的同时，需要对老版本API提供支持。 例如：应用A更新API查询虚拟机列表，增加多个新的查询条件。在API发布之后，之前订阅该API的应用不能因为增加了新的查询条件而造成查询虚拟机列表失败。 API请求HTTP动词使用标准化且满足幂等性 本条规则是Should类型的扩展规则，可提升API的可维护性。
Arts工具右下角的“前往使用”，进入API Arts工具界面。 参考API设计和API测试章节指导，在API Arts完成API的设计和测试。 上架API至API中心门户网站。 在API Arts界面单击项目名称，进入目标项目详情页面。 在左侧选择“API发布”，然后单击“申请发布”，
与其他服务的关系 API Arts API中心将API Arts作为API生产工具提供给API开发者，并支持API开发者将工具中的API文档一键发布到API中心进行分享和开放。 API Explorer API中心对接集成API Explorer，并将其作为API中心的API调试
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
