检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
准备好API使用指南,说明API凭据获取方式、以及提供API使用时的补充说明信息。 API对应的后端服务已部署上线,并且推荐提供服务域名或IP地址,有助于伙伴/开发者便捷地在线调试API。 已注册华为账号并开通华为云,并已完成企业实名认证。
在API中心门户网站首页,单击页面右上角的“服务商入驻”,进入申请入驻服务商页面。 仅支持华为云企业用户申请入驻API中心服务商。 父主题: 服务商入驻
创建凭据并绑定API 使用APP认证的API,需要在API网关代理中创建一个凭据,以生成凭据ID和密钥对(Key、Secret)。将创建的凭据绑定API后,才可以使用APP认证调用API。 安全认证方式为“无认证”或“华为IAM认证”的API,无需创建凭据。
支持区域: 华北-北京四 购买API 汇聚华为云云商店的API API中心汇聚您在华为云云商店上架的API至API中心门户网站,为云商店引流;为您的API变现增加渠道。
只允许华为云企业账号申请成为API中心服务商。 父主题: 服务商入驻
与华为云集成工作台对接集成,支持API快速生成连接器,并用于SaaS开发和集成。
图1 添加特殊租户 表2 特殊租户信息 信息项 描述 租户ID 绑定华为IAM认证的API时,租户ID填写API调用者的账号ID。 绑定APP认证的API时,租户ID填写APP所属者的项目ID。
如果您在华为云云商店上架了API资产,则API资产会周期性地自动上架至API中心门户网站,并展示在API资产列表页。 后续操作 创建完API资产后,您还可以执行表3的操作。
账号名 输入需要允许或者禁止访问API的账号名,仅在API的安全认证方式为“华为IAM认证”时适用。 仅在“类型”为“账号名”时,需要设置。支持输入多个账号名,以英文“,”隔开,如aaa,bbb。 说明: 仅支持账号维度的访问控制,不能对单个IAM用户进行访问控制。
父主题: 调用已发布的API
获取API的调用凭据 根据API使用的安全认证方式不同,还要获取相关的请求认证信息,具体参考表1。 表1 认证信息 认证方式 认证信息 APP认证(签名认证) 向API提供方获取该API所授权凭据的Key和Secret,以及认证签名所使用的SDK。
响应消息头 描述 说明 X-Request-Id 请求ID 所有合法请求,都会返回此参数 X-Apig-Latency 从API网关代理接收请求到后端返回消息头的用时 仅在请求消息头包含X-Apig-Mode: debug时,返回此参数 X-Apig-Upstream-Latency
是否必须使用API中心的网关代理功能? 不是。如果您的API已经注册在自有网关或者其他第三方网关,API中心仍然支持您创建API资产,将API展示在API中心门户网站。 父主题: API网关代理
是否必须使用API中心的网关代理功能? 更多 智能客服 您好!我是有问必答知识渊博的智能问答机器人,有问题欢迎随时求助哦! 社区求助 华为云社区是华为云用户的聚集地。这里有来自容器服务的技术牛人,为您解决技术难题。
说明: 同一个华为云账号下的API资产名称不能重复。 图标 为API资产设置一个图标。如果不设置,则显示默认图标。 资产简介 简单介绍下API资产的行业,用途等。 使用指南 描述API的调用方法。 资产域名 API服务的主机域名或IP,用于API在线调试。
导入API API网关代理支持导入Swagger 2.0定义的API到已有的API分组或新的API分组。Swagger是基于OpenAPI规范构建的开源工具,可以帮助您设计、构建、记录以及使用Rest API。
术语 API API(Application Programming Interface,应用程序接口)是一些预先定义的函数,目的是提供应用程序与开发人员基于某软件或硬件得以访问一组例程的能力,而又无需访问源码,或理解内部工作机制的细节。
API中心服务商在上架API资产时,如果提供了符合Swagger 2.0/OpenAPI 3.0规范的API文件,且提供了API资产的访问域名,则该API可以在线调测。 父主题: API网关代理
描述 API的描述。 根据下表参数信息,配置安全配置。 表2 安全配置 信息项 描述 安全认证 API认证方式: APP认证:表示由API网关代理负责接口请求的安全认证。推荐使用APP认证方式。 华为IAM认证:表示由IAM对API请求进行安全认证。
调用不同环境的API,一般通过在API调用的请求头增加指定的头部参数,头部参数名固定为x-stage,它的取值为环境名,用以区分不同的环境。 环境变量 在环境上创建可管理的一种变量,该变量固定在环境上。通过创建环境变量,实现同一个API在不同环境中调用不同的后端服务。