检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
创建签名密钥 功能介绍 为了保护API的安全性，建议租户为API的访问提供一套保护机制，即租户开放的API，需要对请求来源进行认证，不符合认证的请求直接拒绝访问。 其中，签名密钥就是API安全保护机制的一种。 租户创建一个签名密钥，并将签名密钥与API进行绑定，则API网关在请求
请登录API网关控制台，参考《API网关用户指南》的“SDK”章节，进入SDK页面并下载SDK。 或直接下载JavaScript SDK的最新版本，并解压。在浏览器中打开demo.html，页面如下图所示。 填入Key、Secret、方法名、请求协议、域名和url。 1 2 3 4 5 6 //
创建API分组 功能介绍 API分组是API的管理单元，一个API分组等同于一个服务入口，创建API分组时，返回一个子域名作为访问入口。建议一个API分组下的API具有一定的相关性。 专享版API网关已经陆续开放V2版本的接口，请优先使用V2版本接口管理您的API。 URI HTTP/HTTPS请求方法以及URI如下表所示。
选择API的发布环境，并填写发布说明。 单击“确定”，API发布成功后，发布按钮左上角的红色感叹号消失。 验证 使用接口测试工具调用已创建的API，或者在客户端调用已创建的API。 填写API所属分组的调试域名。 导入服务端的proto文件。 此处的proto文件如下： syntax = "proto3";
为了让API响应结果为函数中返回的context中的字段（如果您使用的是专享版网关，并且实例支持authorizer_context_support_num_bool特性，那么context中的value的类型可以为boolean类型或number类型），需要修改网关响应模板。在API所在的分组中，“
ss##test#。 说明： IP地址/域名可以是公网IP（支持云服务器的弹性IP地址、用户自己服务器的公网IP地址、ELB地址）/公网域名，前提需要开启实例的公网出口。可以是内网的IP，不可以是内网域名。 2022年10月30日后创建的实例支持APIG与后端服务tls握手阶段向后端服务传SNI。
API不存在或未发布到环境 检查调用API所使用的域名、请求方法、路径和创建的API是否一致；检查API是否发布，如果发布到非生产环境，检查请求X-Stage头是否为发布的环境名；检查调用API使用的域名是否已经绑定到API所在的分组。 APIG.0101 The API does
on 绑定域名 ApiGroup AssociateDomain 绑定域名证书 ApiGroup AssociateCertificate 修改域名 ApiGroup UpdateDomain 解绑域名 ApiGroup DisassociateDomain 删除域名证书 ApiGroup
如果API开启了“支持CORS”功能的同时，也绑定了跨域资源共享策略，则以绑定的策略为准。 如果某个请求路径下有OPTIONS方法的API，则该请求路径下的所有API均不允许绑定跨域资源共享策略。 为策略绑定API时，API的请求方法必须为allow_methods中允许的请求方法。 一个API只能绑定一个相同类型的策略。
查看关键操作列表 通过云审计服务，您可以记录与API网关相关的操作事件，便于日后的查询、审计和回溯。 表1 云审计服务支持的API Gateway操作列表 操作名称 资源类型 事件名称 创建API分组 ApiGroup createApiGroup 删除API分组 ApiGroup
专享版-SSL证书管理 获取SSL证书列表 创建SSL证书 域名绑定SSL证书 域名解绑SSL证书 查看证书详情 删除SSL证书 修改SSL证书 SSL证书绑定域名 SSL证书解绑域名 获取SSL证书已绑定域名列表 父主题： 专享版API（V2）
包括APP授权、解除授权，查看APP已绑定/未绑定的API列表，查看API已绑定的APP列表。 概要查询 包括查询API概况、API分组概况、APP概况。 域名管理 包括域名的绑定、修改、解绑。域名证书的绑定、删除、查看。 ACL策略管理 包括ACL策略的创建、修改、删除、批量删除，查看ACL策略详情、查询ACL策略列表。
单击“下一步”，进入API的后端设置页面，修改已添加策略后端的策略条件值为“True”。 单击“完成”，完成API的编辑。 再次调试API。 由于此时设置的策略后端的参数和条件值没有匹配到前端自定义认证函数返回体中context字段下的任意键值对，因此，无法通过前端自定义认证参数匹配到API的策略后端，此时API的响应结果显示“200
API不存在或未发布到环境 检查调用API所使用的域名、请求方法、路径和创建的API是否一致；检查API是否发布，如果发布到非生产环境，检查请求X-Stage头是否为发布的环境名；检查调用API使用的域名是否已经绑定到API所在的分组 APIG.0101 The API does
共享版分组子域名更改为专享版实例的实例域名{instance-id}.apic.{region-id}.huaweicloudapis.com。 同VPC内使用独立域名从内网访问的场景 需要将原来的自定义域名的cname记录从共享版分组子域名更改为专享版实例的实例域名{instance-id}
Project”对话框，“Name”填写SDK压缩包内文件夹的名称，“Location”填写该文件夹的解压路径，“Language”选择“Go”，单击“Create”。 图2 Go 完成工程创建后，目录结构如下。 图3 新建工程go的目录结构 “demo.go”为示例代码，请根据实际情况
对外开放API时，您需要为API分组绑定自己的独立域名。 一个API只能属于某一个API分组。 API分组创建后，系统为分组自动分配一个内部测试用的调试域名，此调试域名每天最多可以访问1000次。您也可以通过关闭“调试域名开关”来关闭调试域名，关闭后将隐藏调试域名，且不能通过调试域名调用API。 实例创
左上角的感叹号消失表示发布成功，执行下一步。 调用API。 绑定独立域名。 在API分组详情页面单击“分组信息”页签。调试域名仅供开发测试时使用，且每天最多访问1000次，因此用户需要绑定独立域名来访问分组内的API。 单击“绑定独立域名”，绑定已注册好的公网域名。绑定域名具体操作请参见绑定域名章节。
用户指定 未指定则使用当前时间 host server.url API分组域名 未使用 优先使用API分组的第一个自定义域名 如果分组未绑定自定义域名则使用分组的独立域名 basePath - - 将与每条API的请求路径拼接起来使用 未填充 paths.path paths.path
广泛应用于实时聊天、在线游戏、金融行业的实时数据更新等场景。 约束与限制 WebSocket API不支持APIG控制台页面中的调试功能。 WebSocket API受API超时时间的限制，如果当前WebSocket连接空闲时间超过了配置的超时时间，并且没有ping/pong保活，则连接会被自动断开。
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
