检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
自定义认证管理 创建自定义认证 修改自定义认证 删除自定义认证 查看自定义认证详情 查询自定义认证列表 父主题： 共享版API（仅存量用户使用）
绑定域名 功能介绍 用户自定义的域名，需要CNAME到API分组的子域名上才能生效，具体方法请参见增加CNAME类型记录集。 每个API分组下最多可绑定5个域名。绑定域名后，用户可通过自定义域名调用API。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI
创建自定义认证函数，API网关调用该函数，实现自定义认证。下面以Basic认证为例，介绍如何使用函数服务实现自定义认证。 操作流程 编写自定义认证函数 创建一个函数作为用户自己的认证服务。 创建自定义认证 在APIG中创建一个自定义认证，将函数服务接入APIG。 创建自定义认证的API
需要做自定义修改。 表1 API网关的错误响应类型 错误说明 默认的响应状态码 详细说明 拒绝访问 403 拒绝访问，如触发配置的访问控制策略、或异常攻击检测拦截 自定义认证配置错误 500 自定义认证方异常，通信失败、返回异常响应等错误 自定义认证失败 500 自定义认证方返回认证失败
APIG的API设计文件扩展定义 x-apigateway-auth-type x-apigateway-request-type x-apigateway-match-mode x-apigateway-cors x-apigateway-is-send-fg-body-base64
在API网关提供的安全认证模式下，用户可根据业务需求，灵活实现自定义认证，保障API的安全性。 约束与限制 API网关支持的自定义认证依赖于函数工作流服务，创建自定义认证前，需要先创建函数。 操作流程 创建函数 创建自定义的前端函数，使用函数服务开发自定义认证。 创建自定义认证 创建自定义认证，类型选择“前端”，函数地址选择上一步创建的函数。
自定义认证管理（待下线） 创建自定义认证 修改自定义认证 删除自定义认证 查看自定义认证详情 查询自定义认证列表 父主题： 专享版API（V1）（待下线）
functionEndpoints FUNCTION类型后端服务定义。 mockEndpoints 否 x-apigateway-backend.mockEndpoints MOCK类型后端服务定义。 父主题： APIG的API设计文件扩展定义
x-apigateway-any-method 含义：API网关定义的API请求方法，用以匹配未指定定义的HTTP方法。 作用域：Path Item Object(2.0)/Path Item Object(3.0) 示例： paths: '/path': get:
x-apigateway-cors 含义：API网关定义的API请求是否支持跨域。 作用域：Operation Object(2.0)/Operation Object(3.0) 示例： paths: '/path': get: x-apigateway-cors:
x-apigateway-backend.httpEndpoints 含义：API网关定义的HTTP类型API后端服务定义。 作用域：x-apigateway-backend 示例： paths: '/users/{userId}': get: produces:
x-apigateway-backend.functionEndpoints 含义：API网关定义的FUNCTION类型API后端服务定义。 作用域：x-apigateway-backend 示例： paths: '/users/{userId}': get:
x-apigateway-authorizer 含义：自定义认证对象。 作用域： Security Scheme Object 示例： x-apigateway-authorizer: auth_downgrade_enabled: false authorizer_alias_uri:
x-apigateway-plugins 含义：API网关定义的API插件服务。 作用域：Operation Object(2.0)/Operation Object(3.0) 示例： paths: '/path': get: x-apigateway-plugins:
x-apigateway-responses 含义：自定义网关响应类型。 作用域： Operation Object(2.0)/Operation Object(3.0) 示例： x-apigateway-responses: default: ACCESS_DENIED:
x-apigateway-match-mode 含义：API网关定义的API请求URL的匹配模式，支持NORMAL和SWA。 作用域：Operation Object(2.0)/Operation Object(3.0) 示例： paths: '/path': get:
x-apigateway-ratelimits.policy.special 含义：特殊流控策略定义。 作用域：x-apigateway-ratelimits.policy 示例： x-apigateway-ratelimits: customRatelimitName:
自定义APIG的客户端访问端口 API网关提供自定义实例入端口功能，支持客户端通过不同的端口来访问不同的后端服务。 约束与限制 新增端口时，一个端口仅允许配置一种协议。当前仅支持HTTP和HTTPS协议。 独立域名与端口相关约束与限制内容，请参考约束与限制。 自定义客户端访问端口
x-apigateway-request-type 含义：API网关定义的API请求类型，支持public和private。 作用域：Operation Object(2.0)/Operation Object(3.0) 示例： paths: '/path': get:
x-apigateway-auth-type 含义：基于Swagger的apiKey认证格式，定义API网关支持的特有认证方式。 作用域：Security Scheme Object(2.0)/Security Scheme Object(3.0) Swagger： securityDefinitions:
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
