检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
使用专享版API网关开放本地数据中心的服务能力 06 开发指导 API网关为客户端提供Java、Go、Python、C等多语言的SDK接入,业务后端无需做修改,轻松实现一套系统对接多种业务场景(如移动场景、IoT场景等)。 API认证 APP认证工作原理 APP认证前准备工作 APP认证-Java
方法二:在创建API时,不使用VPC通道(负载通道),使用用户后端服务IP配置“后端服务地址”,添加常量参数,在HEADER中添加Host:域名字段。 方法三:在创建API时,使用VPC通道(负载通道)。 创建VPC通道(负载通道)。 添加用户后端服务地址。 创建API时,使用VPC通道(负载通道),配置自定义头域。
通过APIG接口管理API,发生错误时,产生的错误码请参考错误码。 使用APIG错误码时,请以错误码(如APIG.0101)为准,错误信息并非固定不变,有时会对错误信息进行优化修改。 表1 错误码 错误码 错误信息 HTTP状态码 语义 解决方案 APIG.0101 The API does not exist or
通过APIG接口管理API,发生错误时,产生的错误码请参考错误码。 使用APIG错误码时,请以错误码(如APIG.0101)为准,错误信息并非固定不变,有时会对错误信息进行优化修改。 表1 错误码 错误码 错误信息 HTTP状态码 语义 解决方案 APIG.0101 The API does not exist or
请求body体超过12M时,根据业务需求,请在“实例概览”的配置参数中修改“request_body_size”参数。“request_body_size”表示API请求中允许携带的Body大小上限,支持修改范围1~9536 M。 父主题: 调用API
何在API网关上开放内网ELB中的服务。 方案架构 图1 API网关跨VPC开放后端服务 方案优势 帮助用户根据业务诉求进行灵活配置,无需修改原有业务网络架构,直接将请求转发到后端服务上。 约束与限制 VPC1、VPC2、APIG实例系统VPC网段不能重叠。关于APIG实例VPC网段规划,请参考表2。
高安全的API托管服务,帮助您轻松构建、管理和部署任意规模的API。 您可以使用本文档提供的API对API网关进行相关操作,如创建、删除、修改等。支持的全部操作请参见API概览。 在调用API网关的API前,请确保已经充分了解API网关相关概念,详细信息请参见产品介绍。 专享版开放V2版本的接口,共享版开放V1
0/apigw/apis/runtime/{id}[?env_id] 可以在URI后面用‘?’和‘&’添加不同的查询条件组合。 查询条件可为以下字段以及对应的值:env_id。 URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 id 是 String API的编号
包括API分组的创建、修改、删除、查询详情和列表等接口。 环境管理 包括环境的创建、修改、删除和查询列表等接口。 环境变量管理 包括环境变量的新建、修改、删除、查询详情和列表等接口。 流控策略管理 包括流控策略的创建、修改、删除、查看详情和列表等接口。 API管理 包括API的创建、修改、删除、
_id}/apis/runtime/{id}[?env_id] 可以在URI后面用‘?’和‘&’添加不同的查询条件组合。 查询条件可为以下字段以及对应的值:env_id。 URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 project_id 是 String
object。 当task_type为import_api时,字段包括API分组编号group_id、success数组、failure数组、swagger结构体、ignore数组。其中success数组元素中包括4个字段,导入成功的API编号id、API请求方法method、AP
时间,以便排查原因。 说明: 如果当前的超时时间范围不能满足实际业务需求,请在实例配置参数中修改超时时间上限,可修改范围为1ms~600000ms。如果您修改了超时时间上限,需要同步修改此处的超时时间。 重试次数 后端服务请求失败后的重试次数,默认值为0,取值范围-1~10。 值
资源名称:输入资源的名称,当该事件所涉及的云资源无资源名称或对应的API接口操作不涉及资源名称参数时,该字段为空。 资源ID:输入资源ID,当该资源类型无资源ID或资源创建失败时,该字段为空。 云服务:在下拉框中选择对应的云服务名称。 资源类型:在下拉框中选择对应的资源类型。 操作用户
编辑健康检查配置 操作场景 VPC通道创建完成后,可通过编辑健康检查配置修改健康检查项。 前提条件 已创建VPC通道。 操作步骤 进入共享版控制台。 单击“开放API > VPC通道”,进入到VPC通道列表页面。 单击“VPC通道名称”,进入VPC通道详情页面。 单击“健康检查”,进入“健康检查”页签。
件来源选择“系统参数-前端认证参数”,并完善参数名称、条件类型、条件值等,其中参数名称和条件值要与前端自定义认证函数返回值中context字段下的键值对一致。 调试API 调试API,观察是否成功调用到已添加的策略后端。 父主题: 使用APIG专享版实现不同后端服务的调用
调用API报“No backend available” 检查后端服务是否可以访问,如果不能访问,请修改后端服务。 检查后端服务对应的ECS安全组配置,查看是否已开放您需要的端口。 检查后端服务地址是否使用公网IP地址,如果使用,需要在APIG控制台的“实例管理 > 查看控制台 >
应头。 如果此策略在当前实例中不支持,请联系技术支持升级实例到最新版本。 策略参数会明文展示,为防止信息泄露,请谨慎配置。 使用限制 无法修改API网关增加的系统响应头(x-apig-*,x-request-id等),包括API网关提供的CORS功能增加的响应头。 一个API只能绑定一个相同类型的策略。
Gone 被请求的资源在服务器上已经不再可用,并且没有任何已知的转发地址。 412 Precondition Failed 服务器在验证在请求的头字段中给出先决条件时,未能满足其中的一个或多个。 500 Internal Server Error 服务器遇到了一个未曾预料的状况,导致无法完成对请求的处理。
参考以下约束说明进行检查,并解除限制。 实例配额 同一项目ID下,一个主账号默认只能创建5个实例。如果您需要创建更多实例,可提交工单,申请修改配额。 用户权限 如果您使用系统角色相关权限,需要同时拥有“APIG Administrator”和“VPC Administrator”权限才能创建实例。
基础定义:包括API前端请求定义和响应定义,不包括后端服务定义。其中API前端请求定义除了Swagger规范定义项外,还包括API网关的一些Swagger扩展字段。适用于生成Swagger或OpenAPI格式的API文档定义。 全量定义:包括API前端请求定义、后端服务定义和响应定义。适用于将API