检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
配置API的响应缓存 您可以通过配置响应缓存策略将后端服务(服务端)返回的应答缓存在API网关中,当客户端发送相同的请求时,网关不用向后端传递请求,直接返回缓存的应答。有效降低后端的负荷,同时减少API调用的延迟。 当使用响应缓存策略时,后端的响应内容会缓存到API网关中,此时A
认项目为单位进行授权,用户可以访问您账号中该区域的所有资源。此处默认为已选择的区域。 函数名称 根据规划自定义名称。建议您按照一定的命名规则填写名称,方便您快速识别和查找。 企业项目 企业项目是项目的升级版,针对企业不同项目间资源的分组和管理,是逻辑隔离。此处默认“default”。
自定义认证配置 推送的日志中,需要携带的自定义认证信息。 前端:填写日志中要携带的前端自定义认证的响应字段信息,多个字段间使用英文逗号(,)分隔。 后端:填写日志中要携带的后端自定义认证的响应字段信息,多个字段间使用英文逗号(,)分隔。 单击“确定”。 如果您需要复制已创建的策略,请在已
响应头操作,您可以覆盖、添加、删除、跳过或新增指定的响应头。 Override:覆盖 当API响应中存在指定的响应头时,使用当前响应头的值覆盖已有响应头的值。 当API响应中存在多个与指定响应头相同名称的响应头时,该操作只会按当前响应头的值返回一条响应头记录。 当API响应中不存在指定的响应头时,添加当前响应头。
公网域名:部署在云服务平台外的业务系统,可以使用公网域名访问API。 您也可以使用系统分配的调试域名(子域名)访问API分组内的API,该调试域名唯一且不可修改,每天最多可以访问1000次,仅适用于内部测试使用。 同一实例下的不同分组不能绑定相同的独立域名。 调试域名默认只能在与实例相同VPC内的服务器
如果API开启了“支持CORS”功能的同时,也绑定了跨域资源共享策略,则以绑定的策略为准。 如果某个请求路径下有OPTIONS方法的API,则该请求路径下的所有API均不允许绑定跨域资源共享策略。 为策略绑定API时,API的请求方法必须为allow_methods中允许的请求方法。 一个API只能绑定一个相同类型的策略。
配置API的后端自定义认证 如果您需要把自己的认证系统用于API调用的认证鉴权,可以使用自定义认证来实现。 自定义认证包括前端和后端两种类型: 前端自定义认证:指APIG使用自定义的认证函数,对收到的API请求进行安全认证。 后端自定义认证:指API的后端服务使用自定义的认证函数,
查看关键操作列表 通过云审计服务,您可以记录与API网关相关的操作事件,便于日后的查询、审计和回溯。 表1 云审计服务支持的API Gateway操作列表 操作名称 资源类型 事件名称 创建API分组 ApiGroup createApiGroup 删除API分组 ApiGroup
配置API的前端自定义认证 如果您需要把自己的认证系统用于API调用的认证鉴权,可以使用自定义认证来实现。 自定义认证包括前端和后端两种类型: 前端自定义认证:指APIG使用自定义的认证函数,对收到的API请求进行安全认证。 后端自定义认证:指API的后端服务使用自定义的认证函数,
设置APP的访问控制 功能介绍 设置凭据的访问控制。 调用方法 请参见如何调用API。 URI PUT /v2/{project_id}/apigw/instances/{instance_id}/apps/{app_id}/app-acl 表1 路径参数 参数 是否必选 参数类型
String API的匹配方式。 SWA:前缀匹配 NORMAL:正常匹配(绝对匹配) 默认:NORMAL group_id String API所属的分组编号。 group_name String API所属分组的名称。 attached_time String 绑定时间。 状态码:
配置AppCode 参数 说明 生成方式 选择AppCode的生成方式。 自动生成:由系统随机生成AppCode。 手动输入:自定义AppCode。 AppCode 仅手动输入方式需要填写AppCode的值。 使用AppCode进行API请求的简易认证 在创建API时,选择“APP认证”并且开启“支持简易认证”。
查询插件下绑定的API 功能介绍 查询指定插件下绑定的API信息。 用于查询指定插件下已经绑定的API列表信息 支持分页返回 支持API名称模糊查询 绑定关系列表中返回的API在对应的环境中可能已经下线 调用方法 请参见如何调用API。 URI GET /v2/{project_
置。如需自定义跨域的请求头、跨域的请求方法和指定授权访问的域,请使用配置API的跨域资源共享。 简单请求的跨域访问 如果是创建新的API,在“安全配置”时,勾选“开启支持跨域(CORS)”开关。详细的使用指导,可参考简单请求。 非简单请求的跨域访问 非简单请求的跨域访问可通过两种配置方式实现,选择其中一种配置即可。
参数类型 描述 project_id 是 String 项目ID,获取方式请参见获取项目ID。 instance_id 是 String 实例ID,在API网关控制台的“实例信息”中获取。 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token
取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 env_id 是 String 绑定API的环境编码。 plugin_ids 是 Array of strings 绑定的插件编码列表。 数组长度:1 - 500 响应参数
获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 env_id 是 String 绑定API的环境编码。 api_ids 是 Array of strings 绑定的API编码列表。 数组长度:1 - 500 响应参数
API的后端服务报“Backend domain name resolution failed” APIG实例所在的VPC完成了内网域名解析,后端服务调用仍报“域名无法解析”错误。 可能原因 APIG实例所在的VPC与用户后端服务所在的VPC存在网络隔离,内网域名解析仅在用户后端服务所在的VPC下能够解析。
单击待查看的API分组名称,进入此分组详情页面。 查看此分组下已购买的API列表和此分组的详细信息。 图2 已购买API的分组详情示例 在待调试API所在行,单击“调试API”,跳转到“调试API”页面。 左侧为API请求参数配置区域,参数说明如表1所示。右侧为API发送的请求信息和API请求调用后的返回结果回显。
选择API需要发布到的环境,并填写发布说明。 如果API在选择的环境中已发布,再次发布即为覆盖该环境的API。 如果在选择的环境时没有自己需要的环境,可以创建一个自己需要的环境。 单击“确定”,API发布成功后,“发布最新版本”按钮左上角的红色感叹号消失。 已发布的API因为其他原因