检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
添加一个API，API即一个服务接口，具体的服务能力。 API分为两部分，第一部分为面向API使用者的API接口，定义了使用者如何调用这个API。第二部分面向API提供者，由API提供者定义这个API的真实的后端情况，定义了API网关如何去访问真实的后端服务。 API的真实后端服务目前支持三种类型：
查看。 时间段 支持查看“近1小时”、“近3小时”、“近12小时”、“近24小时”或“近7天”的数据监控时间段，也可以单击自定义时间段。同时，监控指标视图右上角会动态显示对应时段内监控指标的最大值与最小值。 自动刷新 打开“自动刷新”开关，可每分钟自动刷新一次数据。 周期 数据聚
子域名：API分组创建后，系统为分组自动分配一个内部测试用的子域名，此子域名唯一且不可更改，每天最多可以访问1000次。 独立域名：您自定义的域名，最多可以添加5个独立域名，不限访问次数。API调用者通过访问独立域名来调用您开放的API。 前提条件 已有独立域名。可通过域名注册服务申请新的域名。
间为60000，V2最大超时时间可通过实例特性backend_timeout配置修改，可修改的上限为600000。 单位：毫秒。 最小值：1 authorizer_id 否 String 后端自定义认证ID req_protocol 否 String 函数后端的请求协议：HTTP
拒绝访问，如触发配置的访问控制策略、或异常攻击检测拦截 自定义认证配置错误 500 自定义认证方异常，通信失败、返回异常响应等错误 自定义认证失败 500 自定义认证方返回认证失败 自定义认证身份来源错误 401 前端自定义认证的身份来源信息缺失或不合法错误 第三方认证配置错误 500
API的响应码如何定义？ API响应码分两种类型。 一种是网关响应码。当请求到达网关时，由于API的流量控制、访问控制策略以及认证失败，网关直接返回的响应信息。有关网关响应的详细指导，请参考自定义API的错误响应信息。 一种是后端服务响应。响应信息由后端API服务（即API的提供者）定义，API网关只做透传。
自定义APIG的客户端访问端口 API网关提供自定义实例入端口功能，支持客户端通过不同的端口来访问不同的后端服务。 约束与限制 新增端口时，一个端口仅允许配置一种协议。当前仅支持HTTP和HTTPS协议。 独立域名与端口相关约束与限制内容，请参考约束与限制。 自定义客户端访问端口
SSL证书绑定域名 功能介绍 SSL证书绑定域名。使用实例自定义入方向端口的特性时，相同的域名会同时绑定证书，注意开启/关闭客户端校验会对相同域名的不同端口同时生效。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/certifi
是 String 插件定义内容，支持json。参考提供的具体模型定义 CorsPluginContent：跨域资源共享 定义内容 SetRespHeadersContent：HTTP响应头管理 定义内容 KafkaLogContent：Kafka日志推送 定义内容 BreakerContent：断路器
支持yaml和json两种文件格式的API导入，界面可预览待导入API内容。 图2 导入参数 （可选）修改待导入API的全局配置。 您可以修改全局配置，如前后端的请求配置，也可以修改具体的接口配置。 图3 修改全局配置 图4 修改接口配置 单击“快速上线”，完成API导入。 导入的API不会自动发布到环境，需要您手动发布。
描述 name 是 String 自定义认证的名称。 长度为3 ~ 64位的字符串，字符串由中文、英文字母、数字、“_”组成，且只能以英文或中文开头。 type 是 String 自定义认证类型 FRONTEND：前端 BACKEND：后端 不支持修改 authorizer_type
配置API的后端自定义认证 如果您需要把自己的认证系统用于API调用的认证鉴权，可以使用自定义认证来实现。 自定义认证包括前端和后端两种类型： 前端自定义认证：指APIG使用自定义的认证函数，对收到的API请求进行安全认证。 后端自定义认证：指API的后端服务使用自定义的认证函数，对
配置API的前端自定义认证 如果您需要把自己的认证系统用于API调用的认证鉴权，可以使用自定义认证来实现。 自定义认证包括前端和后端两种类型： 前端自定义认证：指APIG使用自定义的认证函数，对收到的API请求进行安全认证。 后端自定义认证：指API的后端服务使用自定义的认证函数，对
自定义认证管理 创建自定义认证 修改自定义认证 删除自定义认证 查看自定义认证详情 查询自定义认证列表 父主题： 共享版API（仅存量用户使用）
专享版-分组自定义响应管理 创建分组自定义响应 查询分组自定义响应详情 修改分组自定义响应 删除分组自定义响应 查看分组下指定错误类型的自定义响应 修改分组下指定错误类型的自定义响应 删除分组指定错误类型的自定义响应配置 查询分组自定义响应列表 父主题： 专享版API（V2）
修改API 功能介绍 修改指定API的信息，包括后端服务信息。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI PUT /v1.0/apigw/apis/{id} URI中的参数说明如下表所示。 表2 参数说明
专享版-自定义认证管理 创建自定义认证 修改自定义认证 删除自定义认证 查看自定义认证详情 查询自定义认证列表 父主题： 专享版API（V2）
参数类型 描述 name String 自定义认证的名称。 长度为3 ~ 64位的字符串，字符串由中文、英文字母、数字、“_”组成，且只能以英文或中文开头。 type String 自定义认证类型 FRONTEND：前端 BACKEND：后端 不支持修改 authorizer_type String
创建自定义认证函数，API网关调用该函数，实现自定义认证。下面以Basic认证为例，介绍如何使用函数服务实现自定义认证。 操作流程 编写自定义认证函数 创建一个函数作为用户自己的认证服务。 创建自定义认证 在APIG中创建一个自定义认证，将函数服务接入APIG。 创建自定义认证的API
自定义认证管理（待下线） 创建自定义认证 修改自定义认证 删除自定义认证 查看自定义认证详情 查询自定义认证列表 父主题： 专享版API（V1）（待下线）
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
