检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
概述 简介 术语 父主题: 附录-API治理规范指导
规范要求 API生产 API开放 父主题: 附录-API治理规范指导
API生产 安全性 可用性 易用性 可维护性 父主题: 规范要求
API开放 安全性 可用性 可维护性 生命周期管理 父主题: 规范要求
基本概念 API API(Application Programming Interface,应用程序编程接口)是一些预先定义的函数,应用将自身的服务能力封装成API,并通过API网关代理开放给用户调用。 API包括基本信息、前后端的请求路径、参数以及请求相关协议。 API分组
API数据分析:查看API网关代理中已发布的API被调用的情况,如被请求调用的次数,调用失败的次数等。 只允许华为云企业账号申请成为API中心服务商。 前提条件 已完成华为云账号企业用户实名认证。 仅允许华为云账号入驻API中心服务商,不允许该账号下的IAM用户入驻API中心服务商。 操作步骤 进入API中心服务页面。
可维护性 保证API日志采集的实时性及完整性 本条规则是MUST类型的基本规则,可保障API的可维护性。 在采集API调用日志过程中,需要保证API日志的实时性和完整性,以提升API分析的精准度。 API日志在传递过程中,必须保证传递日志不会出现丢失。API日志总体丢失率小于0.5%。
可用性 API需要配置并发请求及流量控制 本条规则是Should类型的扩展规则,可提升API的可用性。 在API发布之前,需要根据设计的服务等级标准进行流量控制设置。API流量控制包括三个部分:并发请求控制,吞吐量控制和传输流量控制。 并发请求控制:指API最大允许的客户端连接数量。
术语 API API(Application Programming Interface,应用程序接口)是一些预先定义的函数,目的是提供应用程序与开发人员基于某软件或硬件得以访问一组例程的能力,而又无需访问源码,或理解内部工作机制的细节。 API Gateway API Gateway(Application
API每次最大可以调用12M的请求包。 TLS协议 支持TLS1.1和TLS1.2,推荐使用TLS1.2。 本章描述的“用户”指的都是华为云账号。 如果API网关代理当前的配额限制无法满足您的需求,您可以向系统提交工单申请更多配额。
充服务商信息,您不需要再次填写服务商信息,直接执行5即可。 最多支持输入2个电话和2个邮箱。 勾选“我已阅读并同意《华为云API中心服务商合作协议》和《华为云隐私政策声明》”,单击“立即提交”。 根据您是否需要使用API网关代理功能,选择对应的操作。 是:联系API中心运营人员,并告知其您需要使用API网关代理功能。
易用性 API名称必须易于理解、见名知义 本条规则是Should类型的扩展规则,可提升API调用者的使用体验。 API名称要简洁、易于理解、见名知义,建议按照“动词+名词”格式。 在生产环境的API不能包含“test、uat、sit、beta”等字样,API名称只支持中文、字母、
进入API中心服务页面,在左侧导航栏选择“服务商入驻”,申请入驻服务商。 在API中心门户网站首页,单击页面右上角的“服务商入驻”,进入申请入驻服务商页面。 仅支持华为云企业用户申请入驻API中心服务商。 父主题: 服务商入驻
变更服务商信息 服务商入驻成功后,您如果想要修改服务商信息,可以参考本章指导操作。 前提条件 仅允许华为云账号修改服务商信息,不允许该账号下的IAM用户修改服务商信息。 操作步骤 进入API中心服务页面。 在左侧导航栏选择“服务商入驻”。 在服务商入驻页面,单击“变更服务商信息”
注册API到网关代理 使用场景 如果您想要将已开发好的API注册到API中心网关,请参考本章指导操作。 前提条件 已完成服务商入驻,具体操作指导参考《用户指南》服务商入驻章节。 使用流程 作为API提供者开放API,您需要先后完成以下流程: 步骤1:创建API分组 进入API中心服务页面。
如何获取API调用凭据? 如果是来源于华为云服务的API,您可通过token认证或AK/SK认证进行API的在线调测和调用。在线调测时,用户登录华为云账号后,API中心会为您自动获取Token或者自动生成临时AK/SK,帮助您直接进行在线调测;调用API时,可根据参数填写项的提示链接和指导文档,获取用户Token和AK/SK。
安全的API托管服务。 API数据分析:查看API网关代理中已发布的API被调用的情况,如被请求调用的次数,调用失败的次数等。 只允许华为云企业账号申请成为API中心服务商。 父主题: 服务商入驻
API服务商的联系方式。 单击API资产。 单击页面右上角的“订阅”。 只支持已登录用户订阅服务商的联系方式。 勾选“我已阅读并同意《华为云API中心用户协议》”。 单击“确定”,完成订阅。 订阅成功后,鼠标放在“联系咨询”上面,就会显示服务商的电话和邮箱。您可以通过已获取的联系方式联系服务商,获取API的调用方式。
错误码 用户调用API失败时,系统返回的错误码如下所示。 表1 错误码 HTTP状态码 错误码 错误描述 解决方案 404 APIC.0101 The API does not exist or has not been published in the environment.
RL地址。 根据表2参数信息配置资产基本信息。 表2 资产基本信息 参数名称 说明 资产名称 自定义API资产的名称。 说明: 同一个华为云账号下的API资产名称不能重复。 图标 为API资产设置一个图标。如果不设置,则显示默认图标。 资产简介 简单介绍下API资产的行业,用途等。