检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API文档记录API接口变更 本条规则是Should类型的扩展规则,可方便管理API的生命周期。 API接口的变更,要具体到参数级别,必须将API修订的记录按照时间和版本顺序排列进行条目化,具体示例如表1所示。 表1 API修订记录 时间 版本 变更内容 2021-07-15 V1.0 XXX服务API初始发布
Z容灾、AZ内集群容灾、数据库主备容灾,保障服务的持久性与可靠性。 表1 API中心可靠性架构 可靠性方案 简要说明 跨Region容灾 全局级部件支持跨Region容灾,当主Region异常后,全局业务可以切换到备Region继续运行。 双AZ容灾 Region级部件实现跨AZ
服务商 服务商入驻 变更服务商信息 取消入驻服务商
修订记录 2023-07-14 第九次正式发布。 优化如下章节: 服务商入驻 变更服务商信息 API资产管理 2023-05-06 第八次正式发布。 新增如下章节: 取消入驻服务商 优化如下章节: 服务商入驻 变更服务商信息 负载通道 2023-03-31 第七次正式发布。 优化如下章节:
服务端提供新版本API的同时,需要对老版本API提供支持。 例如:应用A更新API查询虚拟机列表,增加多个新的查询条件。在API发布之后,之前订阅该API的应用不能因为增加了新的查询条件而造成查询虚拟机列表失败。 API请求HTTP动词使用标准化且满足幂等性 本条规则是Should类型的扩展规则,可提升API的可维护性。
在左侧导航栏选择“API网关代理 > API列表”。 单击“创建API”。 配置前端定义。 图2 前端定义 表2 前端定义 参数 配置说明 API名称 系统默认自动生成一个API名称,建议按照一定的命名规则填写,方便后期快速识别和查找。 所属分组 默认创建API分组中已创建分组。
在“凭据管理”页面,单击凭据名称,进入详情页面。 在“AppCodes”区域,单击“添加AppCode”。 在弹窗中配置AppCode,完成后单击“确定”。 表1 配置AppCode 信息项 描述 生成方式 选择AppCode的生成方式。 自动生成:由系统随机生成AppCode。 手动输入:自定义AppCode。
方)在免登录情况下浏览、搜索API,通过华为云账号登录后,还可进行在线调测、购买或申请凭证等。 API提供方可在API中心完成API发布、变更、下线等生命周期管理。 操作指导 相关操作指导,请参考华为云帮助中心API Hub。 父主题: 附录-API治理规范指导
API网关代理:API网关代理包括API的创建、发布、下线和删除所经历的完整生命周期过程,为您提供高性能、高可用、高安全的API托管服务。 API数据分析:查看API网关代理中已发布的API被调用的情况,如被请求调用的次数,调用失败的次数等。 只允许华为云企业账号申请成为API中心服务商。 父主题:
中对外说明,避免调用者以为查询出了全量信息。查询条件中可以设定查询数量(limit),位移量(offset)。查询资源列表需要返回符合查询条件的资源总数(count)、查询数量(limit)、位移量(offset)。 举例:查询虚拟机从第10条开始,查询后100条。 请求 GET
K/SK。 如果是来源于华为云市场的API商品,可按照页面提示完成购买,然后在“买家中心>已购买的服务”中看到商品信息,单击“资源详情”可查看API调用凭据(AppKey/AppSecret)。 如果是其他来源的技术开放型API,可根据API使用指南或者联系API服务商获取API调用凭据。
(可选)在线调测API。 对于不需要付费购买的API(技术开放型API),可以通过以下步骤在线调测API,快速试用API。 单击API资产,查看API资产的开发文档。 在需要调试的接口详情页面,单击“在线调试”。 部分API未提供调试功能,具体以详情页面展示的信息为准。 对于需要付
用者使用体验。 可维护性:对于API兼容性、日志实时性和完整性、版本管理等提出规范要求或建议,提升API可维护性。 生命周期管理:对API变更和下线等提出规范要求或建议,保障已订阅API租户的业务连续性。 包含Must类型的基本规则以及Should类型的扩展规则。Must规则牵引
细节。API中心是为API开发者和应用开发者构建的海量API的汇聚运营平台。帮助API开发者高效便捷地分享和开放API,支持应用开发者快速查找所需API并进行应用开发和集成。 此外,通过对接集成API工具、华为云商店、华为云集成工作台、低代码平台等华为云或生态伙伴相关服务或产品,
API中心(API Hub)是为API开发者和应用开发者构建的,海量API的汇聚运营平台。帮助API开发者高效便捷地分享和开放API,支持应用开发者快速查找所需API并进行应用开发和集成。API中心贯通并粘合API生产、API开放和API消费,促进API供需匹配,形成API生产、消费、再生产的良性循环。
行签名,通过比对签名结果和API网关代理传过来的Authorization头中签名是否一致,来校验API网关代理的合法性。 配置参数说明 表1 配置参数说明 信息项 描述 密钥名称 自定义名称,用于识别不同的密钥。 类型 选择签名密钥的认证类型,可选择“HMAC”、“Basic Auth”、“Public
的媒体格式,具体情况如表2所示。 表2 常见的媒体类型 分类 场景 媒体类型 文件上传/下载类 文件上传下载类的接口,直接传递的是文件内容。 须知: 不建议使用该API进行文件传输。 application/octet-stream 表单提交 主要用于界面表单提交,该方法目前已经
使用前必读 API中心是为API开发者和应用开发者构建的海量API的汇聚运营平台。帮助API开发者高效便捷的分享和开放API,支持应用开发者快速查找所需API并进行应用开发和集成。本文将详细介绍API中心服务的基本功能以及操作步骤。
URL”、“请求参数”和“Headers”。 获取API的调用凭据 根据API使用的安全认证方式不同,还要获取相关的请求认证信息,具体参考表1。 表1 认证信息 认证方式 认证信息 APP认证(签名认证) 向API提供方获取该API所授权凭据的Key和Secret,以及认证签名所使用的SDK。
产品功能 表1 API中心功能概览 功能名称 功能描述 发布区域 API设计和测试 API开发者可使用API中心工具库中的API生产工具(如华为云API Arts),进行API的设计、测试等。 华北-北京四 服务商入驻 API开发者可在线申请入驻成为API中心的服务商。 华北-北京四