检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
只允许授权的访问。 签名密钥:API网关代理提供签名密钥,用于后端服务校验API网关代理是否合法。 访问控制 流量控制:API网关代理支持从用户、IP、凭据和时间段等不同的维度限制对API的调用次数,保护后端服务。 访问控制:API网关代理支持通过设置IP地址或账户的黑白名单来禁
可维护性 保证API日志采集的实时性及完整性 本条规则是MUST类型的基本规则,可保障API的可维护性。 在采集API调用日志过程中,需要保证API日志的实时性和完整性,以提升API分析的精准度。 API日志在传递过程中,必须保证传递日志不会出现丢失。API日志总体丢失率小于0.5%。
看API的详细信息。 获取API的调用凭据 需要付费购买的API(来源于华为云市场的API),可按照页面引导和提示,完成API购买,然后在“买家中心>已购买的服务”中看到商品信息,单击“资源详情”可查看API调用凭据(AppKey/AppSecret)。 不需要付费购买的API(
后端服务地址:后端服务的地址。 路径:后端服务的路径。 后端超时 后端服务请求的超时时间。此处默认“5000”ms。 在“返回结果基础定义”页面,定义返回结果。 表5 定义返回结果 信息项 描述 成功响应示例 成功调用API时,返回的响应信息示例。 失败响应示例 调用API失败时,返回的响应信息示例。
简单请求的跨域访问 如果是创建新的API,在“安全配置”时,打开“支持跨域(CORS)”开关。详细的使用指导,可参考简单请求。 非简单请求的跨域访问 非简单请求的跨域访问需要在API的分组中创建一个“请求方法”为“OPTIONS”的API,作为预检请求。 预检请求API的参数设置
绑定华为IAM认证的API时,租户ID填写API调用者的账号ID。 绑定APP认证的API时,租户ID填写APP所属者的项目ID。 您可以单击控制台右上角的用户名,选择“我的凭证”,在我的凭证页面获取用户的项目ID和账号ID。 阈值 “时长”时间内,此租户访问单个API次数的最大值。 不能大于“API流量限制”值。
伙伴/开发者调用集成,构建更繁荣的业务系统生态,并且触达更广泛的业务范围。 准备工作 准备好API接口文档,推荐OpenAPI 2.0/3.0格式。 准备好API使用指南,说明API凭据获取方式、以及提供API使用时的补充说明信息。 API对应的后端服务已部署上线,并且推荐提供服
仅允许华为云账号修改服务商信息,不允许该账号下的IAM用户修改服务商信息。 操作步骤 进入API中心服务页面。 在左侧导航栏选择“服务商入驻”。 在服务商入驻页面,单击“变更服务商信息”,修改服务商信息,修改完成后,单击“立即提交”。 图1 变更服务商信息 在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的工具。通过这个页面的工具可以开发API,然后通过创建API资产,将开发好的API分享至API中心。 操作步骤 下面以API Arts工具为例,描述如何开发API并上架API至API中心门户网站。 进入API中心服务页面。 选择左侧导航栏中的“API工具库”。
选择待导出API所在的环境。 API 默认导出API分组所在环境的所有已发布的API,如果需要导出个别API,单击“自定义导出API”,勾选需要导出的API名称。 API定义范围 基础定义:只导出API前端定义。其中API前端定义除了Swagger规范定义项外,还包括API网关代理的一些Swagger扩展字段。
本条规则是Should类型的扩展规则,给API开发者提供灵活的弹性空间。 在API设计过程中,使用POST/PUT请求来避免个人数据被缓存、记录。 HTTP请求方法中,POST请求是向指定的资源提交要被处理的数据,其响应不会被缓存;PUT请求用来提交数据时,其响应是不能被缓存的。 父主题: API生产
生命周期管理:对API变更和下线等提出规范要求或建议,保障已订阅API租户的业务连续性。 包含Must类型的基本规则以及Should类型的扩展规则。Must规则牵引API开发者提供符合企业级标准、安全合规的API,Should规则在提供更全面指导的基础上,给予开发者灵活的弹性空间,方便开发者更快地加入API生态圈。
创建凭据并绑定API 使用APP认证的API,需要在API网关代理中创建一个凭据,以生成凭据ID和密钥对(Key、Secret)。将创建的凭据绑定API后,才可以使用APP认证调用API。 安全认证方式为“无认证”或“华为IAM认证”的API,无需创建凭据。 创建凭据 进入API中心服务页面。
Generic Syntax)。 API响应状态码应使用规范的HTTP状态码 本条规则是MUST类型的基本规则,可保障API的高可用性。 API响应所使用的状态码应使用规范的HTTP状态码,状态码所表达的状态与API响应状态保持一致。 具体的HTTP状态码使用可参考RFC 7231(Hypertext
sourceIp:API调用者的源地址。 stage:API调用的部署环境。 apiId:API的ID。 appId:API调用者的APP ID。 requestId:当次调用API所生成的请求ID。 serverAddr:网关服务器的地址 。 serverName:网关服务器的名称。 hand
API列表”。 在API所在行,单击“操作”列的“更多 > 授权”。 单击“添加授权”。 选择API授权环境,查询并勾选凭据后,单击“确定”。在“授权历史”弹窗中展示已授权的凭据。 如果已授权的凭据需要解除授权,在“授权历史”弹窗中,选择需解除授权的凭据,单击“操作”列“解除授权”。 父主题:
OpenAPI:支持导入符合OpenAPI 2.0/3.0标准的txt、yml、yaml、json格式的API文件。 API网关:支持将API网关代理中已发布的API,上架至API中心门户网站。 Postman Collection:支持将Postman Collection开发的API,上架至API中心门户网站。