检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
绑定SSL证书(可选) 如果API分组中的API支持HTTPS请求协议,则需要为独立域名绑定SSL证书。否则跳过此步骤。 在域名所在行单击“选择SSL证书”。 在选择SSL证书弹窗中勾选要绑定的SSL证书,然后单击“确定”,完成SSL证书的绑定。 如果选择的SSL证书上传过C
通过创建负载通道,可访问指定服务器中已部署的后端服务。 创建API 把已有后端服务封装为标准RESTFul API或GRPC API,并对外开放。 API创建成功后,您可根据业务需求配置API策略,管理API等。 调试APIG创建的API 验证API服务的功能是否正常可用。 配置API的发布环境和环境变量(可选)
仅当“安全协议”选择“SASL_PLAINTEXT”或“SASL_SSL”时需配置。 填写与SASL用户密码一样的值。 证书内容 仅当“安全协议”选择“SASL_SSL”时需配置。 SSL认证所使用的CA证书内容。 元数据配置信息 系统元数据 推送的日志中,需要携带的系统字段信息。 其中,s
认证证书 合规证书 华为云服务及平台通过了多项国内外权威机构(ISO/SOC/PCI等)的安全合规认证,用户可自行申请下载合规资质证书。 图1 合规证书下载 资源中心 华为云还提供以下资源来帮助用户满足合规性要求,具体请查看资源中心。 图2 资源中心 销售许可证&软件著作权证书 另
在“创建策略”弹窗中,配置策略信息。 表1 流量镜像参数说明 参数 说明 策略名称 填写策略的名称,根据业务规划自定义。建议您按照一定的命名规则填写策略名称,方便您快速识别和查找。 策略类型 固定为“流量镜像”。 描述 填写策略的描述信息。 策略内容 策略的配置内容,支持表单配置和脚本配置两种方式。
响应缓存键 配置参数作为响应缓存键,用于区分不同的缓存。 system_params类型:配置不同的网关内置系统参数作为响应缓存键来区分缓存。配置参数请参考网关内置参数。 parameters类型:配置不同的请求query参数作为响应缓存键来区分缓存。 headers类型:配置不同的请求头作为响应缓存键来区分缓存。
查看域名证书 功能介绍 查看域名下绑定的证书详情。 URI HTTP/HTTPS请求方法以及URI如下表所示 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/api-groups/{group_id}/domains/{domain
配置API的HTTP响应头 API响应是指API网关返回客户端的响应,HTTP响应头是API响应中的一部分。您可以自定义HTTP响应头,在返回的API响应中指定您配置的响应头。 如果此策略在当前实例中不支持,请联系技术支持升级实例到最新版本。 策略参数会明文展示,为防止信息泄露,请谨慎配置。
实例配置特性 功能介绍 为实例配置需要的特性。 支持配置的特性列表及特性配置示例请参考本手册中的“附录 > 实例支持的APIG特性”章节。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/instances/{instance_id}/features
查看域名证书 功能介绍 查看域名下绑定的证书详情。 URI HTTP/HTTPS请求方法以及URI如下表所示 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1/{project_id}/apigw/instances/{instance_id}/ap
降级参数配置 降级参数配置开关。开启后可为断路器自定义规则,API请求优先匹配自定义规则中的触发条件和降级策略,仅当未匹配到自定义规则时才执行上方配置的默认触发条件和降级策略。 如果匹配到自定义规则,则执行规则内配置的触发条件和降级策略。如果匹配到的自定义规则内未配置触发条件或
账号ID:仅适用IAM认证类型的API,限制调用API的账号ID。仅支持配置账号ID,对账号ID及账号ID下的IAM用户ID做限制,不支持配置IAM用户ID。 可以配置单账号ID或多账号ID,多账号ID以英文格式下的“,”隔开。账号ID为英文字母、数字组成的32位字符;多账号ID字符的总长度不超过1024。 说明:
单个IP地址调用API次数上限。您可以选择配置实例的“real_ip_from_xff”参数使用X-Forwarded-For头中的IP作为流控的判断依据。 不超过“API流量限制”。 与“时长”配合使用,表示单位时间内的单个IP地址请求次数上限。 参数流控配置 参数流控配置开关。开启后,以参数维度进行流控限制。
应头中获取此处配置的头部,传到业务后端。 最大支持配置10个头部。 简易鉴权模式 开关开启后,鉴权服务返回状态码“2xx”时,表示认证通过。 鉴权结果匹配 仅在“简易鉴权模式”关闭后可配置。 根据鉴权服务返回的响应头中的参数名和参数值进行校验,响应头中存在此处配置的参数名,并且参数值相等则认证通过。
配置API的流量控制 流量控制支持从用户、凭据和时间段等不同的维度限制对API的调用次数,保护后端服务。支持按分/按秒粒度级别的流量控制。为了提供持续稳定的服务,您可以通过创建流控策略,针对部分API进行流量控制。 使用限制 API添加流控策略相当于流控策略同步绑定了API。同一
绑定域名证书 功能介绍 如果创建API时,“定义API请求”使用HTTPS请求协议,那么在独立域名中需要添加SSL证书。 本章节主要介绍为特定域名绑定证书。 URI HTTP/HTTPS请求方法以及URI如下表所示 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI POST
在“创建策略”弹窗中,配置策略信息。 表1 跨域资源共享策略配置 参数 说明 策略名称 填写策略的名称,根据业务规划自定义。建议您按照一定的命名规则填写策略名称,方便您快速识别和查找。 策略类型 固定为“跨域资源共享”。 描述 填写策略的描述信息。 策略内容 策略的配置内容,支持表单配置和脚本配置两种方式。
凭据管理”。 单击凭据名称,进入凭据详情页面。 在“AppCodes”区域,单击“添加AppCode”。 在弹窗中配置AppCode,完成后单击“确定”。 表1 配置AppCode 参数 说明 生成方式 选择AppCode的生成方式。 自动生成:由系统随机生成AppCode。 手动输入:自定义AppCode。
配置管理 对象模型 查询租户配置详情 父主题: 共享版API(仅存量用户使用)
签名密钥”。 在“创建策略”弹窗中,配置策略信息。 表1 签名密钥参数说明 参数 说明 密钥名称 自定义名称,用于识别不同的密钥。 类型 选择签名密钥的认证类型,可选择“HMAC”、“Basic Auth”、“AES”和“Public Key”。 在实例的配置参数中开启“public_k