检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
图解API中心
获取API的调用信息 在调用API前,您需要向API提供方获取API的调用信息。 获取API的请求信息 向API提供方获取API的“域名”、“请求方法”、“API URL”、“请求参数”和“Headers”。 获取API的调用凭据 根据API使用的安全认证方式不同,还要获取相关的请求认证信息,具体参考表1。
调用已发布的API 调用API 响应消息头 错误码 父主题: API网关代理
同一个API在每个环境中最多记录10条最新的发布历史。 前提条件 已创建环境。 发布API 进入API中心服务页面。 在左侧导航栏选择“API网关代理 > API列表”。 在待发布的API所在行,单击“操作”列的“发布”。 批量发布API:在API列表页,批量勾选API,单击正
调试API API创建后需要验证服务是否正常,管理控制台提供调试功能,您可以添加HTTP头部参数与body体参数,调试API接口。 后端路径中含有环境变量的API,不支持调试。 如果API已绑定流控策略,在调试API时,流控策略无效。 前提条件 已搭建完成后端服务。 操作步骤 进入API中心服务页面。
产品架构 图1 API中心产品架构 API中心主要包括API工具,API门户,API网关代理,API运营四个产品模块: API工具 API中心通过对接集成API开发工具,为API开发者提供简单易用的API工具,帮助开发者高效地设计、测试API。 API门户 API中心构建面向广大
如何获取API调用凭据? 如果是来源于华为云服务的API,您可通过token认证或AK/SK认证进行API的在线调测和调用。在线调测时,用户登录华为云账号后,API中心会为您自动获取Token或者自动生成临时AK/SK,帮助您直接进行在线调测;调用API时,可根据参数填写项的提示
在API资产列表页,单击API资产名称,查看API资产详情。 修改API资产信息 在API资产列表页,单击API资产所在行“操作”列的“编辑”,修改API资产信息。 删除API资产 在API资产列表页,单击API资产所在行“操作”列的“删除”。 查看API资产包含的接口信息 在AP
API售卖与技术支持 如何对API进行商业售卖? 谁为API使用者提供技术支持?
API工具库 该页面展示的是一些开发API的工具。通过这个页面的工具可以开发API,然后通过创建API资产,将开发好的API分享至API中心。 操作步骤 下面以API Arts工具为例,描述如何开发API并上架API至API中心门户网站。 进入API中心服务页面。 选择左侧导航栏中的“API工具库”。
对已经订阅的API单个或批量取消订阅:参考取消订阅API。 查看订阅的所有API 进入API中心服务页面。 选择左侧导航栏中的“API订阅管理” ,进入“API订阅管理”页面。 “API订阅管理”页面展示您在API中心门户网站订阅的所有API。您可以在右上角输入API资产名称或服务商名称,筛选想要查看的API。
的API分组。 API接口 当“导入方式”为下面几种之一时,支持勾选部分接口导入。如果导入全部接口,则忽略此参数。 OpenAPI API网关 Postman Collection API Arts API URL 当“导入方式”为“URL”时,需要填写API资产的URL地址。 根据表2参数信息配置资产基本信息。
创建API分组 API分组相当于API的集合,API提供者以API分组为单位,管理分组内的所有API。您在创建API前,需要先创建API分组。 目前支持两种创建分组方式: 创建API分组 创建一个简单的分组,不包含API,用户可自行创建API。 导入Swagger文件 从本地导入已有的API文件,同步创建分组。
Secret。 绑定API 在“凭据管理”页面,单击凭据名称,进入详情页面。 在“关联API”区域,单击“绑定API”。 选择授权环境、API分组和API。 单击“确定”。 如需解绑API,在API所在行单击“解绑”即可。 也可以参考授权API章节,将API授权给凭据,与本节所描述方法并无差别。
进入API中心服务页面。 在左侧导航栏选择“API网关代理 > API分组”。 单击右上角“创建API分组 > 创建API分组”。 表1 配置分组信息 参数 配置说明 分组名称 API分组名称,用于将API接口进行分组管理。 描述 对分组的介绍。 单击“确定”,创建API分组。系统会同时为其分配一个子域名,您可以用于调试API。
概述 简介 术语 父主题: 附录-API治理规范指导
规范要求 API生产 API开放 父主题: 附录-API治理规范指导
参数名称 含义 API总数 API网关代理中,已创建的API的总个数。数据1个小时刷新一次。 API分组总数 API网关代理中,已创建的API分组的总个数。数据1个小时刷新一次。 API请求总数 API网关代理中,已发布的所有API被调用的总次数。数据10分钟刷新一次。 API请求失败总数
安全 责任共担 身份认证与访问控制 服务韧性 认证证书
华北-北京四 API资产管理 API中心服务商可在API中心管理控制台管理API资产。 华北-北京四 API网关代理 API中心服务商可使用API中心的网关代理模块,进行API注册、发布,并支持配置流控策略、访问控制、签名密钥等策略来限制对API的访问。 华北-北京四 API门户 API中心