检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
APIG最佳实践汇总 本文汇总了基于API网关服务（APIG，APIGateway）常见应用场景的操作实践，为每个实践提供详细的方案描述和操作指导，帮助用户轻松构建基于APIG的业务。 表1 APIG最佳实践一览表 最佳实践 说明 使用APIG专享版开放云容器引擎CCE工作负载 云容器引擎
使用APIG专享版实现不同后端服务的调用操作流程 配置API前端 在API的前端设置页面选择安全认证方式为“自定义认证”或使用双重认证（APP认证或IAM认证），并选择指定的自定义认证对象，如果没有，则需要创建自定义认证。 配置API后端 在API的后端设置页面添加策略后端，策略条件的条件来源选择
SDK API网关开放的API，安全认证方式可选IAM认证、APP认证、自定义认证或无认证。四者的区别以及如何选择，请参考调用API。 本章节主要提供APP认证的SDK下载以及文档。IAM认证请参考“使用IAM认证调用API”章节。 操作场景 API使用APP认证时，请根据需要下载
API的流量控制策略不生效怎么处理？ 如果流控策略的API流量限制或源IP流量限制不生效，检查API是否绑定流控策略。 如果流控策略的用户流量限制不生效，检查API的安全认证方式是否为APP认证或IAM认证。 如果流控策略的应用（凭据）流量限制不生效，检查API的安全认证方式是否为
调用API API提供者在API网关开放自己的API后，API调用者从API网关中调用API。 调用限制 如果您使用调试域名（创建API分组时系统分配的调试域名）访问API，该调试域名每天最多可以访问1000次。 获取API的调用信息 在调用API前，您需要向API提供者获取API
什么是API网关 API网关（API Gateway）是为企业和开发者提供的高性能、高可用、高安全的云原生网关服务，能快速将企业服务能力包装成标准API接口，帮助您轻松构建、管理和部署任意规模的API，并上架API云商店进行售卖。借助API网关，可以简单、快速、低成本、低风险地实现内部系统集成和业务能力开放
调用API失败的可能原因 网络问题 调用API失败的场景分为三种：同一VPC内调用失败、不同VPC之间调用失败、公网调用失败。 VPC内调用API失败时，请检查域名是否和API自动分配的域名一致，如果域名错误，会导致调用API失败。 不同VPC之间调用API失败时，请检查两个VPC
自定义API的错误响应信息 网关响应指API网关未能成功处理API请求，从而产生的错误响应。API网关提供默认的网关响应（default），如果您需要自定义响应状态码或网关响应内容，可在API分组管理中新增网关响应，其中响应内容符合JSON格式即可。 例如，“default”网关的响应内容为
创建APP 功能介绍 APP即应用，是一个可以访问API的身份标识。将API授权给APP后，APP即可调用API。 创建一个APP。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI POST /v1.0/apigw
使用APIG专享版实现不同后端服务的调用实施步骤 前提条件 已创建自定义认证函数，如果未创建请创建函数章节创建，并且在函数的返回值中已设置context字段，字段中包含键值对。其中键值对的值只支持字符串、布尔、整型三种数值类型，键值对对应“系统参数-前端认证参数”策略条件的参数名称和条件值
x-apigateway-auth-type 含义：基于Swagger的apiKey认证格式，定义API网关支持的特有认证方式。 作用域：Security Scheme Object(2.0)/Security Scheme Object(3.0) Swagger： securityDefinitions
安全 责任共担 身份认证与访问控制 数据保护技术 审计与日志 监控安全风险 认证证书
创建APP 功能介绍 APP即应用，是一个可以访问API的身份标识。将API授权给APP后，APP即可调用API。 创建一个APP。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI POST /v1/{project_id
新增网关响应 操作场景 网关响应，指API网关未能成功处理API请求，从而产生的错误响应。API网关提供默认的网关响应（default），如果您需要自定义响应状态码或网关响应内容，可在API分组管理中新增网关响应，其中响应内容符合JSON格式即可。 例如，“default”网关的响应内容为
API分组为什么无法上架到云商店？ API分组无法上架到云商店，是因为未同时满足以下条件，请按照以下条件排查并修改。 分组中的API类型为公开 分组中的API的安全认证为APP认证 分组中的API已经发布到RELEASE环境 图1 API信息 父主题： 产品咨询
创建APP 功能介绍 APP即应用，是一个可以访问API的身份标识。将API授权给APP后，APP即可调用API。 创建一个APP。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/instances/{instance_id}/apps
使用APIG专享版实现不同后端服务的调用方案概述 应用场景 API网关支持定义多个策略后端，通过不同的策略条件，将API请求转发到不同的后端服务中，用以满足不同的调用场景。例如为了区分普通调用与特殊调用，可以定义一个“策略后端”，通过调用前端自定义认证参数，为特殊调用方分配专用的后端服务
x-apigateway-authorizer 含义：自定义认证对象。 作用域： Security Scheme Object 示例： x-apigateway-authorizer: auth_downgrade_enabled: false authorizer_alias_uri
修改分组自定义响应 功能介绍 修改分组自定义响应 调用方法 请参见如何调用API。 URI PUT /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/gateway-responses/{response_id
删除分组指定错误类型的自定义响应配置 功能介绍 删除分组指定错误类型的自定义响应配置，还原为使用默认值的配置。 调用方法 请参见如何调用API。 URI DELETE /v2/{project_id}/apigw/instances/{instance_id}/api-groups
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
