检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
实例ID，可从API网关控制台的专享版实例信息中获取。 请求消息 表3 参数说明 名称 是否必选 类型 说明 name 是 String 自定义认证的名称。 长度为3 ~ 64位的字符串，字符串由中文、英文字母、数字、“_”组成，且只能以英文或中文开头。 type 是 String 自定义认证类型： FRONTEND：前端
配置API的自定义认证 配置API的前端自定义认证 配置API的后端自定义认证 父主题： 管理API
实例ID，可从API网关控制台的专享版实例信息中获取。 id 是 String 自定义认证的ID 请求消息 表3 参数说明 名称 是否必选 类型 说明 name 是 String 自定义认证的名称。 长度为3 ~ 64位的字符串，字符串由中文、英文字母、数字、“_”组成，且只能以英文或中文开头。 type
参数类型 描述 project_id 是 String 项目ID，获取方式请参见获取项目ID。 instance_id 是 String 实例ID，在API网关控制台的“实例信息”中获取。 authorizer_id 是 String 自定义认证的编号 请求参数 表2 请求Header参数
删除分组自定义响应 功能介绍 删除分组自定义响应 调用方法 请参见如何调用API。 URI DELETE /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/gateway-responses/{response_id}
表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 自定义认证的名称。 长度为3 ~ 64位的字符串，字符串由中文、英文字母、数字、“_”组成，且只能以英文或中文开头。 type 是 String 自定义认证类型 FRONTEND：前端 BACKEND：后端
horizers/{id} URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 project_id 是 String 项目ID。可从控制台“我的凭证”中获取region下项目ID，管理员权限可查询。 instance_id 是 String 实例ID，可
“context”字段为可选，支持字符串类型键值对，当实例支持authorizer_context_support_num_bool特性时，键值对的值支持number类型和boolean类型，键值不支持JSON对象或数组。 context中的数据为您自定义的字段，认证通过后作为认证参数映
删除自定义认证 操作场景 当自定义的认证已不再需要时，可以删除自定义认证。 自定义认证依赖函数工作流服务。如果当前Region没有上线函数工作流服务，则不支持使用自定义认证。 已在API中使用的自定义认证无法被删除。 前提条件 已创建自定义认证。 操作步骤 进入共享版控制台。 在“开放API
参数 参数类型 描述 size Integer 本次返回的列表长度 total Long 满足条件的记录数 authorizer_list Array of AuthorizerResp objects 自定义认证列表 表5 AuthorizerResp 参数 参数类型 描述 name
是否必选 参数类型 描述 project_id 是 String 项目ID，获取方式请参见获取项目ID。 instance_id 是 String 实例ID，在API网关控制台的“实例信息”中获取。 authorizer_id 是 String 自定义认证的编号 请求参数 表2 请求Header参数
请求Body参数 参数 是否必选 参数类型 描述 protocol 是 String 实例自定义入方向端口协议。 HTTP：实例自定义入方向端口使用HTTP协议。 HTTPS：实例自定义入方向端口使用HTTPS协议。 ingress_port 是 Integer 实例自定义入方向端口，支持的端口范围为1024~49151。
后，作为自定义认证的后端函数，对API网关中的API进行认证鉴权。 本章节介绍如何将校验函数封装成一个“自定义认证”，以及封装成自定义认证过程中的操作注意事项。 图1 前端自定义认证示意图 使用自定义认证调用API的流程如下图所示： 图2 自定义认证调用API 自定义认证依赖函数
响应消息 表3 参数说明 名称 类型 说明 total Integer 满足条件的自定义认证总数 size Integer 本次返回的列表长度 authorizer_list Array 自定义认证列表 表4 authorizer_list参数说明 名称 类型 说明 id String
参数 是否必选 参数类型 描述 project_id 是 String 项目ID，获取方式请参见获取项目ID。 instance_id 是 String 实例ID，在API网关控制台的“实例信息”中获取。 ingress_port_id 是 String 实例自定义入方向端口ID。 请求参数
API的响应码如何定义？ API响应码分两种类型。 一种是网关响应码。当请求到达网关时，由于API的流量控制、访问控制策略以及认证失败，网关直接返回的响应信息。有关网关响应的详细指导，请参考网关响应。 一种是后端服务响应。响应信息由后端API服务（即API的提供者）定义，API网关只做透传。
Long 满足条件的记录数 ingress_port_infos Array of IngressPortInfo objects 实例自定义入方向端口列表。 表5 IngressPortInfo 参数 参数类型 描述 protocol String 实例自定义入方向端口协议。 H
是否共享流控策略。 special 否 x-apigateway-ratelimits.policy.special 对象数组 特殊流控策略。 父主题： APIG的API设计文件扩展定义
查询API运行时定义 功能介绍 查看指定的API在指定的环境上的运行时定义，默认查询RELEASE环境上的运行时定义。 API的定义分为临时定义和运行时定义，分别代表如下含义： 临时定义：API在编辑中的定义，表示用户最后一次编辑后的API的状态 运行时定义：API在发布到某个环
查询API运行时定义 功能介绍 查看指定的API在指定的环境上的运行时定义，默认查询RELEASE环境上的运行时定义。 API的定义分为临时定义和运行时定义，分别代表如下含义： 临时定义：API在编辑中的定义，表示用户最后一次编辑后的API的状态 运行时定义：API在发布到某个环
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
