检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
通过CSE微服务导入API API网关支持导入微服务引擎(Cloud Service Engine,简称CSE)的微服务,提供API注册开放CSE服务能力。 如果当前实例不支持“导入CSE微服务”,请联系客服。 目前仅广州友好、贵阳一、上海一、广州、北京四区域支持导入CSE服务。
通过APIG创建GRPC API API网关支持创建GRPC API。gRPC是RPC(远程过程调用)的一种,只需定义每个API的Request和Response,剩下的gRPC框架就可以完成。它的典型特征就是使用protobuf(protocol buffers)作为其接口定义语言(Interface
通过APIG创建REST API API提供者把API接口配置在API网关中,开放后端能力。创建REST API分以下步骤: 前端配置 支持配置前端定义、安全配置和请求参数。 后端配置 支持配置默认后端、策略后端和返回结果。 (可选)为API添加策略 支持配置传统策略和插件策略。
ult以外的最后一个编排规则; 每个API仅允许选择一个参数绑定编排规则,且编排规则不能重复,支持绑定的编排规则数量有配额限制,具体请参见产品介绍的“约束与限制”章节。 id String 参数编号 状态码: 400 表13 响应Body参数 参数 参数类型 描述 error_code
实施步骤 前提条件 客户端与服务端均为gRPC类型。 服务端已定义proto文件,即在proto文件中定义API的Request和Response。proto文件是用于定义数据结构和服务接口的文件,通常在gRPC中使用。它基于Protobuf语言,用于描述数据的结构和交互方式,充当客户端和服务端之间通信的合同。
创建API分组 创建API前,需要先创建API分组。API分组相当于API的集合,API提供者以API分组为单位,管理分组内的所有API。 目前支持以下创建分组方式: 直接创建 创建一个简单的分组,不包含API,用户可自行创建API。 通过API设计文件导入API 从本地导入已有的API文件,同步创建分组。
添加或更新VPC通道后端服务器组 功能介绍 在APIG中创建VPC通道后端服务器组,VPC通道后端实例可以选择是否关联后端实例服务器组,以便管理后端服务器节点。 如果指定名称的后端服务器组已存在,则更新对应后端服务器组信息。如果请求体中包含多个重复名称的后端服务器定义,则使用第一个定义。
添加或更新后端实例 功能介绍 为指定的VPC通道添加后端实例 如果指定地址的后端实例已存在,则更新对应后端实例信息。如果请求体中包含多个重复地址的后端实例定义,则使用第一个定义。 引用负载通道类型的负载通道不支持添加或更新后端实例。 调用方法 请参见如何调用API。 URI POST
更新后端实例 功能介绍 更新指定的VPC通道的后端实例。更新时,使用传入的请求参数对对应云服务组的后端实例进行全量覆盖修改。如果未指定修改的云服务器组,则进行全量覆盖。 引用负载通道类型的负载通道不支持更新后端实例。 调用方法 请参见如何调用API。 URI PUT /v2/{p
查看VPC通道后端服务器组详情 功能介绍 查看指定的VPC通道后端服务器组详情 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/vpc-channels/{vpc_channel_id
ult以外的最后一个编排规则; 每个API仅允许选择一个参数绑定编排规则,且编排规则不能重复,支持绑定的编排规则数量有配额限制,具体请参见产品介绍的“约束与限制”章节。 表8 ApiPolicyMockCreate 参数 是否必选 参数类型 描述 result_content 否
APIG支持的监控指标 功能说明 本节定义了API网关服务上报云监控服务的监控指标的命名空间,监控指标列表和维度定义,用户可以通过云监控服务提供管理控制台或API接口来检索API网关服务产生的监控指标和告警信息。 命名空间 SYS.APIC 监控指标 表1 监控指标说明 指标ID
查看分组详情 功能介绍 查询指定分组的详细信息。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1/{project_id}/apigw/instances/{instance_id}/api-groups/{id}
查看分组详情 功能介绍 查询指定分组的详细信息。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/api-groups/{id} URI中的参数说明如下表所示。 表2 参数说明
查询VPC通道后端云服务组列表 功能介绍 查询VPC通道后端云服务组列表 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/vpc-channels/{vpc_channel_id}/member-groups
APIG的API错误码说明 当调用API时,可能遇到下表中的错误码。如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。 通过APIG接口管理API,发生错误时,产生的错误码请参考错误码。 使用APIG错误码时,请以错误码(如APIG.0101)为准,错误信息并非
修改API分组 功能介绍 修改API分组属性。其中name和remark可修改,其他属性不可修改。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI PUT /v1/{project_id}/apigw/i
配置API的断路器 断路器是API网关在后端服务出现性能问题时保护系统的内置机制。当API的后端服务出现连续N次超时或者时延较高的情况下,会触发断路器的降级机制,向API调用方返回固定错误或者将请求转发到指定的降级后端。当后端服务恢复正常后,断路器关闭,请求恢复正常。 如果此策略
APIG最佳实践汇总 本文汇总了基于API网关服务(APIG,APIGateway)常见应用场景的操作实践,为每个实践提供详细的方案描述和操作指导,帮助用户轻松构建基于APIG的业务。 表1 APIG最佳实践一览表 最佳实践 说明 使用APIG专享版开放云容器引擎CCE工作负载 云容器引擎(Cloud
创建API分组 功能介绍 API分组是API的管理单元,一个API分组等同于一个服务入口,创建API分组时,返回一个子域名作为访问入口。建议一个API分组下的API具有一定的相关性。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI