检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
本节介绍API及后端服务的对象模型。 “操作类型”用于描述字段的属性,表示对应字段的值可进行的操作: C:创建;U:更新;R:读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 表1 API对象模型 参数 类型 说明 操作类型 是否必选 id String API的编号
String 函数版本。 当函数别名URN和函数版本同时传入时,函数版本将被忽略,只会使用函数别名URN 最大长度:64 authorizer_alias_uri 否 String 函数别名地址。 当函数别名URN和函数版本同时传入时,函数版本将被忽略,只会使用函数别名URN identities
backend_api 字典数据类型 后端服务:web后端详情 mock_info 字典数据类型 后端服务:MOCK详情 func_info 字典数据类型 后端服务:函数工作流后端详情 req_params 字典数据类型 API的请求参数列表 backend_params 字典数据类型 API的后端参数列表
配置API后端 在API的后端设置页面添加策略后端,策略条件的条件来源选择“系统参数-前端认证参数”,并完善参数名称、条件类型、条件值等,其中参数名称和条件值要与前端自定义认证函数返回值中context字段下的键值对一致。 调试API 调试API,观察是否成功调用到已添加的策略后端。 父主题:
authorizer_alias_uri 否 String 函数别名地址。 当函数别名URN和函数版本同时传入时,函数版本将被忽略,只会使用函数别名URN。 authorizer_version 否 String 函数版本。 当函数别名URN和函数版本同时传入时,函数版本将被忽略,只会使用函数别名URN。 最大长度:64。
authorizer_version String 函数版本。 当函数别名URN和函数版本同时传入时,函数版本将被忽略,只会使用函数别名URN 最大长度:64 authorizer_alias_uri String 函数别名地址。 当函数别名URN和函数版本同时传入时,函数版本将被忽略,只会使用函数别名URN identities
后端认证需要先添加一个自定义认证,自定义认证通过函数服务实现,在函数服务中编写一个函数,实现您的认证鉴权流程,或者使用函数调用您的统一鉴权服务。 说明: 后端认证依赖函数服务,此功能仅在部分区域开放。 表5 FunctionGraph类型定义后端服务 参数 说明 函数名 添加函数后,函数名自动生成。 函数URN 函数请求唯一标识。
mock_info 字典数据类型 后端服务:MOCK详情 func_info 字典数据类型 后端服务:函数工作流后端详情 req_params 字典数据类型 API的请求参数列表 backend_params 字典数据类型 API的后端参数列表 policy_https 字典数据类型 web策略后端列表
mock_info 字典数据类型 后端服务:MOCK详情 func_info 字典数据类型 后端服务:函数工作流后端详情 req_params 字典数据类型 API的请求参数列表 backend_params 字典数据类型 API的后端参数列表 policy_https 字典数据类型 web策略后端列表
查询可绑定当前插件的API 功能介绍 查询可绑定当前插件的API信息。 支持分页返回 支持API名称模糊查询 支持已绑定其他插件的API查询返回 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance
backend_api 字典数据类型 后端服务:web后端详情 mock_info 字典数据类型 后端服务:MOCK详情 func_info 字典数据类型 后端服务:函数工作流后端详情 req_params 字典数据类型 API的请求参数列表 backend_params 字典数据类型 API的后端参数列表
0/apigw/authorizers/{id} URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 id 是 String 自定义认证的ID 请求消息 表3 参数说明 名称 是否必选 类型 说明 name 是 String 自定义认证的名称。 长度为3 ~ 64位的字符串,字符
backend_api 字典数据类型 后端服务:web后端详情 mock_info 字典数据类型 后端服务:MOCK详情 func_info 字典数据类型 后端服务:函数工作流后端详情 req_params 字典数据类型 API的请求参数列表 backend_params 字典数据类型 API的后端参数列表
mock_info 字典数据类型 后端服务:MOCK详情 func_info 字典数据类型 后端服务:函数工作流后端详情 req_params 字典数据类型 API的请求参数列表 backend_params 字典数据类型 API的后端参数列表 policy_https 字典数据类型 web策略后端列表
请求消息 表3 参数说明 名称 是否必选 类型 说明 name 是 String 自定义认证的名称。 长度为3 ~ 64位的字符串,字符串由中文、英文字母、数字、“_”组成,且只能以英文或中文开头。 type 是 String 自定义认证类型: FRONTEND:前端 BACKEND:后端
请求消息 表3 参数说明 名称 是否必选 类型 说明 name 是 String 自定义认证的名称。 长度为3 ~ 64位的字符串,字符串由中文、英文字母、数字、“_”组成,且只能以英文或中文开头。 type 是 String 自定义认证类型: FRONTEND:前端 BACKEND:后端
authorizer_version String 函数版本。 当函数别名URN和函数版本同时传入时,函数版本将被忽略,只会使用函数别名URN 最大长度:64 authorizer_alias_uri String 函数别名地址。 当函数别名URN和函数版本同时传入时,函数版本将被忽略,只会使用函数别名URN identities
参数说明 参数 是否必选 类型 说明 function-urn 是 String 函数URN地址。 version 是 String 函数版本。 invocation-type 是 String 函数调用类型,支持异步或同步。 timeout 否 Number 函数超时时间,单位毫秒,
身份认证与访问控制 身份认证 服务认证:APIG提供AKSK、Token等多种方式进行服务认证,只允许授权的访问。 自定义认证:APIG支持用户以函数自定义API认证方式,丰富鉴权逻辑。 证书校验:APIG支持对后端服务进行证书校验。 身份认证:APIG提供签名密钥进行后端访问身份认证。
请求消息 表2 参数说明 名称 是否必选 类型 说明 name 是 String 自定义认证的名称。 长度为3 ~ 64位的字符串,字符串由中文、英文字母、数字、“_”组成,且只能以英文或中文开头。 type 是 String 自定义认证类型: FRONTEND:前端 BACKEND:后端