检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
如果是来源于华为云市场的API商品，可按照页面提示完成购买，然后在“买家中心>已购买的服务”中看到商品信息，单击“资源详情”可查看API调用凭据（AppKey/AppSecret）。 如果是其他来源的技术开放型API，可根据API使用指南或者联系API服务商获取API调用凭据。
API请求失败总数 API网关代理中，已发布的所有API被调用失败的总次数。数据10分钟刷新一次。 在“API监控”区域，展开API右侧的下拉框，选择您想要查看调用情况的API。 选择要查看的时间范围。支持查看近1个小时、近6个小时、近24个小时或近7天的调用情况。
API中心门户网站支持用户在免登录情况下搜索和查看API。 搜索API 搜索栏搜索 您可以在搜索栏输入您想要查找的API的一些关键信息，如API资产的名称，描述等，系统会显示相关的搜索结果。
删除API资产 在API资产列表页，单击API资产所在行“操作”列的“删除”。 查看API资产包含的接口信息 在API资产列表页，单击API资产所在行“状态”列的“查看”。
当资源数量较多时服务的查询API需要支持分页，避免一次查询获取的资源数量过多。 不支持分页查询，则服务应该要设置一个显示条数的默认值，避免一次返回过多资源。默认返回数量需要在接口参考中对外说明，避免调用者以为查询出了全量信息。
什么是API中心 API（Application Programing Interface，应用程序接口）是一些预先定义的函数，目的是提供应用程序与开发人员基于软件或硬件得以访问一组例程的能力，而又无需访问源码或理解内部工作机制的细节。
在左侧导航栏选择“API网关代理 > API列表”。 单击待查看发布历史的API名称，进入“API运行”页面。 单击“更多 > 发布历史”。 在版本所在行，单击“查看版本”，弹出此版本详细信息对话框。
企业对外开放API供外部伙伴/开发者调用集成 操作场景 企业期望将自身业务能力（如实时快递查询服务）通过API接口对外开放，供外部伙伴/开发者调用集成，构建更繁荣的业务系统生态，并且触达更广泛的业务范围。 准备工作 准备好API接口文档，推荐OpenAPI 2.0/3.0格式。
表2 常见的媒体类型 分类 场景 媒体类型 文件上传/下载类 文件上传下载类的接口，直接传递的是文件内容。 须知： 不建议使用该API进行文件传输。
支持区域： 华北-北京四 约束与限制 API搜索和查找 API中心门户网站汇聚展示千行百业API，为应用开发者提供统一的API搜索查找入口。 支持面向API资产的名称、描述字段的关键词匹配（精确/模糊搜索）。 支持搜索热搜词。 支持搜索词联想。
服务所提供的API版本定义统一规范成“vX”，这里X是一个正整数如：v1，v2等，要在API版本文档中明确在接口中说明清楚哪个版本号是目前服务主推的版本，哪些版本是支持但已经不推荐的版本，方便API调用者通过该接口快速了解与跟进服务API的变化。
调试API API创建后需要验证服务是否正常，管理控制台提供调试功能，您可以添加HTTP头部参数与body体参数，调试API接口。 后端路径中含有环境变量的API，不支持调试。 如果API已绑定流控策略，在调试API时，流控策略无效。 前提条件 已搭建完成后端服务。
术语 API API（Application Programming Interface，应用程序接口）是一些预先定义的函数，目的是提供应用程序与开发人员基于某软件或硬件得以访问一组例程的能力，而又无需访问源码，或理解内部工作机制的细节。
安全性 涉及敏感信息或个人隐私数据的API，应提供数据传输和存储过程中的安全机制 本条规则是MUST类型的基本规则，可保障API的安全合规。 API接口参数传输和存储过程中，敏感信息和个人隐私数据禁止明文传输和存储，避免造成敏感信息或个人隐私数据泄露。
单击API资产，查看API资产的开发文档。 在需要调试的接口详情页面，单击“在线调试”。 部分API未提供调试功能，具体以详情页面展示的信息为准。
所属分组 默认创建API分组中已创建分组。 URL 请求方法：接口调用方式，此处选择“GET”。 请求协议：选择协议类型，此处选择“HTTPS”。 子域名：创建API分组时，系统默认分配的一个子域名。 路径：接口请求的路径。
查看API的监控指标 单击分组名称，在“API运行”页面左侧选择API，在“监控视图”区域，查看API的各项监控指标。包括“请求次数”、“调用延时”、“数据流量”和“出错统计”。 父主题： API分组
非简单请求：在正式通信之前，增加一次HTTP查询请求。 开启CORS（非简单请求）时，您需要创建一个“请求方法”为“OPTIONS”的API，具体操作请参考开启跨域访问。 （可选）根据实际需要定义API的请求参数，请求参数定义见下表。
生命周期管理 API接口变更在参考文档中为新版本提供迁移计划 本条规则是Should类型的扩展规则，可方便管理API的生命周期。 在进行新版本API设计时应当考虑老版本升级迁移计划，从而实现API的迁移。新版本中继承的接口在语义上应当能兼容老版本。
基本概念 API API（Application Programming Interface，应用程序编程接口）是一些预先定义的函数，应用将自身的服务能力封装成API，并通过API网关代理开放给用户调用。 API包括基本信息、前后端的请求路径、参数以及请求相关协议。
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
