{"version":"1.0.22","data":{"0":{"ops":[{"insert":"API 网关使用 Key Auth 插件实现了基于 API Key 的认证鉴权，本文介绍如何为 API 网关配置 API Key 认证。\n"},{"attributes":{"lmkr":"1","heading":"h2","anchor":"#注意事项"},"insert":"*"},{"insert":"注意事项\n"},{"attributes":{"lmkr":"1","list":"bullet1","start":"1","origin-start":"1"},"insert":"*"},{"insert":"Key Auth 插件支持在服务、路由级别的资源中开启和关闭，插件配置的生效优先级为路由 > 服务。\n"},{"attributes":{"lmkr":"1","list":"bullet1","start":"1","origin-start":"1"},"insert":"*"},{"insert":"Key Auth 开启后，只有使用合法消费者认证信息的访问，才通过认证鉴权。\n"},{"attributes":{"lmkr":"1","list":"bullet1","start":"1","origin-start":"1"},"insert":"*"},{"insert":"Key Auth 在消费者中生成，一个消费者最多支持 5 个 API Key。\n"},{"attributes":{"lmkr":"1","heading":"h2","anchor":"#前提条件"},"insert":"*"},{"insert":"前提条件\n"},{"attributes":{"lmkr":"1","list":"bullet1","start":"1","origin-start":"1"},"insert":"*"},{"insert":"已创建网关实例。详情请参见 "},{"attributes":{"hyperlink":"{\"href\":\"https://www.volcengine.com/docs/6569/85693\",\"linkId\":\"bRiyyNQEqf\",\"newTab\":true}"},"insert":"创建实例"},{"insert":"。\n"},{"attributes":{"lmkr":"1","list":"bullet1","start":"1","origin-start":"1"},"insert":"*"},{"insert":"已创建服务，具体操作可参见 "},{"attributes":{"hyperlink":"{\"href\":\"https://www.volcengine.com/docs/6569/85695#%E5%88%9B%E5%BB%BA%E6%9C%8D%E5%8A%A1\",\"linkId\":\"RvLo4P3WjS\",\"newTab\":true}"},"insert":"创建服务"},{"insert":"。\n"},{"attributes":{"lmkr":"1","list":"bullet1","start":"1","origin-start":"1"},"insert":"*"},{"insert":"已创建 Upstream，本文以容器服务类型为例，详情请参见 "},{"attributes":{"hyperlink":"{\"href\":\"https://www.volcengine.com/docs/6569/129949\",\"linkId\":\"0xSeQxNPop\",\"target\":\"_blank\"}","backgroundcolor":"rgb(255, 255, 255)"},"insert":"创建容器服务类型 Upstream"},{"attributes":{"backgroundcolor":"rgb(255, 255, 255)"},"insert":"。"},{"insert":"\n"},{"attributes":{"lmkr":"1","list":"bullet1","start":"1","origin-start":"1"},"insert":"*"},{"insert":"已创建路由。详情请参见 "},{"attributes":{"hyperlink":"{\"href\":\"https://www.volcengine.com/docs/6569/179038\",\"linkId\":\"qp2Q91s5TB\",\"newTab\":true}"},"insert":"创建路由"},{"insert":"。\n"},{"attributes":{"lmkr":"1","heading":"h2","anchor":"#操作步骤"},"insert":"*"},{"insert":"操作步骤\n"},{"attributes":{"anchor":"#2mUJrRxr","heading":"h3","lmkr":"1"},"insert":"*"},{"insert":"步骤一：创建消费者\n"},{"attributes":{"ol-id":"SoQPILLo","lmkr":"1","list":"number1","start":"1","origin-start":"1"},"insert":"*"},{"insert":"登录 "},{"attributes":{"hyperlink":"{\"href\":\"https://console.volcengine.com/veapig\",\"linkId\":\"R5z4b5Zx4I\",\"newTab\":true}"},"insert":"API 网关控制台"},{"insert":"。\n"},{"attributes":{"ol-id":"SoQPILLo","lmkr":"1","list":"number1","start":"2","origin-start":"2"},"insert":"*"},{"insert":"在顶部导航栏，选择目标地域。\n"},{"attributes":{"ol-id":"SoQPILLo","lmkr":"1","list":"number1","start":"3","origin-start":"3"},"insert":"*"},{"insert":"在左侧导航栏选择 "},{"attributes":{"bold":"true"},"insert":"消费者管理 > 消费者列表"},{"insert":"，单击 "},{"attributes":{"bold":"true"},"insert":"创建消费者"},{"insert":"。\n"},{"attributes":{"lmkr":"1","list":"indent1"},"insert":"*"},{"attributes":{"image":"true","uuid":"4KezBOFgyzCMfTrybTAg","src":"https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_13cf23c018df1e052fd231ebf0a19cf7.png","width":"590"},"insert":" "},{"insert":"\n"},{"attributes":{"start":"4","ol-id":"SoQPILLo","lmkr":"1","list":"number1"},"insert":"*"},{"insert":"单击 "},{"attributes":{"bold":"true"},"insert":"确定"},{"insert":"，完成配置。\n"},{"attributes":{"heading":"h3","anchor":"#KqRccmHu","lmkr":"1"},"insert":"*"},{"insert":"步骤二：生成 API Key\n"},{"attributes":{"ol-id":"I3vyYwZq","start":"1","list":"number1","origin-start":"1","lmkr":"1"},"insert":"*"},{"insert":"在左侧导航栏选择 "},{"attributes":{"bold":"true"},"insert":"消费者管理 > 消费者列表"},{"insert":"。\n"},{"attributes":{"start":"2","ol-id":"I3vyYwZq","lmkr":"1","list":"number1"},"insert":"*"},{"insert":"在消费者列表中，单击目标消费者名称，进入消费者详情页面。\n"},{"attributes":{"start":"3","ol-id":"I3vyYwZq","lmkr":"1","list":"number1"},"insert":"*"},{"insert":"在认证信息区域，单击 "},{"attributes":{"bold":"true"},"insert":"生成 API Key"},{"insert":"。\n"},{"attributes":{"lmkr":"1","list":"indent1","text-indent":"true"},"insert":"*"},{"attributes":{"image":"true","uuid":"fsadJR4k","src":"https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_f2dba0f9619e5379dc52d02ee9afa5c7.png","width":"921"},"insert":" "},{"insert":"\n"},{"attributes":{"ol-id":"I3vyYwZq","start":"4","list":"number1","lmkr":"1"},"insert":"*"},{"insert":"在弹出的对话框内容选择 "},{"attributes":{"bold":"true"},"insert":"自动创建"},{"insert":" API Key 认证信息。\n"},{"attributes":{"lmkr":"1","list":"indent1"},"insert":"*"},{"attributes":{"image":"true","uuid":"ePgMVoNQ","src":"https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_66537ea0cde7c7021add9a2209eddaf6.png","width":"923"},"insert":" "},{"insert":"\n"},{"attributes":{"ol-id":"I3vyYwZq","start":"5","list":"number1","lmkr":"1"},"insert":"*"},{"insert":"单击 "},{"attributes":{"bold":"true"},"insert":"确定"},{"insert":"，生成 API Key 认证信息。\n"},{"attributes":{"lmkr":"1","list":"indent1","text-indent":"true"},"insert":"*"},{"attributes":{"image":"true","uuid":"mEiLDKLf","src":"https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_db83ed32f3a637b3f2c3fad93bd7027b.png","width":"920"},"insert":" "},{"insert":"\n"},{"attributes":{"anchor":"#B5mOdJbI","heading":"h3","lmkr":"1"},"insert":"*"},{"insert":"步骤三：启用 Key Auth 插件\n"},{"attributes":{"ol-id":"OZs2QVF1","lmkr":"1","list":"number1","start":"1","origin-start":"1"},"insert":"*"},{"insert":"登录 "},{"attributes":{"hyperlink":"{\"href\":\"https://console.volcengine.com/veapig\",\"linkId\":\"tX5sGrSaNe\",\"newTab\":true}"},"insert":"API 网关控制台"},{"insert":"。\n"},{"attributes":{"ol-id":"OZs2QVF1","lmkr":"1","list":"number1","start":"2","origin-start":"2"},"insert":"*"},{"insert":"在左侧导航栏选择 "},{"attributes":{"bold":"true"},"insert":"插件管理 > Key Auth插件"},{"insert":"，单击 "},{"attributes":{"bold":"true"},"insert":"创建插件"},{"insert":"，配置插件参数。\n"},{"attributes":{"list":"bullet2","lmkr":"1"},"insert":"*"},{"attributes":{"bold":"true"},"insert":"生效级别"},{"insert":"：选择 "},{"attributes":{"bold":"true"},"insert":"路由级别"},{"insert":"，并配置插件所属实例、服务和路由。\n"},{"attributes":{"lmkr":"1","list":"bullet2"},"insert":"*"},{"attributes":{"bold":"true"},"insert":"认证配置"},{"insert":"：选择 "},{"attributes":{"bold":"true"},"insert":"header"},{"insert":"，并配置来源为 "},{"attributes":{"bold":"true"},"insert":"Authorization"},{"insert":"，表示在请求头中的 Authorization 附带 API Key 认证信息。\n"},{"attributes":{"lmkr":"1","list":"bullet2"},"insert":"*"},{"attributes":{"bold":"true"},"insert":"消费者"},{"insert":"：选择步骤一种创建的消费者。\n"},{"attributes":{"lmkr":"1","list":"bullet2"},"insert":"*"},{"insert":"其他配置保持缺省。\n"},{"attributes":{"lmkr":"1","list":"indent1","text-indent":"true"},"insert":"*"},{"attributes":{"image":"true","uuid":"b5P5f1x42XlOav3LYFOk","src":"https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_c29fe41a64ea1bc935f2014edc833e95.png","width":"856"},"insert":" "},{"insert":"\n"},{"attributes":{"ol-id":"OZs2QVF1","start":"3","list":"number1","lmkr":"1"},"insert":"*"},{"insert":"单击 "},{"attributes":{"bold":"true"},"insert":"确定"},{"insert":"，完成配置。\n"},{"attributes":{"anchor":"#K4r390HF","heading":"h2","lmkr":"1"},"insert":"*"},{"insert":"结果验证\n"},{"attributes":{"anchor":"#1GcktZ5b","heading":"h3","lmkr":"1"},"insert":"*"},{"insert":"查看配置\n"},{"attributes":{"lmkr":"1"},"insert":"*"},{"insert":"配置完成后，在插件列表中，选择 "},{"attributes":{"bold":"true"},"insert":"路由级别"},{"insert":" 页签，查看已配置的 Key Auth 插件，若插件状态为 "},{"attributes":{"bold":"true"},"insert":"已启用"},{"insert":"，表示插件生效。\n"},{"attributes":{"lmkr":"1"},"insert":"*"},{"attributes":{"image":"true","uuid":"3D1fMXLeY3ID3pictt6q","src":"https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_a1931f834ebe790d98461c363c7faa63.png","width":"888"},"insert":" "},{"insert":"\n"},{"attributes":{"anchor":"#fuh0XulP","heading":"h3","lmkr":"1"},"insert":"*"},{"insert":"认证测试\n"},{"attributes":{"lmkr":"1"},"insert":"*"},{"insert":"在 API 网关实例中开启 Key Auth 插件，并使用消费者生成 API Key 认证信息后。仅携带该认证信息的访问请求，能够通过 API 网关访问到后端 Upstream。\n"},{"attributes":{"start":"1","list":"number1","ol-id":"VzH7lUWY","origin-start":"1","lmkr":"1"},"insert":"*"},{"insert":"使用 API 网关实例中配置的域名访问服务，当未携带 API Key 认证信息时。\n"},{"attributes":{"type":"codeblock","zoneId":"6dihgttzm5","language":"Bash"},"insert":" "},{"insert":"\n"},{"insert":"预期结果如下，表示认证失败，无法通过 API 网关访问到后端的服务。\n"},{"attributes":{"language":"Bash","type":"codeblock","zoneId":"zweqpyiwh0"},"insert":" "},{"insert":"\n"},{"attributes":{"ol-id":"VzH7lUWY","start":"2","list":"number1","lmkr":"1"},"insert":"*"},{"insert":"使用 API 网关实例中配置的域名访问服务，当携带 API Key 认证信息时。\n"},{"attributes":{"type":"codeblock","zoneId":"9zk8r05pwv","language":"Bash"},"insert":" "},{"insert":"\n"},{"insert":"预期结果如下，表示能够通过 API 网关访问到后端的服务。\n"},{"attributes":{"type":"codeblock","zoneId":"mbcjwxevgd","language":"HTML"},"insert":" "},{"insert":"\n"}],"zoneId":"0","zoneType":"Z"},"6dihgttzm5":{"ops":[{"insert":"curl -H "},{"insert":"\"Host: apig-example.com\"","attributes":{"clientside-highlight":"code-hljs-string"}},{"insert":" http://14.xxx.xxx.xxx\n"}],"zoneId":"6dihgttzm5","zoneType":"Z"},"zweqpyiwh0":{"ops":[{"insert":"Consumer authentication failed.\n"}],"zoneId":"zweqpyiwh0","zoneType":"Z"},"9zk8r05pwv":{"ops":[{"insert":"curl -H "},{"attributes":{"clientside-highlight":"code-hljs-string"},"insert":"\"Host: apig-example.com\""},{"insert":" http://14.xxx.xxx.xxx -H "},{"insert":"\"Authorization: Bearer e8cc8b4f-***\"","attributes":{"clientside-highlight":"code-hljs-string"}},{"insert":"\n"}],"zoneId":"9zk8r05pwv","zoneType":"Z"},"mbcjwxevgd":{"ops":[{"attributes":{"clientside-highlight":"code-hljs-meta"},"insert":"","attributes":{"clientside-highlight":"code-hljs-meta"}},{"insert":"\n"},{"attributes":{"clientside-highlight":"code-hljs-tag"},"insert":"<"},{"attributes":{"clientside-highlight":"code-hljs-name"},"insert":"html"},{"insert":">","attributes":{"clientside-highlight":"code-hljs-tag"}},{"insert":"\n"},{"attributes":{"clientside-highlight":"code-hljs-tag"},"insert":"<"},{"attributes":{"clientside-highlight":"code-hljs-name"},"insert":"head"},{"insert":">","attributes":{"clientside-highlight":"code-hljs-tag"}},{"insert":"\n"},{"attributes":{"clientside-highlight":"code-hljs-tag"},"insert":"<"},{"attributes":{"clientside-highlight":"code-hljs-name"},"insert":"title"},{"attributes":{"clientside-highlight":"code-hljs-tag"},"insert":">"},{"insert":"Welcome to nginx!"},{"attributes":{"clientside-highlight":"code-hljs-tag"},"insert":"","attributes":{"clientside-highlight":"code-hljs-tag"}},{"insert":"\n"},{"attributes":{"clientside-highlight":"code-hljs-tag"},"insert":"<"},{"attributes":{"clientside-highlight":"code-hljs-name"},"insert":"style"},{"attributes":{"clientside-highlight":"code-hljs-tag"},"insert":">"},{"insert":"\n","attributes":{"clientside-highlight":"css"}},{"attributes":{"clientside-highlight":"code-hljs-selector-tag"},"insert":"html"},{"attributes":{"clientside-highlight":"css"},"insert":" { "},{"attributes":{"clientside-highlight":"code-hljs-attribute"},"insert":"color"},{"insert":"-scheme: light dark; }\n","attributes":{"clientside-highlight":"css"}},{"attributes":{"clientside-highlight":"code-hljs-selector-tag"},"insert":"body"},{"attributes":{"clientside-highlight":"css"},"insert":" { "},{"attributes":{"clientside-highlight":"code-hljs-attribute"},"insert":"width"},{"attributes":{"clientside-highlight":"css"},"insert":": "},{"attributes":{"clientside-highlight":"code-hljs-number"},"insert":"35em"},{"attributes":{"clientside-highlight":"css"},"insert":"; "},{"attributes":{"clientside-highlight":"code-hljs-attribute"},"insert":"margin"},{"attributes":{"clientside-highlight":"css"},"insert":": "},{"attributes":{"clientside-highlight":"code-hljs-number"},"insert":"0"},{"insert":" auto;\n","attributes":{"clientside-highlight":"css"}},{"attributes":{"clientside-highlight":"code-hljs-attribute"},"insert":"font-family"},{"insert":": Tahoma, Verdana, Arial, sans-serif; }\n","attributes":{"clientside-highlight":"css"}},{"attributes":{"clientside-highlight":"code-hljs-tag"},"insert":"","attributes":{"clientside-highlight":"code-hljs-tag"}},{"insert":"\n"},{"attributes":{"clientside-highlight":"code-hljs-tag"},"insert":"","attributes":{"clientside-highlight":"code-hljs-tag"}},{"insert":"\n"},{"attributes":{"clientside-highlight":"code-hljs-tag"},"insert":"<"},{"attributes":{"clientside-highlight":"code-hljs-name"},"insert":"body"},{"insert":">","attributes":{"clientside-highlight":"code-hljs-tag"}},{"insert":"\n"},{"attributes":{"clientside-highlight":"code-hljs-tag"},"insert":"<"},{"attributes":{"clientside-highlight":"code-hljs-name"},"insert":"h1"},{"attributes":{"clientside-highlight":"code-hljs-tag"},"insert":">"},{"insert":"Welcome to nginx!"},{"attributes":{"clientside-highlight":"code-hljs-tag"},"insert":"","attributes":{"clientside-highlight":"code-hljs-tag"}},{"insert":"\n"},{"attributes":{"clientside-highlight":"code-hljs-tag"},"insert":"<"},{"attributes":{"clientside-highlight":"code-hljs-name"},"insert":"p"},{"insert":">","attributes":{"clientside-highlight":"code-hljs-tag"}},{"insert":"If you see this page, the nginx web server is successfully installed and\n"},{"insert":"working. Further configuration is required."},{"attributes":{"clientside-highlight":"code-hljs-tag"},"insert":"","attributes":{"clientside-highlight":"code-hljs-tag"}},{"insert":"\n"},{"insert":"\n"},{"attributes":{"clientside-highlight":"code-hljs-tag"},"insert":"<"},{"attributes":{"clientside-highlight":"code-hljs-name"},"insert":"p"},{"insert":">","attributes":{"clientside-highlight":"code-hljs-tag"}},{"insert":"For online documentation and support please refer to\n"},{"attributes":{"clientside-highlight":"code-hljs-tag"},"insert":"<"},{"attributes":{"clientside-highlight":"code-hljs-name"},"insert":"a"},{"attributes":{"clientside-highlight":"code-hljs-tag"},"insert":" "},{"attributes":{"clientside-highlight":"code-hljs-attr"},"insert":"href"},{"attributes":{"clientside-highlight":"code-hljs-tag"},"insert":"="},{"attributes":{"clientside-highlight":"code-hljs-string"},"insert":"\"http://nginx.org/\""},{"attributes":{"clientside-highlight":"code-hljs-tag"},"insert":">"},{"insert":"nginx.org"},{"attributes":{"clientside-highlight":"code-hljs-tag"},"insert":""},{"insert":"."},{"attributes":{"clientside-highlight":"code-hljs-tag"},"insert":"<"},{"attributes":{"clientside-highlight":"code-hljs-name"},"insert":"br"},{"insert":"/>","attributes":{"clientside-highlight":"code-hljs-tag"}},{"insert":"\n"},{"insert":"Commercial support is available at\n"},{"attributes":{"clientside-highlight":"code-hljs-tag"},"insert":"<"},{"attributes":{"clientside-highlight":"code-hljs-name"},"insert":"a"},{"attributes":{"clientside-highlight":"code-hljs-tag"},"insert":" "},{"attributes":{"clientside-highlight":"code-hljs-attr"},"insert":"href"},{"attributes":{"clientside-highlight":"code-hljs-tag"},"insert":"="},{"attributes":{"clientside-highlight":"code-hljs-string"},"insert":"\"http://nginx.com/\""},{"attributes":{"clientside-highlight":"code-hljs-tag"},"insert":">"},{"insert":"nginx.com"},{"attributes":{"clientside-highlight":"code-hljs-tag"},"insert":""},{"insert":"."},{"attributes":{"clientside-highlight":"code-hljs-tag"},"insert":"","attributes":{"clientside-highlight":"code-hljs-tag"}},{"insert":"\n"},{"insert":"\n"},{"attributes":{"clientside-highlight":"code-hljs-tag"},"insert":"<"},{"attributes":{"clientside-highlight":"code-hljs-name"},"insert":"p"},{"attributes":{"clientside-highlight":"code-hljs-tag"},"insert":"><"},{"attributes":{"clientside-highlight":"code-hljs-name"},"insert":"em"},{"attributes":{"clientside-highlight":"code-hljs-tag"},"insert":">"},{"insert":"Thank you for using nginx."},{"attributes":{"clientside-highlight":"code-hljs-tag"},"insert":"","attributes":{"clientside-highlight":"code-hljs-tag"}},{"insert":"\n"},{"attributes":{"clientside-highlight":"code-hljs-tag"},"insert":"","attributes":{"clientside-highlight":"code-hljs-tag"}},{"insert":"\n"},{"attributes":{"clientside-highlight":"code-hljs-tag"},"insert":"","attributes":{"clientside-highlight":"code-hljs-tag"}},{"insert":"\n"}],"zoneId":"mbcjwxevgd","zoneType":"Z"}}}