检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 call_limits
配置API的第三方认证 您可以通过第三方认证策略配置自己的鉴权服务为API的访问进行认证。API网关先调用用户的鉴权服务,收到鉴权服务的鉴权成功响应后再继续调用后端服务。 如果此策略在当前实例中不支持,请联系技术支持升级实例到最新版本。 策略参数会明文展示,为防止信息泄露,请谨慎配置。
response_id String 分组自定义响应ID backend_api 字典数据类型 后端服务:web后端详情 mock_info 字典数据类型 后端服务:MOCK详情 func_info 字典数据类型 后端服务:函数工作流后端详情 req_params 字典数据类型 API的请求参数列表 backend_params
址或账户的黑白名单来拒绝/允许某个IP地址或账户访问API。 签名密钥 签名密钥用于后端服务验证API网关的身份,在API网关请求后端服务时,保障后端服务的安全。 调试API 验证API服务的功能是否正常可用。 发布API 把API发布到环境中,API只有在发布到环境后,才支持被调用。
API网关请求后端服务的超时时间。最大超时时间可通过实例特性backend_timeout配置修改,可修改的上限为600000。 单位:毫秒。 最小值:1 enable_client_ssl Boolean 是否开启双向认证 retry_count String 请求后端服务的重试次数,默认为-1,范围[-1
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
图1 后端自定义认证示意图 使用自定义认证调用API的流程如下图所示: 图2 使用自定义认证调用API 自定义认证依赖函数服务。如果当前Region没有上线函数服务,则不支持使用自定义认证。 操作步骤 在FunctionGraph中开发函数。 下面以python2.7为例,函数代码需要满足如下条件:
HTTPS,同一个服务的Endpoint在同一个区域也相同,所以简洁起见将这两部分省略。 请求方法 HTTP请求方法(也称为操作或动词),它告诉服务你正在请求什么类型的操作。 GET:请求服务器返回指定资源。 PUT:请求服务器更新指定资源。 POST:请求服务器新增资源或执行特殊操作。
查询实例的终端节点服务的白名单列表 功能介绍 查询当前实例终端节点服务的白名单列表。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/vpc-endpoint/permissions 表1
是否备用节点。 开启后对应后端服务为备用节点,仅当非备用节点全部故障时工作。 实例需要升级到对应版本才支持此功能,如果不支持请联系技术支持。 缺省值:false member_group_name String 后端服务器组名称。为后端服务地址选择服务器组,便于统一修改对应服务器组的后端地址。
将DNS服务器地址添加到弹性云服务器对应的子网中。以“华北-北京一”为例描述相关的操作步骤。 在管理控制台左上角单击,选择区域。 在服务列表中,单击“计算 > 弹性云服务器”,进入弹性云服务器管理页面。 单击待使用的弹性云服务器名称,进入弹性云服务器详情页面。 在“网卡”页签,单击,查看弹性云服务器的子网名称。
怎样使用API网关? API网关提供了以下方式来管理/调用API: Web化的服务管理平台,即管理控制台。 如果您已注册云服务,可直接登录管理控制台,单击管理控制台左上角,然后单击“API网关 APIG”。 有关管理控制台的功能描述以及操作使用指导,请参考《API网关用户指南》。
删除自定义认证 操作场景 当自定义的认证已不再需要时,可以删除自定义认证。 自定义认证依赖函数工作流服务。如果当前Region没有上线函数工作流服务,则不支持使用自定义认证。 已在API中使用的自定义认证无法被删除。 前提条件 已创建自定义认证。 操作步骤 进入共享版控制台。 在“开放API
x-apigateway-plugins 含义:API网关定义的API插件服务。 作用域:Operation Object(2.0)/Operation Object(3.0) 示例: paths: '/path': get: x-apigateway-plugins: