检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
配置API的插件策略 配置API的跨域资源共享 配置API的响应缓存 配置API的HTTP响应头 配置API的流量控制2.0 配置API的Kafka日志推送 配置API的断路器 配置API的第三方认证 配置API的流量镜像 父主题: 配置API策略
Integer 查询到的配置项总数 size Integer 本次查询返回的列表长度 configs 字典数据类型 本次查询返回的配置项列表 表4 configs参数说明 名称 类型 说明 config_id String 配置项的编号 config_name String 配置项的名称 config_value
在“凭据配额策略”区域,单击“绑定”。 在弹窗中选择已有策略或单击“创建新策略”。 选择已有策略:单击“选择已有策略”后,选择策略。 创建新策略:请参考表1所示配置策略。 表1 配置凭据配额策略 参数 说明 策略名称 填写客户端配额策略的名称,根据业务规划自定义。建议您按照一定的命名规则填写配额策略名称,方便您快速识别和查找。
配置API的传统策略 配置API的流量控制 配置API的访问控制 配置API的后端服务签名校验 父主题: 配置API策略
删除指定的API分组。 删除API分组前,要先下线并删除分组下的所有API。 删除时,会一并删除直接或间接关联到该分组下的所有资源,包括独立域名、SSL证书信息等等。并会将外部域名与子域名的绑定关系进行解除(取决于域名cname方式)。 调用方法 请参见如何调用API。 URI DELETE
禁止:表示禁止指定IP地址的客户端调用API。 IP地址 单击“增加IP地址”,添加允许或禁止调用API的客户端IP地址或IP地址段。 策略配置完成后,单击“确定”。 父主题: 配置凭据策略
(可选)绑定SSL证书。API分组中的API支持HTTPS请求协议时,需要添加SSL证书。 单击“添加SSL证书”,弹出“添加SSL证书”对话框。 根据已获取SSL证书,输入证书名称、证书内容和密钥,单击“确定”,完成SSL证书的添加。 图1 添加SSL证书 SSL证书目前仅支持p
删除指定的API分组。 删除API分组前,要先下线并删除分组下的所有API。 删除时,会一并删除直接或间接关联到该分组下的所有资源,包括独立域名、SSL证书、上架信息等等。并会将外部域名与子域名的绑定关系进行解除(取决于域名cname方式)。 URI HTTP/HTTPS请求方法以及URI如下表所示。
删除指定的API分组。 删除API分组前,要先下线并删除分组下的所有API。 删除时,会一并删除直接或间接关联到该分组下的所有资源,包括独立域名、SSL证书信息等等。并会将外部域名与子域名的绑定关系进行解除(取决于域名cname方式)。 URI HTTP/HTTPS请求方法以及URI如下表所示。
凭据的名称。 描述 对凭据的介绍。 支持AppKey(Key)和AppSecret(Secret)自定义配置。AppKey是身份标识,需要保证全局唯一。如果没有特殊需求,不建议使用“自定义配置”,系统会默认生成全局标识,可在凭据详情中查看。 单击“确定”,创建凭据。 创建凭据成功后,在凭据管理页面显示新建凭据和凭据ID。
配置APIG的监控告警 操作场景 通过创建告警规则,您可自定义监控目标与通知策略,及时了解API网关服务运行状况,从而起到预警作用。 告警规则包括告警规则名称、监控对象、监控指标、告警阈值、监控周期和是否发送通知等参数。 前提条件 API已被调用。 操作步骤 进入API网关控制台页面。
配置APIG实例参数 配置参数提供了实例内组件的公共参数配置,通过修改配置参数,可以调整组件的相关功能。 约束与限制 修改实例配置参数会引起APIG业务中断,建议在无业务运行或业务低峰时修改配置参数。 操作步骤 进入API网关控制台页面。 在左侧导航栏选择“实例管理”。 在待配置
配置API调用授权(可选) API调用授权概述 配置APIG的API认证凭据 配置APIG的API简易认证AppCode
编辑健康检查配置 操作场景 VPC通道创建完成后,可通过编辑健康检查配置修改健康检查项。 前提条件 已创建VPC通道。 操作步骤 进入共享版控制台。 单击“开放API > VPC通道”,进入到VPC通道列表页面。 单击“VPC通道名称”,进入VPC通道详情页面。 单击“健康检查”,进入“健康检查”页签。
查询租户实例配置列表 功能介绍 查询租户实例配置列表 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instance/configs 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方式请参见获取项目ID。
在“自定义认证”页面,单击“创建自定义认证”。 配置自定义认证参数。 表1 自定义认证参数说明 参数 说明 认证名称 您自定义的认证名称,用于区分不同的自定义认证。 类型 创建后端自定义认证时,选择“后端”。 函数地址 选择用于后端自定义认证的函数后端,仅可以选择状态为“已部署”的函数后端。 版本或别名
配置APIG实例标签 通过标签功能对实例资源进行标记,批量分类实例资源,实现对实例资源进行分组查询、分析及管理。 用户可在标签管理服务(Tag Management Service,简称TMS)中过滤查询资源、分析资源及管理资源。 操作步骤 进入API网关控制台页面。 在左侧导航栏选择“实例管理”。
在“自定义认证”页面,单击“创建自定义认证”。 配置自定义认证参数。 表1 自定义认证参数说明 参数 说明 认证名称 您自定义的认证名称,用于区分不同的自定义认证。 类型 创建前端自定义认证时,选择“前端”。 函数地址 选择用于前端自定义认证的函数后端,仅可以选择状态为“已部署”的函数后端。 版本或别名
查询某个实例的租户配置列表 功能介绍 查询某个实例的租户配置列表,用户可以通过此接口查看各类型资源配置及使用情况。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/project/configs
配置API的参数编排规则 API网关支持对API进行参数编排,根据请求参数取值,配置不同算法规则,映射为新的请求参数和新的参数值。 创建编排规则 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > API策略”。 单击“编排规则管理”页签。