检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
上架API至API中心门户网站 使用场景 如果您想要将已开发好的API上架至API中心门户网站,请参考本章指导操作。 前提条件 已完成服务商入驻,具体操作指导参考《用户指南》服务商入驻章节。 操作步骤 进入API中心服务页面。 选择左侧导航栏中的“API资产管理 > API资产”。
“条件来源”为“源地址”时,输入一个或多个IP地址,以英文逗号隔开。 定义返回结果。 在“返回结果基础定义”区域,填写返回信息。 表10 定义返回结果 信息项 描述 成功响应示例 成功调用API时,返回的响应信息示例。 失败响应示例 调用API失败时,返回的响应信息示例。 单击“完成”,进入“API运行”页面,可查看API详情。
后端超时 后端服务请求的超时时间。此处默认“5000”ms。 在“返回结果基础定义”页面,定义返回结果。 表5 定义返回结果 信息项 描述 成功响应示例 成功调用API时,返回的响应信息示例。 失败响应示例 调用API失败时,返回的响应信息示例。 单击“完成”,完成API的创建。 步骤4:调试API
错误码 用户调用API失败时,系统返回的错误码如下所示。 表1 错误码 HTTP状态码 错误码 错误描述 解决方案 404 APIC.0101 The API does not exist or has not been published in the environment.
API响应报文使用分页,避免超长列表数据返回 本条规则是Should类型的扩展规则,可提升API调用者的使用体验。 获取资源集合的API建议支持分页。当资源数量较多时服务的查询API需要支持分页,避免一次查询获取的资源数量过多。 不支持分页查询,则服务应该要设置一个显示条数的默认值,避免一次返回过多资源。默
面。 单击“调试”。 配置API请求参数后,单击“调试”。 在页面下方返回结果回显区域打印API调用的Response信息。 调用成功时,返回HTTP状态码为“200”和Response信息。 调试失败时,返回HTTP状态码为4xx或5xx,具体错误信息请参见错误码。 您可以通过
数值应大于等于99.99%。 服务API实际可用性与承诺的服务可用性需要100%吻合。当发现无法达到承诺的服务可用性时,API提供方从架构上考虑,通过增加可用区,增加多活部署等手段提升服务API的整体可用性。 API的TP99响应时长<3s 本条规则是MUST类型的基本规则,可保障API的高可用性。
所有合法请求,都会返回此参数 X-Apig-Latency 从API网关代理接收请求到后端返回消息头的用时 仅在请求消息头包含X-Apig-Mode: debug时,返回此参数 X-Apig-Upstream-Latency 从API网关代理请求后端到后端返回消息头的用时 仅在请求消息头包含X-Apig-Mode:
法。 Access-Control-Request-Headers:此字段可选,表示请求会额外发送的头信息字段。 后端服务返回消息:无。 API网关代理返回消息: HTTP/1.1 200 OK Date: Tue, 15 Jan 2019 02:38:48 GMT Content-Type:
含被替换资源的完整信息。如果传递的信息不完整,在服务实现端需提供对应信息的默认值。 是 DELETE 用于删除资源的场景。 是 HEAD 返回资源的元信息比如:ETag和Last-Modified之类的信息。 是 PATCH 用于部分更新资源的场景,如果使用PUT操作所需输入的整
环境变量 API网关代理提供环境变量功能,通过创建环境变量,实现在不同的环境定义不同的API调用路径。 环境变量是指在环境上创建可管理的一种变量,该变量固定在环境上。通过创建环境变量,实现同一个API,在不同环境中调用不同的后端服务。 当创建API时定义了变量标识,则需要在环境中添加
crt”证书文件直接重命名为“cert.pem”。 PFX 提取私钥命令,以“cert.pfx”转换为“key.pem”为例。 openssl pkcs12 -in cert.pfx -nocerts -out key.pem 提取证书命令,以“cert.pfx”转换为“cert.pem”为例。
一个API只能绑定一个相同类型的策略。 策略和API本身相互独立,只有为API绑定策略后,策略才对API生效。为API绑定策略时需指定发布环境,策略只对指定环境上的API生效。 策略的绑定、解绑、更新会实时生效,不需要重新发布API。 API的下线操作不影响策略的绑定关系,再次发布后仍然会带有下线前绑定的策略。
在方框中输入“我确认要取消入驻API中心服务商”(可单击右侧复制文字),单击“确定”。 图2 确认取消入驻 取消入驻成功后,系统提示“取消入驻成功”,并返回入驻API中心服务商界面。 父主题: 服务商
修订记录 发布日期 修订记录 2023-05-31 第七次正式发布。 优化如下章节: 上架API至API中心门户网站 2023-03-31 第六次正式发布。 优化如下章节: 上架API至API中心门户网站 消费API 2023-03-22 第五次正式发布。 优化如下章节: 生产API
将分组内已发布的API上架至门户网站 任选以下三种方式之一操作,即可上架分组内已发布的API至API中心门户网站。 方式一:在分组所在行“操作”列,单击“更多>上架”,跳转至“创建API资产”页面。 方式二:单击分组名称,在“API运行”页面,单击右上角的“上架”,跳转至“创建API资产”页面。
API设计与文档实时同步,设计即文档。 API测试与设计同源,设计示例一键导入测试步骤。 API开放简单体验 一键上架:API生产工具中的API资产可以一键上架到API门户,实现开放分享。 API消费快速匹配 支持智能搜索和推荐,缩短应用开发者和API资产的触达路径,帮助应用开发者快速找到所需API。
参数名称 说明 导入方式 支持以下6种方式,上架API文件至API中心门户网站: OpenAPI:支持导入符合OpenAPI 2.0/3.0标准的txt、yml、yaml、json格式的API文件。 API网关:支持将API网关代理中已发布的API,上架至API中心门户网站。 Postman
参数名称 说明 导入方式 支持以下6种方式,上架API文件至API中心门户网站: OpenAPI:支持导入符合OpenAPI 2.0/3.0标准的txt、yml、yaml、json格式的API文件。 API网关:支持将API网关代理中已发布的API,上架至API中心门户网站。 Postman
试后,可以将API注册在华为云生态网关,然后在华为云云商店上架API商品并定价售卖,实现直接售卖API并获得商业收益。 间接变现:API能力开放给应用开发者,供其在应用开发和集成中调用。应用生产出来后,可在华为云云商店上架SaaS等应用类型商品,实现API的间接变现,获得商业收益。