检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API概览 API网关专享版接口的分类与说明如表1所示，API网关共享版接口的分类与说明如表2所示。 表1 专享版API概览 类型 说明 API分组管理 包括API分组的创建、修改、删除、查询详情和列表等接口。 环境管理 包括环境的创建、修改、删除和查询列表等接口。 环境变量管理
APIG的API错误码说明 当调用API时，可能遇到下表中的错误码。如果遇到“APIGW”开头的错误码，请参见API网关错误码进行处理。 通过APIG接口管理API，发生错误时，产生的错误码请参考错误码。 使用APIG错误码时，请以错误码（如APIG.0101）为准，错误信息并非固定不变
查询分组列表 功能介绍 查询API分组列表。 如果是租户操作，则查询该租户下所有的分组；如果是管理租户操作，则查询的是所有租户的分组。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw
约束与限制 实例 表1 实例约束与限制 限制项 约束与限制 用户权限 如果您使用系统角色相关权限，需要同时拥有“APIG Administrator”和“VPC Administrator”权限才能创建实例。 如果您使用系统策略，则拥有“APIG FullAccess”权限即可。
修改API分组 功能介绍 修改API分组属性。其中name和remark可修改，其他属性不可修改。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI PUT /v1/{project_id}/apigw/instances
APIG共享版迁移到专享版 应用场景 APIG共享版即将退市，为了避免影响用户的业务，需要将共享版上已有资源迁移到专享版上继续使用。 约束与限制 基于APIG共享版使用了云商店功能暂不支持迁移。 基于APIG共享版使用了跨用户授权功能暂不支持迁移。 基于APIG共享版使用了ELB通道类型的
域名解绑SSL证书 功能介绍 域名解绑SSL证书。目前暂时仅支持单个解绑，请求体当中的certificate_ids里面有且只能有一个证书ID。在使用自定义入方向端口的特性时，相同的域名会同时解绑证书。 调用方法 请参见如何调用API。 URI POST /v2/{project_id
快速开放并调用API 本章节将为您介绍如何快速使用API网关，这里以APP认证类型的简易认证为例，快速开放并调用API。简易认证仅支持HTTPS或GRPCS方式调用API。 图1 APIG使用流程 准备工作 在使用APIG之前，需要确保有可用的网络环境，请提前准备VPC、子网和安全组
添加API的SSL证书 如果API分组中的API支持HTTPS请求协议，则在绑定独立域名后，还需为独立域名添加SSL证书。SSL证书是进行数据传输加密和身份证明的证书，支持单向认证和双向认证两种认证方式。 如果不配置SSL证书，将无法保障请求的链路安全，请谨慎配置。 单向认证：客户端与服务端连接时
查询实例指定的自定义入方向端口绑定的域名信息 功能介绍 查询实例指定的自定义入方向端口绑定的域名信息。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/custom-ingress-ports
查看版本详情 功能介绍 查询某个指定的版本详情。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1/{project_id}/apigw/instances/{instance_id}/apis
云审计服务支持的APIG操作列表 开通云审计服务 如果您需要收集、记录或者查询API网关服务的操作日志，用于支撑安全分析、审计、问题定位等常见应用场景时，则需要先开通云审计服务。 云审计服务包含以下功能： 记录审计日志 审计日志查询 审计日志转储 事件文件加密 关键操作通知 查看关键操作列表
删除API分组 功能介绍 删除指定的API分组。 删除API分组前，要先下线并删除分组下的所有API。 删除时，会一并删除直接或间接关联到该分组下的所有资源，包括独立域名、SSL证书信息等等。并会将外部域名与子域名的绑定关系进行解除（取决于域名cname方式）。 调用方法 请参见如何调用
调试API 功能介绍 调试一个API在指定运行环境下的定义，接口调用者需要具有操作该API的权限。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI POST /v1.0/apigw/apis/debug/{
调试API 功能介绍 调试一个API在指定运行环境下的定义，接口调用者需要具有操作该API的权限。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI POST /v1/{project_id}/apigw/instances
导入导出API的限制与兼容性说明 在API网关中导入或者导出API时，限制与兼容性如下所示： 约束与限制 API网关参数限制，如下所示。 API网关暂不支持formData和body位置的请求参数定义。 API网关暂不支持consumes和produces定义。 API网关中，header
对象模型 本节介绍API分组的对象模型，如下表所示。 “操作类型”用于描述字段的属性，表示对应字段的值可进行的操作： C：创建；U：更新；R：读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作，对应字段是否为必选字段。 表1 分组对象模型 参数名称 数据类型 参数说明 操作类型
调试API 功能介绍 调试一个API在指定运行环境下的定义，接口调用者需要具有操作该API的权限。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/instances/{instance_id}/apis/debug/{api_id
修改插件 功能介绍 修改插件信息。 插件不允许重名 插件不支持修改类型和可见范围 调用方法 请参见如何调用API。 URI PUT /v2/{project_id}/apigw/instances/{instance_id}/plugins/{plugin_id} 表1 路径参数
使用APIG专享版实现WebSocket服务的转发 应用场景 API网关支持WebSocket API，其创建过程和创建HTTP API一致。WebSocket是一种全双工通信协议，建立在单个TCP连接上，允许在客户端和服务器之间进行双向通信。WebSocket的设计旨在解决HTTP
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
