检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
define 否 String 导出API的定义范围: base:基础定义 full:全量定义 all:扩展定义 默认为base version 否 String 导出的API定义版本,默认为当前时间 type 否 String 导出的API定义的格式:json/yaml,默认为json
创建用于前端自定义认证的函数:API网关利用函数对收到的API请求进行安全认证。 创建用于后端自定义认证的函数:API后端服务利用函数对来自API网关转发的API请求进行安全认证。 后端服务签名校验开发:若API在API网关上绑定了签名密钥,则API网关向该API的后端服务发送请求时
对象模型 本节介绍自定义域名及证书的对象模型。 “操作类型”用于描述字段的属性,表示对应字段的值可进行的操作: C:创建;U:更新;R:读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 表1 域名对象模型 参数 类型 说明 操作类型 是否必选
是否必选 参数类型 描述 key 否 String 分组自定义响应的响应头的key,支持英文字母、数字和中划线,长度为1到128位 value 否 String 分组自定义响应的响应头的value,为长度为1到1024位的字符串 最小长度:1 最大长度:1024 响应参数 状态码: 200
日志包含响应Body体信息:勾选后,日志中会携带响应Body体信息。 自定义认证配置 推送的日志中,需要携带的自定义认证信息。 前端:填写日志中要携带的前端自定义认证的响应字段信息,多个字段间使用英文逗号(,)分隔。 后端:填写日志中要携带的后端自定义认证的响应字段信息,多个字段间使用英文逗号(,)分隔。 父主题:
对象模型 本节介绍自定义域名及证书的对象模型。 “操作类型”用于描述字段的属性,表示对应字段的值可进行的操作: C:创建;U:更新;R:读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 表1 域名对象模型 参数 类型 说明 操作类型 是否必选
定义认证中的参数关系如下所示: Header中的请求参数:对应自定义认证中参数位置为Header的身份来源,其参数值在您调用使用该前端自定义认证的API时传入 Query中的请求参数:对应自定义认证中参数位置为Query的身份来源,其参数值在您调用使用该前端自定义认证的API时传入
API分组为什么无法上架到云商店? 上架到云商店的API分组需要同时满足以下条件: 分组中的API类型为公开 分组中的API的安全认证为APP认证 分组中的API已经发布到RELEASE环境 图1 API信息 父主题: 其他
操作流程 配置API前端 在API的前端设置页面选择安全认证方式为“自定义认证”或使用双重认证(APP认证或IAM认证),并选择指定的自定义认证对象,如果没有,则需要创建自定义认证。 配置API后端 在API的后端设置页面添加策略后端,策略条件的条件来源选择“系统参数-前端认证参
正常响应示例,描述API的正常返回信息 表11 security参数说明 名称 是否必选 参数类型 说明 apig-auth-type 否 Object API的认证类型对象数组定义,为空数组 apig-auth-type支持: APP认证: apig-auth-app IAM认证:apig-auth-iam
正常响应示例,描述API的正常返回信息 表10 security参数说明 名称 是否必选 参数类型 说明 apig-auth-type 否 Object API的认证类型对象数组定义,为空数组 apig-auth-type支持: APP认证: apig-auth-app IAM认证:apig-auth-iam
正常响应示例,描述API的正常返回信息 表10 security参数说明 名称 是否必选 参数类型 说明 apig-auth-type 否 Object API的认证类型对象数组定义,为空数组 apig-auth-type支持: APP认证: apig-auth-app IAM认证:apig-auth-iam
是否必选 参数类型 描述 key 否 String 分组自定义响应的响应头的key,支持英文字母、数字和中划线,长度为1到128位 value 否 String 分组自定义响应的响应头的value,为长度为1到1024位的字符串 最小长度:1 最大长度:1024 响应参数 状态码: 201
正常响应示例,描述API的正常返回信息 表10 security参数说明 名称 是否必选 参数类型 说明 apig-auth-type 否 Object API的认证类型对象数组定义,为空数组 apig-auth-type支持: APP认证: apig-auth-app IAM认证:apig-auth-iam
正常响应示例,描述API的正常返回信息 表10 security参数说明 名称 是否必选 参数类型 说明 apig-auth-type 否 Object API的认证类型对象数组定义,为空数组 apig-auth-type支持: APP认证: apig-auth-app IAM认证:apig-auth-iam
Integer 流控时长内分组下的API的总访问次数限制,默认不限,请根据服务的负载能力自行设置 time_interval Integer 流控时长 time_unit String 流控的时间单位 url_domains 字典数据类型 分组上绑定的独立域名列表 响应消息样例: {
性backend_timeout配置修改,可修改的上限为600000,默认5000 单位:毫秒。 最小值:1 缺省值:5000 auth_type 否 String API的认证方式,默认无认证。 NONE:无认证 APP:APP认证 IAM:IAM认证 缺省值:NONE cors
微服务名称 register_address String 注册中心地址 cse_app_id String 微服务所属的应用 version String 微服务的版本,已废弃,通过后端服务器组中的版本承载。 最大长度:64 表10 MicroServiceInfoCCE 参数 参数类型
0/apigw/authorizers/{id} URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 id 是 String 自定义认证的ID 请求消息 表3 参数说明 名称 是否必选 类型 说明 name 是 String 自定义认证的名称。 长度为3 ~ 64位的字符串,字符串由中文、英
0/apigw/authorizers 请求消息 表2 参数说明 名称 是否必选 类型 说明 name 是 String 自定义认证的名称。 长度为3 ~ 64位的字符串,字符串由中文、英文字母、数字、“_”组成,且只能以英文或中文开头。 type 是 String 自定义认证类型: FRONTEND:前端