检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
失败返回示例，描述API的异常返回信息 backend_api 字典数据类型 后端服务：web后端详情 mock_info 字典数据类型 后端服务：MOCK详情 func_info 字典数据类型 后端服务：函数工作流后端详情 req_params 字典数据类型 API的请求参数列表 backend_params
请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 call_limits
配置API的第三方认证 您可以通过第三方认证策略配置自己的鉴权服务为API的访问进行认证。API网关先调用用户的鉴权服务，收到鉴权服务的鉴权成功响应后再继续调用后端服务。 如果此策略在当前实例中不支持，请联系技术支持升级实例到最新版本。 策略参数会明文展示，为防止信息泄露，请谨慎配置。
实施步骤 登录函数工作流控制台，在“总览”页面，单击“创建函数”。详情请参考使用FunctionGraph服务实现APIG的自定义认证。 根据下表，填写函数信息后，单击“创建函数”。 表1 函数信息配置 参数 配置说明 函数类型 默认“事件函数”。 区域 与API网关相同区域。 项目
址或账户的黑白名单来拒绝/允许某个IP地址或账户访问API。 签名密钥 签名密钥用于后端服务验证API网关的身份，在API网关请求后端服务时，保障后端服务的安全。 调试API 验证API服务的功能是否正常可用。 发布API 把API发布到环境中，API只有在发布到环境后，才支持被调用。
API网关请求后端服务的超时时间。最大超时时间可通过实例特性backend_timeout配置修改，可修改的上限为600000。 单位：毫秒。 最小值：1 enable_client_ssl Boolean 是否开启双向认证 retry_count String 请求后端服务的重试次数，默认为-1，范围[-1
如果您需要对您所拥有的API网关服务进行精细的权限管理，您可以使用统一身份认证服务（Identity and Access Management，简称IAM）。 如果华为云账号已经能满足您的要求，不需要创建独立的IAM用户，您可以跳过本章节，不影响您使用API网关服务的其它功能。 仅API网关专享版支持精细的细粒度授权。
身份认证与访问控制 身份认证 服务认证：APIG提供AKSK、Token等多种方式进行服务认证，只允许授权的访问。 自定义认证：APIG支持用户以函数自定义API认证方式，丰富鉴权逻辑。 证书校验：APIG支持对后端服务进行证书校验。 身份认证：APIG提供签名密钥进行后端访问身份认证。
后端认证需要先添加一个自定义认证，自定义认证通过函数工作流服务实现，在函数工作流服务中编写一个函数，实现您的认证鉴权流程，或者使用函数调用您的统一鉴权服务。 说明： 后端认证依赖函数工作流服务，此功能仅在部分区域开放。 表5 FunctionGraph类型定义后端服务 服务参数 参数说明 FunctionURN
Administrator API网关服务的管理员权限。拥有该权限的用户可以使用API网关服务的所有功能。 系统角色 如果在操作过程中涉及其他服务资源的创建、删除、变更等，则还需要在同项目中勾选对应服务的Administrator权限。 APIG FullAccess API网关服务所有权限。拥有该权
查询API列表 功能介绍 查看API列表，返回API详细信息、发布信息等，但不能查看到后端服务信息。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1/{project_id}/apigw/
查询API列表 功能介绍 查看API列表，返回API详细信息、发布信息等，但不能查看到后端服务信息。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/apis[?page_size
是否备用节点。 开启后对应后端服务为备用节点，仅当非备用节点全部故障时工作。 实例需要升级到对应版本才支持此功能，如果不支持请联系技术支持。 缺省值：false member_group_name String 后端服务器组名称。为后端服务地址选择服务器组，便于统一修改对应服务器组的后端地址。
请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 响应参数 状态码： 200 表4 响应Body参数 参数 参数类型
Mock：把配置的响应结果作为后端服务响应固定返回。 Mock自定义返回码：后端服务响应的状态码。 Mock返回结果：后端服务响应的Body信息，JSON格式。 响应头参数：后端服务响应的Header参数。 HTTP&HTTPS：把后端服务请求转发给指定HTTP&HTTPS后端服务。 负载通道：是
时，默认开启客户端认证即双向认证；反之，开启单向认证。 单向认证：客户端与服务端连接时，客户端需要校验服务端SSl证书合法性。 双向认证：客户端与服务端连接时，除了客户端需要校验服务端SSl证书合法性，服务端也需要校验客户端SSl证书合法性。 父主题： 配置APIG专享版与客户端间的单向认证或双向认证
开启后对应后端服务为备用节点，仅当非备用节点全部故障时工作。 实例需要升级到对应版本才支持此功能，如果不支持请联系技术支持。 缺省值：false member_group_name 否 String 后端服务器组名称。为后端服务地址选择服务器组，便于统一修改对应服务器组的后端地址。
String 后端服务器组名称。为后端服务地址选择服务器组，便于统一修改对应服务器组的后端地址。 status Integer 后端服务器状态 1：可用 2：不可用 port Integer 后端服务器端口 最小值：0 最大值：65535 ecs_id String 后端云服务器的编号。
x-apigateway-backend.mockEndpoints 含义：API网关定义的MOCK类型API后端服务定义。 作用域：x-apigateway-backend 示例： paths: '/users/{userId}': get: produces:
已购买API 操作场景 API网关共享版支持查看已购买的API，明确已购买服务的详情。并通过调试API，验证服务是否正常。 已购买的API，需要通过APP认证方式调用。 前提条件 已从云商店购买了API。 操作步骤 进入共享版控制台。 单击“调用API > 已购买API”，进入到已购买API分组信息页面。
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
