检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API的描述。 根据下表参数信息,配置安全配置。 表2 安全配置 信息项 描述 安全认证 API认证方式: APP认证:表示由API网关代理负责接口请求的安全认证。推荐使用APP认证方式。 华为IAM认证:表示由IAM对API请求进行安全认证。 无认证:表示API请求不需要认证。
Origin:此字段必选,表示请求消息所属源。 Access-Control-Request-Method:此字段必选,表示请求会使用哪些HTTP请求方法。 Access-Control-Request-Headers:此字段可选,表示请求会额外发送的头信息字段。 后端服务返回消息:无。
可以使用APP认证调用API。 安全认证方式为“无认证”或“华为IAM认证”的API,无需创建凭据。 创建凭据 进入API中心服务页面。 在左侧导航栏选择“API网关代理 > API凭据管理”。 单击“创建凭据”,填写凭据信息。 表1 凭据信息 信息项 描述 凭据名称 凭据的名称。
遵循兼容扩展标准。 忽略请求/响应中的未知字段。 只添加可选字段,不能添加必选字段。 不能更改字段的含义。 当资源URL发生变化的时候,支持重定向。 服务端提供新版本API的同时,需要对老版本API提供支持。 例如:应用A更新API查询虚拟机列表,增加多个新的查询条件。在API发布之
与“API流量限制”配合使用,表示“时长”时间内的单个API请求次数上限。 与“用户流量限制”配合使用,表示“时长”时间内的单个用户请求次数上限。 与“凭据流量限制”配合使用,表示“时长”时间内的单个凭据请求次数上限。 与“源IP流量限制”配合使用,表示“时长”时间内的单个IP地址请求次数上限。
例如:易于理解的API名称应为“查询虚拟机列表”/“ListServers”、“创建VPC网络”/“CreateVPC” API描述信息必须易于理解,表述准确 本条规则是Should类型的扩展规则,可提升API调用者的使用体验。 API描述信息要易于理解,字面表述准确,能说明API的用途,场景及约束。
PI导出和批量API导出。 操作步骤 进入API中心服务页面。 在左侧导航栏选择“API网关代理 > API列表”。 单击页面右上角的“导出API”,设置导出参数。 表1 导出API 信息项 描述 API分组 选择待导出API所在的API分组。 运行环境 选择待导出API所在的环境。
具体示例如表1所示。 表1 API修订记录 时间 版本 变更内容 2021-07-15 V1.0 XXX服务API初始发布 2021-09-20 V1.1 XXX的API,增加XXX字段,用于XXXX功能;增加XXX字段,用于XXX功能。 XXX的API,增加XXX字段,用于XXX功能。
的媒体格式,具体情况如表2所示。 表2 常见的媒体类型 分类 场景 媒体类型 文件上传/下载类 文件上传下载类的接口,直接传递的是文件内容。 须知: 不建议使用该API进行文件传输。 application/octet-stream 表单提交 主要用于界面表单提交,该方法目前已经
服务商入驻 2 优化API资产上架 支持将用户在华为云云商店上架的API资产,周期性地自动上架至API中心门户网站,并展示在管理控制台的API资产列表页。 公测 API资产管理 3 新增API数据分析 支持查看API网关代理中已发布的API被调用的情况,如被请求调用的次数,调用失败的次数等。
约束与限制 API搜索和查找 API中心门户网站汇聚展示千行百业API,为应用开发者提供统一的API搜索查找入口。 支持面向API资产的名称、描述字段的关键词匹配(精确/模糊搜索)。 支持搜索热搜词。 支持搜索词联想。 …… 支持区域: 华北-北京四 在门户网站搜索API 在线调测API
URL”、“请求参数”和“Headers”。 获取API的调用凭据 根据API使用的安全认证方式不同,还要获取相关的请求认证信息,具体参考表1。 表1 认证信息 认证方式 认证信息 APP认证(签名认证) 向API提供方获取该API所授权凭据的Key和Secret,以及认证签名所使用的SDK。
进入API中心服务页面。 在左侧导航栏选择“API网关代理 > API策略”。 单击“负载通道”页签,进入到负载通道列表页面。 单击“创建负载通道”,配置基本信息。 表1 基本信息配置 信息项 描述 通道名称 自定义负载通道名称,用于识别不同的负载通道。 端口 负载通道中主机的端口号,即用户的后端业务端口号。