检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
名称 是否必选 参数类型 说明 function-urn 是 String 函数URN地址 version 是 String 函数版本 invocation-type 是 String 函数调用类型,支持async、sync timeout 否 Integer 函数超时时间,单位毫秒,缺省值为5000,取值范围为1
{"x-stage": "RELEASE"}, "body") 进行签名,执行此函数会在请求参数中添加用于签名的X-Sdk-Date头和Authorization头。 X-Sdk-Date是一个必须参与签名的请求消息头参数。
在API网关提供的安全认证模式下,用户可根据业务需求,灵活实现自定义认证,保障API的安全问题。 约束与限制 API网关支持的自定义认证需要借助函数工作流服务实现。 父主题: API网关专享版双重认证
名称 是否必选 参数类型 说明 function-urn 是 String 函数URN地址 version 是 String 函数版本 invocation-type 是 String 函数调用类型,支持async、sync timeout 否 Integer 函数超时时间,单位毫秒,缺省值为5000,取值范围为1
Key)和API网关提供的SDK,对API请求进行签名处理。 自定义认证的函数开发:使用自定义认证时,在函数服务中编写一个函数,将其作为认证服务。 创建用于前端自定义认证的函数:API网关利用函数对收到的API请求进行安全认证。 创建用于后端自定义认证的函数:API后端服务利用函数对来自API网关转发的API请求进行安全认证。
请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 size Integer
参数 参数类型 描述 size Integer 本次返回的列表长度 total Long 满足条件的记录数 plugins Array of AttachedPluginInfo objects 绑定API的插件列表。 表5 AttachedPluginInfo 参数 参数类型 描述
如果编配规则列表中包含none_value类型的规则,则none_value类型的规则优先级最高,至多绑定一个none_value类型的规则; 如果编排规则列表中包含default类型的规则,则default类型的规则优先级最低,至多绑定一个default类型的规则; 当编排规则为预处理策略
如果编配规则列表中包含none_value类型的规则,则none_value类型的规则优先级最高,至多绑定一个none_value类型的规则; 如果编排规则列表中包含default类型的规则,则default类型的规则优先级最低,至多绑定一个default类型的规则; 当编排规则为预处理策略
用户在函数工作流中创建自定义认证函数,API网关调用该函数,实现自定义认证。 API网关流量控制2.0策略 当在公网中调用APIG上公开的业务API时,如果不限制API调用的次数,随着用户的不断增加,会引起后端性能的下降,甚至会因为恶意用户发送的大量请求导致网站或程序崩溃。API
路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方式请参见获取项目ID。 instance_id 是 String 实例ID,在API网关控制台的“实例信息”中获取。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否
配置参数作为响应缓存键,用于区分不同的缓存。 system_params类型:配置不同的网关内置系统参数作为响应缓存键来区分缓存。配置参数请参考网关内置参数。 parameters类型:配置不同的请求query参数作为响应缓存键来区分缓存。 headers类型:配置不同的请求头作为响应缓存键来区分缓存。 HTTP参数
256哈希函数创建哈希值。 释义: 请求消息体。消息体需要做两层转换:HexEncode(Hash(RequestPayload)),其中Hash表示生成消息摘要的函数,当前支持SHA-256算法。HexEncode表示以小写字母形式返回摘要的Base-16编码的函数。例如,HexEncode("m")
/aa%2Faa FunctionGraph后端 API的后端类型为FunctionGraph时,发送到函数请求Path - - /aa/aa /aa%2Faa 自定义认证 API认证方式选择自定义认证时,发送到函数请求Path - - /aa/aa /aa%2Faa 父主题: 实例管理
API绑定插件 功能介绍 绑定插件到API上。 只能选择发布状态的API 绑定以后及时生效 修改插件后及时生效 相同类型的插件只能绑定一个,如果再次绑定同类型的插件,那么已绑定的同类型插件将直接被覆盖。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/
插件绑定API 功能介绍 绑定插件到API上。 只能选择发布状态的API 绑定以后及时生效 修改插件后及时生效 相同类型的插件只能绑定一个,如果再次绑定同类型的插件,那么已绑定的同类型插件将直接被覆盖。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/
使用专享版API网关为本地数据中心搭建一条与API网关(所绑定的华为云VPC)之间的专线。 使用函数服务开发自定义认证 API网关支持的自定义认证需要借助函数工作流服务实现,用户在函数工作流中创建自定义认证函数,API网关调用该函数,实现自定义认证。 API网关专享版跨VPC开放后端服务 当用户后端服务
运行质量保证 API网关作为华为云所有云服务OpenAPI的托管平台,可靠性、稳定性有保证,帮助企业完善质量流程体系。 支持函数直接调用 与函数工作流服务无缝对接,支持将函数工作流服务以API形式开放使用。 可视化API监控面板 帮助您监控API调用性能指标、数据延迟以及错误等信息,识别可能影响业务的潜在风险。
HTTP响应头管理策略说明 API响应是指API网关返回客户端的响应,HTTP响应头是API响应中的一部分。您可以自定义HTTP响应头,在返回的API响应中指定您配置的响应头。 如果此策略在当前实例中不支持,请联系技术支持升级实例到最新版本。 使用限制 已了解前提条件。 无法修改
mockEndpoints: result-content: "mocked" 表1 参数说明 参数 是否必选 类型 说明 result-content 是 String MOCK返回结果 父主题: 扩展定义