检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
通过API设计文件导入API 将Swagger或OpenAPI定义的API导入到API网关,支持导入到新分组和导入到已有分组两种方式。导入前您需要在API定义中补全API网关的扩展定义。 注意事项 API网关中API分组和API的配额满足需求。 如果使用Swagger info或OpenAPI
可能原因2:参数错误,需要检查和修正。建议先在API网关控制台界面创建一个API,将其导出作为API文件的模板。 可能原因3:YAML文件格式问题,需要检查和修正。 可能原因4:本地proxy网络限制,更换网络环境。 可能原因5:定义API请求中,不允许在Header定义“X-Auth-Token”字段。
APIG的API设计文件扩展定义 x-apigateway-auth-type x-apigateway-request-type x-apigateway-match-mode x-apigateway-cors x-apigateway-is-send-fg-body-base64
接上,允许在客户端和服务器之间进行双向通信。WebSocket的设计旨在解决HTTP协议在实时性和交互性方面的不足。它广泛应用于实时聊天、在线游戏、金融行业的实时数据更新等场景。 约束与限制 WebSocket API不支持APIG控制台页面中的调试功能。 WebSocket A
未选择服务契约时,导入后会生成一个请求方法为ANY、请求路径为/且匹配模式为前缀匹配的API。 导入后会生成相应的API以及微服务类型的负载通道,负载通道会监测微服务下所有在线实例的地址变化,并更新到负载通道中。 前提条件 已创建CSE微服务引擎。 导入CSE微服务 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。
)名称相同时,会覆盖已有的策略(ACL,流控等)。 单击“导入参数”下方的“文件”,选择待导入的API文件。 支持yaml和json两种文件格式的API导入,界面可预览待导入API内容。 图2 导入参数 (可选)修改待导入API的全局配置。 您可以修改全局配置,如前后端的请求配置,也可以修改具体的接口配置。
签名密钥”,进入签名密钥管理信息页面。 单击“创建密钥”,弹出“创建密钥”对话框。 填写如表1所示信息。 表1 密钥信息 信息项 描述 密钥名称 自定义名称,用于识别不同的密钥。 类型 专享版支持选择签名密钥的认证类型,可选择“HMAC”和“Basic”。 Key 与“Secret”配合使用,表示签名密钥对。
表1 SSL证书配置 参数 配置说明 证书名称 填写SSL证书的名称,根据规划自定义。建议您按照一定的命名规则填写SSL证书名称,方便您快速识别和查找。 支持中文、英文、数字、英文格式的下划线,必须以英文或中文开头,长度为4~50个字符。 可见范围 当前实例:仅在当前实例下展示此证书。
API或GRPC API,并对外开放。 API创建成功后,您可根据业务需求配置API策略,管理API等。 调试APIG创建的API 通过APIG提供的在线调试功能验证API服务是否正常可用。 配置API的发布环境和环境变量(可选) API可以同时提供给不同的环境调用,如生产、测试或开发。RE
导入API到已有分组 功能介绍 导入swagger格式的文件, 在已有分组中创建或更新API。swagger文件支持json以及yaml格式。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 请求方法 URI PUT /v1.0/apigw/openapi?group_id={0}&mode={1}
导入API到已有分组 功能介绍 导入swagger格式的文件, 在已有分组中创建或更新API。swagger文件支持json以及yaml格式。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 请求方法 URI PUT /v1/{project_id}/apigw
击“确定”。 表1 克隆API配置 参数 说明 API名称 API名称,根据规划自定义。建议您按照一定的命名规则填写API名称,方便您快速识别和查找。 支持中文、英文、数字、中划线、下划线、点、斜杠、中英文格式下的小括号和冒号、中文格式下的顿号,且只能以英文、中文或数字开头,长度为3~255个字符。
单击“创建快速通道”,进入“新建VPC通道”页面,填写如表1所示信息。 图2 创建快速通道 表1 VPC通道配置 信息项 描述 通道名称 自定义VPC通道名称,用于识别不同的VPC通道。 端口 VPC通道中主机的端口号,即用户的后端业务端口号。 取值为1 ~ 65535。 成员类型 选择负载通道中的服务器
图1 基本信息 表1 基本信息 信息项 描述 API名称 API名称,根据规划自定义。建议您按照一定的命名规则填写API名称,方便您快速识别和查找。 所属分组 API所属分组。 如果尚未创建API分组,单击“新建分组”,为API新创建一个分组。 网关响应 网关响应指API网关未
修改API 功能介绍 修改指定API的信息,包括后端服务信息。 调用方法 请参见如何调用API。 URI PUT /v2/{project_id}/apigw/instances/{instance_id}/apis/{api_id} 表1 路径参数 参数 是否必选 参数类型 描述
展示连接到网关实例的终端节点信息。如果需要新建终端节点,请单击“创建终端节点”创建。 终端节点ID:终端节点的ID。 报文标识:终端节点ID的标识,用来识别是哪个终端节点。 状态:终端节点的状态。 关于终端节点的各个状态,请查看终端节点服务和终端节点有哪些状态?。 拥有者:终端节点创建者的账号ID。
配置凭据配额策略 参数 说明 策略名称 填写客户端配额策略的名称,根据业务规划自定义。建议您按照一定的命名规则填写配额策略名称,方便您快速识别和查找。 支持中文、英文、数字、下划线,且只能以英文或中文开头,长度为3~255个字符。 首次生效时间点 设置配额策略的生效起始时间点。例
信息。 表1 流量镜像参数说明 参数 说明 策略名称 填写策略的名称,根据业务规划自定义。建议您按照一定的命名规则填写策略名称,方便您快速识别和查找。 支持中文、英文、数字、下划线,且只能以英文或中文开头,长度为3~255个字符。 策略类型 固定为“流量镜像”。 描述 填写策略的描述信息。长度为1~255个字符。
单击“负载通道”页签,进入到负载通道列表页面。 单击“创建负载通道”,根据下表参数说明,配置基本信息。 表1 基本信息配置 参数 说明 通道名称 自定义负载通道名称,用于识别不同的负载通道。支持中文、英文、数字、下划线、中划线、点,且只能以英文和中文开头,长度为3~64个字符。 端口 负载通道中主机的端口号,即用户的后端业务端口号。
与函数工作流服务无缝对接,支持将函数工作流服务以API形式开放使用。 可视化API监控面板 帮助您监控API调用性能指标、数据延迟以及错误等信息,识别可能影响业务的潜在风险。 多层安全防护 API网关具备SSL传输、严格的访问控制、IP黑白名单控制、认证鉴权、防重放防攻击、多种审计等安全