检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
创建API的负载通道(可选) 如果需要访问指定服务器中已部署的后端服务,可通过创建负载通道来实现。反之,跳过此步骤。 创建API 把已有后端服务封装为标准RESTFul API或GRPC API,并对外开放。 API创建成功后,您可根据业务需求配置API策略,管理API等。 调试APIG创建的API
配置API调用授权(可选) API调用授权概述 配置APIG的API认证凭据 配置APIG的API简易认证AppCode
填写策略的描述信息。长度为1~255个字符。 策略内容 策略的配置内容,支持表单配置和脚本配置两种方式。 负载通道 是否使用负载通道作为第三方接口的鉴权服务。 选择“使用”时,配置鉴权服务的负载通道。 选择“不使用”时,配置鉴权服务的访问地址。 后端URL 请求方法 支持GET、POST、PUT、HEAD请求方法。
查看监控指标与配置告警 APIG支持的监控指标 配置APIG的监控告警 查看APIG的监控指标 查看APIG的带宽监控 查看APIG的API调用日志
在“凭据配额策略”区域,单击“绑定”。 在弹窗中选择已有策略或单击“创建新策略”。 选择已有策略:单击“选择已有策略”后,选择策略。 创建新策略:请参考表1所示配置策略。 表1 配置凭据配额策略 参数 说明 策略名称 填写客户端配额策略的名称,根据业务规划自定义。建议您按照一定的命名规则填写配额策略名称,方便您快速识别和查找。
配置API认证的凭据访问控制 凭据访问控制可控制访问API的凭据IP地址,保护后端服务。您可以为凭据设置访问控制策略,允许/禁止某个IP地址的凭据访问API。 配置凭据的访问控制策略 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理
配置API的自定义认证 配置API的前端自定义认证 配置API的后端自定义认证 父主题: 管理API
致,则可证明API请求确实来自API网关,而不是其他伪造请求。 VPC通道(负载通道) API网关通过VPC通道访问部署在VPC内的服务,您可以借助API网关将部署在VPC中的后端服务开放给第三方用户调用。 自定义认证 自定义认证指在API调用过程中,用户可自行定义认证规则,实现
对凭据的介绍。长度为1~255个字符。 支持AppKey(Key)和AppSecret(Secret)自定义配置。AppKey是身份标识,需要保证全局唯一。如果没有特殊需求,不建议使用“自定义配置”,系统会默认生成全局标识,可在凭据详情中查看。 单击“确定”,创建凭据。 创建凭据成功后,在凭据管理页面显示新建凭据和凭据ID。
单击凭据名称,进入凭据详情页面。 在“AppCodes”区域,单击“添加AppCode”。 根据下表参数说明,在弹窗中配置AppCode,完成后单击“确定”。 表1 配置AppCode 参数 说明 生成方式 选择AppCode的生成方式。 自动生成:由系统随机生成AppCode。 手动输入:自定义AppCode。
Integer 查询到的配置项总数 size Integer 本次查询返回的列表长度 configs 字典数据类型 本次查询返回的配置项列表 表4 configs参数说明 名称 类型 说明 config_id String 配置项的编号 config_name String 配置项的名称 config_value
配置APIG的监控告警 通过创建告警规则,您可自定义监控目标与通知策略,及时了解API网关服务运行状况,从而起到预警作用。 操作步骤 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > API分组”。 单击分组名称,进入“分组信息”页面。
专享版-配置管理 查询某个实例的租户配置列表 查询租户实例配置列表 父主题: 专享版API(V2)
制华为云资源的访问。 通过IAM,您可以在华为云账号中给员工创建IAM用户,并使用策略来控制员工对API网关资源的访问范围。 如果华为云账号已经能满足您的需求,不需要创建独立的IAM用户进行权限管理,您可以跳过本章节,不影响您使用API网关服务的其它功能。 IAM是华为云提供权限
在API网关提供的安全认证模式下,用户可根据业务需求,配置自定义认证实现API的双重认证方式。 使用DDoS防护服务为APIG抵御DDoS攻击 当用户在公网中调用APIG上公开的业务API时,会存在DDoS攻击风险,为防范DDoS攻击,华为云提供了DDoS防护服务。 使用APIG专享版实现http到https自动重定向
配置APIG的终端节点信息 终端节点用于在VPC和终端节点服务之间建立便捷、安全、私密的连接通道。 在同一区域中,可实现云内跨VPC访问/开放API。 图1 同一区域跨VPC访问 约束与限制 目前除墨西哥城一、北京一区域外,其他区域都支持终端节点管理功能。 配置终端节点信息 进入API网关控制台页面。
查询租户实例配置列表 功能介绍 查询租户实例配置列表 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instance/configs 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方式请参见获取项目ID。
查询某个实例的租户配置列表 功能介绍 查询某个实例的租户配置列表,用户可以通过此接口查看各类型资源配置及使用情况。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/project/configs
修改。 表1 API网关的错误响应类型 错误说明 默认的响应状态码 详细说明 拒绝访问 403 拒绝访问,如触发配置的访问控制策略、或异常攻击检测拦截 自定义认证配置错误 500 自定义认证方异常,通信失败、返回异常响应等错误 自定义认证失败 500 自定义认证方返回认证失败 自定义认证身份来源错误
如果修改完默认网关响应后,需要恢复默认配置,单击“恢复默认配置”即可。 网关错误响应类型说明 API网关提供的错误响应类型见下表,其中响应状态码可以按实际需要做自定义修改。 表1 API网关的错误响应类型 错误说明 默认的响应状态码 详细说明 拒绝访问 403 拒绝访问,如触发配置的访问控制策略、或异常攻击检测拦截