检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
填写的独立域名必须已备案,并且已解析,详情请参考《用户指南》域名管理章节中的“前提条件”。 步骤3:创建API 在左侧导航栏选择“API网关代理 > API列表”。 单击“创建API”。 配置前端定义。 图2 前端定义 表2 前端定义 参数 配置说明 API名称 系统默认自动生成一个
您开放的API。 独立域名不能重复。 前提条件 已有独立域名。可通过域名注册服务申请新的域名。 已备案独立域名,未备案的独立域名无法被访问。备案时长需几个工作日,建议您提前进行备案。 已将独立域名CNAME解析到分组的子域名上,具体方法请参见增加CNAME类型记录集。 如果API
企业对外开放API供外部伙伴/开发者调用集成 操作场景 企业期望将自身业务能力(如实时快递查询服务)通过API接口对外开放,供外部伙伴/开发者调用集成,构建更繁荣的业务系统生态,并且触达更广泛的业务范围。 准备工作 准备好API接口文档,推荐OpenAPI 2.0/3.0格式。
APIC.0303 Incorrect App authentication information. 检查请求的方法、路径、查询参数、请求体和签名使用的方法、路径、查询参数、请求体是否一致。 检查客户端机器时间是否正确。 403 APIC.0304 The app is not authorized
如果您需要在API中心门户网站搜索需要的API,用于系统集成和项目开发,请参考本章指导操作。 操作步骤 访问API中心门户网站。 搜索您需要的API。 您可以选择搜索栏搜索或按不同维度搜索API。 搜索栏搜索:输入您需要的API的一些关键信息,如API名称、描述等,系统会展示相关的搜索结果。 按不同维度搜索:
保证全局唯一。 如果没有特殊需求,不建议使用“自定义配置”,系统会默认生成全局标识,可在凭据详情中查看。 单击“确定”,创建凭据。 创建凭据成功后,在凭据管理页面显示新建凭据和凭据ID。 单击凭据名称,进入详情页面,查看Key和Secret。 绑定API 在“凭据管理”页面,单击凭据名称,进入详情页面。
商。单击服务商,可以看到该服务商拥有的所有API资产。 查看系统精选API 勾选“仅看精选”,界面会展示系统为您精选的API资产。 查看API 搜索到符合您要求的API后,单击API资产,查看API资产的开发文档,可以查看API的详细信息。 获取API的调用凭据 需要付费购买的A
获取资源集合的API建议支持分页。当资源数量较多时服务的查询API需要支持分页,避免一次查询获取的资源数量过多。 不支持分页查询,则服务应该要设置一个显示条数的默认值,避免一次返回过多资源。默认返回数量需要在接口参考中对外说明,避免调用者以为查询出了全量信息。查询条件中可以设定查询数量(limit),位移量(
API请求URI中如果存在特殊字符,需要进行转义编码 本条规则是MUST类型的基本规则,可保障API的高可用性。 某些字符,由于有特殊含义或者系统保留,容易被Web应用防火墙或者安全访问控制产品所阻断,导致URI调用不生效,因此不建议在URI中使用,如果必须要用需要用转义编码替换。 转义说明可参考:RFC
无需另外配置。 {Path}:请求路径,需替换为获取API的请求信息中获取的URL。 {Query}:查询参数,可选,格式为“参数名=参数取值”,例如limit=10,多个查询参数之间使用“&”隔开。需根据获取API的请求信息中获取的请求参数进行设置。 {Header}:请求头参数,格式为“参数名:
应用场景 API设计开发 当前面临的主要问题 缺少高效的生产作业平台。 多系统数据不互通、学习成本高、数据一致性困难、效率低、无法团队协作。 API中心解决方案 API中心从华为云或生态伙伴选型轻量化、具备便捷开发体验(高效协同、自动化等)的API工具,并对接集成引入到API中心的API工具库,供API开发者使用。
是:通过向系统提交工单,说明您的业务场景和诉求。 否:直接执行7。 如果入驻服务商时没有开通API网关代理功能,后续如果想要使用API网关代理,可以变更服务商信息,然后向系统提交工单,联系API中心运营人员开通此功能。 等待审核。5个工作日内完成审核。您可以登录API中心,查看审核进展。
示在API资产列表页。 后续操作 创建完API资产后,您还可以执行表3的操作。 表3 后续操作 操作 说明 查看API资产详情 在API资产列表页,单击API资产名称,查看API资产详情。 修改API资产信息 在API资产列表页,单击API资产所在行“操作”列的“编辑”,修改API资产信息。
概述 API中心是一个汇聚了海量的API的平台。通过汇聚丰富的行业能力API,帮助API开发者高效便捷的分享和开放API,支持应用开发者快速查找所需API并进行应用开发和集成。API中心覆盖了API生产、API开放、API消费全场景,一站式体验。 本文档为您提供生产API、开放AP
1和TLS1.2,推荐使用TLS1.2。 本章描述的“用户”指的都是华为云账号。 如果API网关代理当前的配额限制无法满足您的需求,您可以向系统提交工单申请更多配额。
(可选)配置默认后端的系统参数。如果后端服务需要接收系统运行时产生的参数信息,如网关内置参数,可以通过设置系统参数来实现。API网关代理向后端服务发送请求时,将系统参数添加到请求的指定位置,然后将请求发送给后端服务。 在“系统参数”下,单击“添加系统参数”,添加后端服务请求的系统参数。 表7
商的联系方式。如果您想要查看您在API中心门户网站中已经订阅的所有API,或对已经订阅的API单个或批量取消订阅,可以参考本章指导操作。 查看已经订阅的所有API:参考查看订阅的所有API。 对已经订阅的API单个或批量取消订阅:参考取消订阅API。 查看订阅的所有API 进入API中心服务页面。
方式三:创建API资产时,“导入方式”选择“API网关”,然后选择API分组内已发布的API上架。 查看API的监控指标 单击分组名称,在“API运行”页面左侧选择API,在“监控视图”区域,查看API的各项监控指标。包括“请求次数”、“调用延时”、“数据流量”和“出错统计”。 父主题:
企业服务能力包装成标准API服务,帮助您轻松构建、管理和部署任意规模的API。借助API网关代理,可以简单、快速、低成本、低风险地实现内部系统集成、业务能力开放及业务能力变现。API网关代理帮助您变现服务能力的同时,降低企业研发投入,让您专注于企业核心业务,提升运营效率。您需要先
服务端提供新版本API的同时,需要对老版本API提供支持。 例如:应用A更新API查询虚拟机列表,增加多个新的查询条件。在API发布之后,之前订阅该API的应用不能因为增加了新的查询条件而造成查询虚拟机列表失败。 API请求HTTP动词使用标准化且满足幂等性 本条规则是Shoul