检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 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.
图3 申请入驻API中心 如果您已入驻成为华为云云商店服务商,则系统会自动填充服务商信息,您不需要再次填写服务商信息,直接执行5即可。 最多支持输入2个电话和2个邮箱。 勾选“我已阅读并同意《华为云API中心服务商合作协议》和《华为云隐私政策声明》”,单击“立即提交”。
创建API分组 API分组相当于API的集合,API提供者以API分组为单位,管理分组内的所有API。您在创建API前,需要先创建API分组。 目前支持两种创建分组方式: 创建API分组 创建一个简单的分组,不包含API,用户可自行创建API。 导入Swagger文件 从本地导入已有的
导出API 导出JSON或YAML格式的API。API网关代理支持单个API导出和批量API导出。 操作步骤 进入API中心服务页面。 在左侧导航栏选择“API网关代理 > API列表”。 单击页面右上角的“导出API”,设置导出参数。 表1 导出API 信息项 描述 API分组
授权API API在创建后,通过指定授权给某些凭据,让指定凭据能够调用API。 仅在API安全认证方式为“APP认证”时,才支持授权给凭据。 单个凭据最多同时授权1000个API。 也可以参考绑定API,将API授权给凭据,与本章所描述方法并无差别。 前提条件 API已发布。 已创建环境
此外,通过对接集成API工具、华为云商店、华为云集成工作台、低代码平台等华为云或生态伙伴相关服务或产品,为API开发者提供高效协同、自动化的API生产工具,并支持高价值API商业售卖;为应用开发者提供多场景、低门槛的低代码应用开发环境和开箱即用的API。
响应消息头 调用API时,API网关代理增加如下响应消息头。 X-Apig-Mode: debug表示响应消息头增加API网关代理调试信息。 响应消息头 描述 说明 X-Request-Id 请求ID 所有合法请求,都会返回此参数 X-Apig-Latency 从API网关代理接收请求到后端返回消息头的用时
为简易认证绑定AppCode 简易认证指调用API时,在HTTPS请求头部消息增加一个参数“X-Apig-AppCode”(参数值填凭据详情中“AppCode”的值),而不需要对请求内容签名,API网关代理也仅校验AppCode,不校验请求签名,从而实现快速响应。 当使用APP认证
支持区域: 华北-北京四 购买API 汇聚华为云云商店的API API中心汇聚您在华为云云商店上架的API至API中心门户网站,为云商店引流;为您的API变现增加渠道。
直接变现:API开发者完成API设计/开发/测试后,可以将API注册在华为云生态网关,然后在华为云云商店上架API商品并定价售卖,实现直接售卖API并获得商业收益。 间接变现:API能力开放给应用开发者,供其在应用开发和集成中调用。
API门户支持开发者(API使用方)在免登录情况下浏览、搜索API,通过华为云账号登录后,还可进行在线调测、购买或申请凭证等。 API提供方可在API中心完成API发布、变更、下线等生命周期管理。 操作指导 相关操作指导,请参考华为云帮助中心API Hub。
华为云云商店 API中心聚集API开发者和应用开发者,并汇聚技术分享和商业售卖的所有API,为云商店引流;云商店提供商业变现通道。 华为云集成工作台 API中心可以通过对接aPaaS集成工作台的集成框架,支持aPaaS集成工作台获取并使用API资产元数据,用于连接器的创建和使用。
说明: 同一个华为云账号下的API资产名称不能重复。 图标 为API资产设置一个图标。如果不设置,则显示默认图标。 资产简介 简单介绍下API资产的行业,用途等。 使用指南 描述API的调用方法。 资产域名 API服务的主机域名或IP,用于API在线调试。
只允许华为云企业账号申请成为API中心服务商。 父主题: 服务商入驻
与华为云集成工作台对接集成,支持API快速生成连接器,并用于SaaS开发和集成。
社区求助 华为云社区是华为云用户的聚集地。这里有来自容器服务的技术牛人,为您解决技术难题。
基本概念 API API(Application Programming Interface,应用程序编程接口)是一些预先定义的函数,应用将自身的服务能力封装成API,并通过API网关代理开放给用户调用。 API包括基本信息、前后端的请求路径、参数以及请求相关协议。 API分组 API
身份认证与访问控制 身份认证 服务认证:API网关代理提供AK/SK、Token等多种方式进行服务认证,只允许授权的访问。 签名密钥:API网关代理提供签名密钥,用于后端服务校验API网关代理是否合法。 访问控制 流量控制:API网关代理支持从用户、IP、凭据和时间段等不同的维度限制对
注册API到网关代理 使用场景 如果您想要将已开发好的API注册到API中心网关,请参考本章指导操作。 前提条件 已完成服务商入驻,具体操作指导参考《用户指南》服务商入驻章节。 使用流程 作为API提供者开放API,您需要先后完成以下流程: 步骤1:创建API分组 进入API中心服务页面
生命周期管理 API接口变更在参考文档中为新版本提供迁移计划 本条规则是Should类型的扩展规则,可方便管理API的生命周期。 在进行新版本API设计时应当考虑老版本升级迁移计划,从而实现API的迁移。新版本中继承的接口在语义上应当能兼容老版本。 对于计划不再支持的接口,需要正式发布接口变更公告