检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
配置API策略 配置API的传统策略 配置API的插件策略
Integer 查询到的配置项总数 size Integer 本次查询返回的列表长度 configs 字典数据类型 本次查询返回的配置项列表 表4 configs参数说明 名称 类型 说明 config_id String 配置项的编号 config_name String 配置项的名称 config_value
配置管理 对象模型 查询租户配置详情 父主题: 共享版API(仅存量用户使用)
配置API的前端自定义认证 如果您需要把自己的认证系统用于API调用的认证鉴权,可以使用自定义认证来实现。 自定义认证包括前端和后端两种类型: 前端自定义认证:指APIG使用自定义的认证函数,对收到的API请求进行安全认证。 后端自定义认证:指API的后端服务使用自定义的认证函数
配置API认证的凭据访问控制 凭据访问控制可控制访问API的凭据IP地址,保护后端服务。您可以为凭据设置访问控制策略,允许/禁止某个IP地址的凭据访问API。 配置凭据的访问控制策略 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理
对凭据的介绍。长度为1~255个字符。 支持AppKey(Key)和AppSecret(Secret)自定义配置。AppKey是身份标识,需要保证全局唯一。如果没有特殊需求,不建议使用“自定义配置”,系统会默认生成全局标识,可在凭据详情中查看。 单击“确定”,创建凭据。 创建凭据成功后,在凭据管理页面显示新建凭据和凭据ID。
如果“后端服务地址”在ECS(Elastic Cloud Server),ECS的安全组的出/入方向规则可能拦截了请求。 检查后端服务所在ECS的安全组,确保出/入方向端口规则和协议都设置正确。 请求协议配置错误,如后端服务为HTTP,在API网关配置为HTTPS。 创建的API与后端服务配置相同的协议。
配置APIG的监控告警 通过创建告警规则,您可自定义监控目标与通知策略,及时了解API网关服务运行状况,从而起到预警作用。 操作步骤 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > API分组”。 单击分组名称,进入“分组信息”页面。
单击凭据名称,进入凭据详情页面。 在“AppCodes”区域,单击“添加AppCode”。 根据下表参数说明,在弹窗中配置AppCode,完成后单击“确定”。 表1 配置AppCode 参数 说明 生成方式 选择AppCode的生成方式。 自动生成:由系统随机生成AppCode。 手动输入:自定义AppCode。
小时、天。 查询范围一小时以内,一分钟一个样本,其样本值为一分钟内的累计值,服务器返回服务器的时间的上一分钟到往前推N分钟的数据; 查询范围一天以内,返回一小时一个样本,其样本值为一小时内的累计值,服务器会返回最近时长横跨统计周期的数据,比如时长为大于2小时,且小于3小时,那么会查询最近3个小时的数据;
查询租户实例配置列表 功能介绍 查询租户实例配置列表 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instance/configs 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方式请参见获取项目ID。
sourceIp:API调用者的源地址。 stage:API调用的部署环境。 apiId:API的ID。 appId:API调用者的APP ID。 requestId:当次调用API所生成的请求ID。 serverAddr:网关服务器的地址 。 serverName:网关服务器的名称。 handleTime:本次调用API的处理时间。
请使用配置API的跨域资源共享。 简单请求的跨域访问 如果是创建新的API,在“安全配置”时,勾选“开启支持跨域(CORS)”开关。详细的使用指导,可参考简单请求。 非简单请求的跨域访问 非简单请求的跨域访问可通过两种配置方式实现,选择其中一种配置即可。 方式一:配置一个OPT
编辑健康检查配置 操作场景 VPC通道创建完成后,可通过编辑健康检查配置修改健康检查项。 前提条件 已创建VPC通道。 操作步骤 进入共享版控制台。 单击“开放API > VPC通道”,进入到VPC通道列表页面。 单击“VPC通道名称”,进入VPC通道详情页面。 单击“健康检查”,进入“健康检查”页签。
配置API调用授权(可选) API调用授权概述 配置APIG的API认证凭据 配置APIG的API简易认证AppCode
只能升配到更高规格,无法降配规格。 规格变更时,出私网IP会发生变化,如有相关防火墙配置或者白名单配置需要完全放通,防止网络问题导致业务受损!变更期间请勿对实例进行任何操作!变更完成后,请根据业务需要重新调整相关防火墙配置或者白名单配置。 API 表2 API约束与限制 限制项 约束与限制 API分组
支持配置前端定义、安全配置和请求参数。 配置API的后端信息 支持配置默认后端、策略后端和返回结果。 前提条件 已创建API分组。如果未创建API分组,请创建API分组。 如果后端服务需要使用负载通道,请创建负载通道。 如果需要使用自定义认证方式进行API的安全认证,请创建自定义认证。 配置API的前端信息
配置APIG实例标签 通过标签功能对实例资源进行标记,批量分类实例资源,实现对实例资源进行分组查询、分析及管理。 用户可在标签管理服务(Tag Management Service,简称TMS)中过滤查询资源、分析资源及管理资源。 配置实例标签 进入API网关控制台页面。 在左侧导航栏选择“实例管理”。
配置API的参数编排规则 API网关支持对API进行参数编排,根据请求参数取值,配置不同算法规则,映射为新的请求参数和新的参数值。 创建编排规则 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > API策略”。 单击“编排规则管理”页签。
查看监控指标与配置告警 APIG支持的监控指标 配置APIG的监控告警 查看APIG的监控指标 查看APIG的带宽监控 查看APIG的API调用日志