检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
为API资产设置一个图标。如果不设置,则显示默认图标。 资产简介 简单介绍下API资产的行业,用途等。 使用指南 描述API的调用方法。 资产域名 API服务的主机域名或IP,用于API在线调试。 分类 选择API资产所属行业,方便API资产在API中心门户网站按行业类别被搜索。 可见范围 公开:
已发布的API因为其他原因需要暂停对外提供服务,可以暂时将API从相关环境中下线。 该操作将导致此API在指定的环境无法被访问,请确保已经告知使用此API的用户。 前提条件 已创建API分组和分组内的API。 API已发布到该环境。 操作步骤 进入API中心服务页面。 在左侧导航栏选择“API网关代理
与“时长”配合使用,表示“时长”时间内的单个API请求次数上限。 用户流量限制 单个用户调用API次数上限,仅在API的安全认证方式为“华为IAM认证”时适用。 不能大于“API流量限制”的值。 与“时长”配合使用,表示“时长”时间内的单个用户请求次数上限。 如果主账号下有多个子用户访问API,按主账号累计的调用次数进行限制。
代理服务器尝试执行请求时,从上游服务器接收到无效的响应。 API请求设置媒体类型和编码格式,响应内容格式需与响应设置媒体类型和编码格式一致 本条规则是MUST类型的基本规则,可保障API的高可用性。 在API请求中对媒体类型和编码格式的正确定义有助于服务端对请求体进行格式校验,避免出现因请求消息体格式错误导致的执行异常。
例如,负载中包含6台ECS,已创建一条负载通道,其中ECS 01和ECS 04已添加到负载通道中,此时API网关代理通过负载通道可以直接访问负载中的ECS 01和ECS 04。 图1 通过API网关代理访问负载通道中的ECS 前提条件 API网关代理与负载通道中的服务器之间网络互通。
API分组 创建API分组 域名管理 环境变量 父主题: API网关代理
debug,且API配置了应用流量限制时,返回此参数 X-Apig-RateLimit-ip 源IP流量限制信息 示例:remain:9,limit:10,time:10 second 仅在请求消息头包含X-Apig-Mode: debug,且API配置了源IP流量限制时,返回此参数 X-Apig-RateLimit-api-allenv
果超过3个版本会增加API本身的维护量,建议对旧版本API进行下线处理。 服务端API改动必须保证所有的服务消费者不被破坏。API是服务端和客户端的契约,不能单方面破坏契约。通过如下的方式来保证向后的兼容性: 遵循兼容扩展标准。 忽略请求/响应中的未知字段。 只添加可选字段,不能添加必选字段。
API策略 创建策略 流量控制策略说明 访问控制策略说明 签名密钥策略说明 负载通道 环境管理 父主题: API网关代理
API列表 创建API 导入API 导出API 发布API 授权API 调试API 下线API 开启跨域访问 父主题: API网关代理
API中心服务商可使用API中心的网关代理模块,进行API注册、发布,并支持配置流控策略、访问控制、签名密钥等策略来限制对API的访问。 华北-北京四 API门户 API中心门户汇聚展示千行百业API,为应用开发者提供统一的API搜索查找入口,并通过智能搜索和推荐,帮助开发者快速找到所需API。 华北-北京四 在线调测
安全 责任共担 身份认证与访问控制 服务韧性 认证证书
如果在选择环境时,没有自己需要的环境,单击“创建环境”链接,创建一个自己需要的环境。 单击“确定”,完成API发布。 已发布的API因为其他原因需要暂停对外提供服务,可以暂时将API从相关环境中下线。该操作将导致此API在指定的环境无法被访问,请确保已经告知使用此API的用户后,选择待下线的API,单击“下线”即可。
ger规范定义项外,还包括API网关代理的一些Swagger扩展字段。 全量定义:导出API前端定义和后端定义。 扩展定义:导出API前端定义、后端定义、API关联的流量控制、访问控制等策略及绑定关系。 导出格式 选择JSON或YAML。 自定义版本 为导出的API自定义版本号,如果没有指定版本号,默认使用当前时间。
创建策略 通过策略的方式,为API提供灵活的控制策略和扩展能力。 前提条件 一个API只能绑定一个相同类型的策略。 策略和API本身相互独立,只有为API绑定策略后,策略才对API生效。为API绑定策略时需指定发布环境,策略只对指定环境上的API生效。 策略的绑定、解绑、更新会实时生效,不需要重新发布API。
用性。 易用性:对API参考文档描述、入参和出参、消息头定义等提出规范要求或建议,提升API调用者使用体验。 可维护性:对于API兼容性、日志实时性和完整性、版本管理等提出规范要求或建议,提升API可维护性。 生命周期管理:对API变更和下线等提出规范要求或建议,保障已订阅API租户的业务连续性。
后端服务的安全。 签名密钥由一对Key和Secret组成,签名密钥需要绑定到API才能生效。当签名密钥绑定API后,API网关代理向后端服务发送此API的请求时,会增加相应的签名信息,此时需要后端服务依照同样方式进行签名,通过比对签名结果和API网关代理传过来的Authoriza
认证或AK/SK认证进行API的在线调测和调用。在线调测时,用户登录华为云账号后,API中心会为您自动获取Token或者自动生成临时AK/SK,帮助您直接进行在线调测;调用API时,可根据参数填写项的提示链接和指导文档,获取用户Token和AK/SK。 基于已获取到的API调用凭
超过2000字符。 例如:发布API用于查询虚拟机列表。良好的API描述应为“通过虚拟机名称、IP地址、虚拟机型号查询当前租户下的虚拟机列表,列表包括虚拟机名称,所属VPC、虚拟机IP、虚拟机型号、操作系统版本。” API文档按照模板进行写作 本条规则是Should类型的扩展规则,可提升API调用者的使用体验。
API中心全新公测上线 API中心是华为云为API开发者和应用开发者构建的海量API汇聚运营平台。帮助API开发者高效便捷的分享和开放API,支持应用开发者快速查找所需API并进行应用开发和集成。通过统一汇聚和持续运营,API中心贯通并粘合API生产、API开放和API消费,促进API供需匹配,形成