检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
使用APIG专享版实现WebSocket服务的转发 应用场景 API网关支持WebSocket API，其创建过程和创建HTTP API一致。WebSocket是一种全双工通信协议，建立在单个TCP连接上，允许在客户端和服务器之间进行双向通信。WebSocket的设计旨在解决HT
绑定签名密钥 功能介绍 签名密钥创建后，需要绑定到API才能生效。将签名密钥绑定到API后，则API网关请求后端服务时就会使用这个签名密钥进行加密签名，后端服务可以校验这个签名来验证请求来源。 将指定的签名密钥绑定到一个或多个已发布的API上。 同一个API发布到不同的环境可以绑
快速开放并调用API 本章节将为您介绍如何快速使用API网关，这里以APP认证类型的简易认证为例，快速开放并调用API。 图1 APIG使用流程 准备工作 在使用APIG之前，需要确保有可用的网络环境，请提前准备VPC、子网和安全组。 创建实例 创建实例时，根据实际需求选择实例的
调试API 功能介绍 调试一个API在指定运行环境下的定义，接口调用者需要具有操作该API的权限。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/instances/{instance_id}/apis/debug/{api_id}
导入微服务 功能介绍 导入微服务。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/instances/{instance_id}/microservice/import 表1 路径参数 参数 是否必选 参数类型 描述 project_id
更新VPC通道 功能介绍 更新指定VPC通道的参数 使用传入的后端实例列表对VPC通道进行全量覆盖，如果后端实例列表为空，则会全量删除已有的后端实例； 使用传入的后端服务器组列表对VPC通道进行全量覆盖，如果后端服务器组列表为空，则会全量删除已有的服务器组； 调用方法 请参见如何调用API。
创建VPC通道 功能介绍 在API网关中创建连接私有VPC资源的通道，并在创建API时将后端节点配置为使用这些VPC通道，以便API网关直接访问私有VPC资源。 每个用户最多创建30个VPC通道。 调用方法 请参见如何调用API。 URI POST /v2/{project_id
创建签名密钥 功能介绍 为了保护API的安全性，建议租户为API的访问提供一套保护机制，即租户开放的API，需要对请求来源进行认证，不符合认证的请求直接拒绝访问。 其中，签名密钥就是API安全保护机制的一种。 租户创建一个签名密钥，并将签名密钥与API进行绑定，则API网关在请求
绑定签名密钥 功能介绍 签名密钥创建后，需要绑定到API才能生效。将签名密钥绑定到API后，则API网关请求后端服务时就会使用这个签名密钥进行加密签名，后端服务可以校验这个签名来验证请求来源。 将指定的签名密钥绑定到一个或多个已发布的API上。 同一个API发布到不同的环境可以绑
发布API 操作场景 创建完成的API，支持发布到不同的环境。API只有在发布到环境后，才支持被调用。API网关支持查看API发布历史（如版本、发布说明、发布时间和发布环境），并支持回滚到不同的API历史版本。 已发布的API，在修改信息后，需要重新发布才能将修改后的信息同步到环境中。
配置API的前端自定义认证 如果您需要把自己的认证系统用于API调用的认证鉴权，可以使用自定义认证来实现。 自定义认证包括前端和后端两种类型： 前端自定义认证：指APIG使用自定义的认证函数，对收到的API请求进行安全认证。 后端自定义认证：指API的后端服务使用自定义的认证函数
查看VPC通道详情 功能介绍 查看指定的VPC通道详情 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/vpc-channels/{vpc_channel_id} 表1 路径参数 参数
绑定签名密钥 功能介绍 签名密钥创建后，需要绑定到API才能生效。 将签名密钥绑定到API后，则API网关请求后端服务时就会使用这个签名密钥进行加密签名，后端服务可以校验这个签名来验证请求来源。 将指定的签名密钥绑定到一个或多个已发布的API上。同一个API发布到不同的环境可以绑
修订记录 表1 文档修订记录 发布日期 修订记录 2024-06-26 新增编排规则管理接口。 新增实例自定义入方向端口管理接口。 2024-01-19 新增查询实例支持的特性列表接口。 新增设置调试域名是否可以访问接口。 新增异步任务管理接口。 2023-09-12 增加修改变量接口。
发布APIG创建的API 创建完成的API，支持发布到不同的环境。API只有在发布到环境后，才支持被调用。API网关支持查看API发布历史（如版本、发布说明、发布时间和发布环境），并支持回滚到不同的API历史版本。 已发布的API，在修改信息后，需要重新发布才能将修改后的信息同步到环境中。
创建API分组 功能介绍 API分组是API的管理单元，一个API分组等同于一个服务入口，创建API分组时，返回一个子域名作为访问入口。建议一个API分组下的API具有一定的相关性。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI
创建API分组 功能介绍 API分组是API的管理单元，一个API分组等同于一个服务入口，创建API分组时，返回一个子域名作为访问入口。建议一个API分组下的API具有一定的相关性。 专享版API网关已经陆续开放V2版本的接口，请优先使用V2版本接口管理您的API。 URI HT
配置API的自定义认证 自定义认证包含两种认证：前端自定义认证和后端自定义认证。 前端自定义认证：如果您希望使用自己的认证系统，而不是APP认证/华为IAM认证对API的访问进行认证鉴权时，您可以使用自定义认证，通过您自定义的函数进行认证鉴权。 后端自定义认证：当不同的后端服务使
创建VPC通道 操作场景 VPC通道主要用于将部署在VPC内的服务通过API网关开放给外部访问，它的优势在于使用VPC的内部子网通信，网络时延更低，同时VPC通道具有负载均衡功能，从而实现后端服务的负载均衡。 创建VPC通道后，在创建API，且后端服务类型为HTTP/HTTPS时
通过CCE工作负载导入API API网关支持导入云容器引擎（Cloud Container Engine，简称CCE）工作负载，提供API注册开放CCE服务能力。 如果当前实例不支持“导入CCE工作负载”，请联系客服。 注意事项 仅支持华为云CCE Turbo集群、VPC网络模型的CCE集群。
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
