检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
HTTP状态码 常用状态码表如表1所示。 表1 HTTP请求状态返回码 返回值 说明 200 OK 处理正常。 204 No Content 无返回内容。 400 Bad Request 服务器未能处理请求。可能原因： 语义有误，当前请求无法被服务器解析； 请求参数有误。 401
查看分组下指定错误类型的自定义响应 功能介绍 查看分组下指定错误类型的自定义响应 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/gateway-responses
调用API失败的可能原因 网络问题 调用API失败的场景分为三种：同一VPC内调用失败、不同VPC之间调用失败、公网调用失败。 VPC内调用API失败时，请检查域名是否和API自动分配的域名一致，如果域名错误，会导致调用API失败。 不同VPC之间调用API失败时，请检查两个VPC
修改分组下指定错误类型的自定义响应 功能介绍 修改分组下指定错误类型的自定义响应。 调用方法 请参见如何调用API。 URI PUT /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/gateway-responses
配置APIG的API认证凭据 使用APP认证的API，需要在API网关中创建一个凭据，以生成凭据ID和密钥对（Key、Secret）。将创建的凭据绑定API后，才可以使用APP认证调用API。客户端（API调用者）在调用API过程中，把密钥对替换SDK中的密钥对，API网关服务根据密钥对进行身份核对
按需计费 适用场景 按需计费适用于短期使用、实例无需7x24小时运行等场景。 适用计费项 表1 按需计费适用计费项 计费项 说明 版本（实例规格） API网关提供的实例版本有：基础版、专业版、企业版、铂金版等，您可以根据实际业务需要按需使用。实例版本说明，请参考产品规格。如果您当前使用的实例版本不能满足需要
创建自定义认证 操作场景 自定义认证包含两种认证：前端自定义认证和后端自定义认证。 前端自定义认证：如果您希望使用自己的认证系统，而不是APP认证/华为IAM认证对API的访问进行认证鉴权时，您可以使用自定义认证，通过您自定义的函数进行认证鉴权。 后端自定义认证：当不同的后端服务使用不同的认证系统时
发布API 操作场景 创建完成的API，支持发布到不同的环境。API只有在发布到环境后，才支持被调用。API网关支持查看API发布历史（如版本、发布说明、发布时间和发布环境），并支持回滚到不同的API历史版本。 已发布的API，在修改信息后，需要重新发布才能将修改后的信息同步到环境中
发布APIG创建的API 创建完成的API，支持发布到不同的环境。API只有在发布到环境后，才支持被调用。API网关支持查看API发布历史（如版本、发布说明、发布时间和发布环境），并支持回滚到不同的API历史版本。 已发布的API，在修改信息后，需要重新发布才能将修改后的信息同步到环境中
使用APIG专享版实现WebSocket服务的转发 应用场景 API网关支持WebSocket API，其创建过程和创建HTTP API一致。WebSocket是一种全双工通信协议，建立在单个TCP连接上，允许在客户端和服务器之间进行双向通信。WebSocket的设计旨在解决HTTP
配置API的参数编排规则 API网关支持对API进行参数编排，根据请求参数取值，配置不同算法规则，映射为新的请求参数和新的参数值。 创建编排规则 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > API策略”。 单击“编排规则管理
APP认证工作原理 构造规范请求。 将待发送的请求内容按照与API网关（即API管理）后台约定的规则组装，确保客户端签名、API网关后台认证时使用的请求内容一致。 使用规范请求和其他信息创建待签字符串。 使用AK/SK和待签字符串计算签名。 将生成的签名信息作为请求消息头添加到HTTP
配置API的自定义认证 自定义认证包含两种认证：前端自定义认证和后端自定义认证。 前端自定义认证：如果您希望使用自己的认证系统，而不是APP认证/华为IAM认证对API的访问进行认证鉴权时，您可以使用自定义认证，通过您自定义的函数进行认证鉴权。 后端自定义认证：当不同的后端服务使用不同的认证系统时
实施步骤 前提条件 已创建自定义认证函数，如果未创建请参考《函数工作流用户指南》中的创建函数章节创建，并且在函数的返回值中已设置context字段，字段中包含键值对。其中键值对的值只支持字符串、布尔、整型三种数值类型，键值对对应“系统参数-前端认证参数”策略条件的参数名称和条件值。
快速开放并调用API 本章节将为您介绍如何快速使用API网关，这里以APP认证类型的简易认证为例，快速开放并调用API。 图1 APIG使用流程 准备工作 在使用APIG之前，需要确保有可用的网络环境，请提前准备VPC、子网和安全组。 创建实例 创建实例时，根据实际需求选择实例的规格
创建用于后端自定义认证的函数 操作场景 如果您需要使用一种认证机制对接多个不同的外部认证系统，实现对于后端服务的保护，您可以通过API网关中的后端自定义认证实现此功能。在使用后端自定义认证对后端请求进行认证授权前，您需要先在FunctionGraph创建一个函数，通过函数定义您所需的认证信息
权限管理 如果您需要对华为云上购买的API网关（API Gateway）资源，给企业中的员工设置不同的访问权限，以达到不同员工之间的权限隔离，您可以使用统一身份认证服务（Identity and Access Management，简称IAM）进行精细的权限管理。该服务提供用户身份认证
创建分组自定义响应 功能介绍 新增分组下自定义响应 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/gateway-responses 表1
APIG最佳实践汇总 本文汇总了基于API网关服务（APIG，APIGateway）常见应用场景的操作实践，为每个实践提供详细的方案描述和操作指导，帮助用户轻松构建基于APIG的业务。 表1 APIG最佳实践一览表 最佳实践 说明 使用APIG专享版开放云容器引擎CCE工作负载 云容器引擎
创建用户并授权使用APIG 如果您需要对您所拥有的API网关服务进行权限管理，您可以使用统一身份认证服务（Identity and Access Management，简称IAM），通过IAM，您可以： 根据企业的业务组织，在您的华为云账号中，给企业中不同职能部门的员工创建IAM用户
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
