检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
总长度不超过512,且满足URI规范。 支持环境变量,使用环境变量时,每个变量名的长度为3 ~ 32位的字符串,字符串由英文字母、数字、“_”、“-”组成,且只能以英文开头。 说明: 需要服从URI规范。 timeout 是 Integer API网关请求后端服务的超时时间,最大60000,最小为1 单位:毫秒
名称 是否必选 类型 说明 id 是 String 自定义认证的ID 请求消息 无 响应消息 表3 参数说明 名称 类型 说明 id String 编号 name String 自定义认证的名称 type String 自定义认证类型: FRONTEND:前端 BACKEND:后端
String 自定义认证的ID 请求消息 表3 参数说明 名称 是否必选 类型 说明 name 是 String 自定义认证的名称。 长度为3 ~ 64位的字符串,字符串由中文、英文字母、数字、“_”组成,且只能以英文或中文开头。 type 是 String 自定义认证类型: FRONTEND:前端
您可以选择使用导入的API定义覆盖已有的API定义,或者保留已有的API定义,此时导入的API定义会显示导入失败。 如果选择扩展覆盖,当导入API的扩展定义项名称与已有策略(ACL,流量控制等)名称相同时,则会覆盖已有策略(ACL,流量控制等)。 导入的API不会自动发布到环境,
配置API的前端自定义认证 如果您需要把自己的认证系统用于API调用的认证鉴权,可以使用自定义认证来实现。 自定义认证包括前端和后端两种类型: 前端自定义认证:指APIG使用自定义的认证函数,对收到的API请求进行安全认证。 后端自定义认证:指API的后端服务使用自定义的认证函数,对
配置API的后端自定义认证 如果您需要把自己的认证系统用于API调用的认证鉴权,可以使用自定义认证来实现。 自定义认证包括前端和后端两种类型: 前端自定义认证:指APIG使用自定义的认证函数,对收到的API请求进行安全认证。 后端自定义认证:指API的后端服务使用自定义的认证函数,对
校验API定义 功能介绍 校验API定义。校验API的路径或名称是否已存在 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/instances/{instance_id}/apis/check 表1 路径参数 参数 是否必选 参数类型
创建自定义认证 功能介绍 创建自定义认证 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI POST /v1/{project_id}/apigw/instances/{instance_id}/authorizers
Integer 满足条件的自定义认证总数 size Integer 本次返回的列表长度 authorizer_list Array 自定义认证列表 表4 authorizer_list参数说明 名称 类型 说明 id String 编号 name String 自定义认证的名称 type
Integer 缓存时间 user_data String 用户数据 ld_api_id String 自定义后端服务ID。 暂不支持 need_body Boolean 是否发送body id String 自定义认证编号 create_time String 创建时间 roma_app_id
实例ID,可从API网关控制台的专享版实例信息中获取。 id 是 String 自定义认证的ID 请求消息 无 响应消息 表3 参数说明 名称 类型 说明 id String 编号 name String 自定义认证的名称 type String 自定义认证类型: FRONTEND:前端 BACKEND:后端
String 自定义认证的ID 请求消息 表3 参数说明 名称 是否必选 类型 说明 name 是 String 自定义认证的名称。 长度为3 ~ 64位的字符串,字符串由中文、英文字母、数字、“_”组成,且只能以英文或中文开头。 type 是 String 自定义认证类型: FRONTEND:前端
e,它的取值叫环境名,用以区分不同的环境。 环境变量 在环境上创建可管理的一种变量,该变量固定在环境上。通过创建环境变量,实现同一个API,在不同环境中调用不同的后端服务。 流量控制 流量控制支持从用户、应用(凭据)、源IP和时间段等不同的维度限制对API的调用次数,保护后端服务。
Integer 缓存时间 user_data String 用户数据 ld_api_id String 自定义后端服务ID。 暂不支持 need_body Boolean 是否发送body id String 自定义认证编号 create_time String 创建时间 roma_app_id
API网关请求后端服务的超时时间。函数网络架构为V1时最大超时时间为60000,V2最大超时时间可通过实例特性backend_timeout配置修改,可修改的上限为600000。 单位:毫秒。 最小值:1 authorizer_id 否 String 后端自定义认证ID req_protocol
Integer 缓存时间 user_data String 用户数据 ld_api_id String 自定义后端服务ID。 暂不支持 need_body Boolean 是否发送body id String 自定义认证编号 create_time String 创建时间 roma_app_id
错误类型的响应定义,其中key为错误类型。key的枚举值为: AUTH_FAILURE:认证失败 AUTH_HEADER_MISSING:认证身份来源缺失 AUTHORIZER_FAILURE:自定义认证失败 AUTHORIZER_CONF_FAILURE:自定义认证配置错误 A
Integer 满足条件的自定义认证总数 size Integer 本次返回的列表长度 authorizer_list Array 自定义认证列表 表4 authorizer_list参数说明 名称 类型 说明 id String 编号 name String 自定义认证的名称 type
发布说明、发布时间和发布环境),并支持回滚到任一API历史版本,以便满足业务灰度发布、版本升级、回滚等需求。 环境变量 环境变量是指在环境上创建可管理的一种变量,该变量固定在环境上。当API发布到不同环境时,发布过程中变量标识会被相应环境的变量值替换,API本身定义不变。通过创建
错误类型的响应定义,其中key为错误类型。key的枚举值为: AUTH_FAILURE:认证失败 AUTH_HEADER_MISSING:认证身份来源缺失 AUTHORIZER_FAILURE:自定义认证失败 AUTHORIZER_CONF_FAILURE:自定义认证配置错误 A