网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
企业路由器 ER
企业交换机 ESW
全球加速 GA
企业连接 EC
云原生应用网络 ANC
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
威胁检测服务 MTD
态势感知 SA
认证测试中心 CTC
边缘安全 EdgeSec
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
API网关 APIG
分布式缓存服务 DCS
多活高可用服务 MAS
事件网格 EG
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
配置审计 Config
应用身份管理服务 OneAccess
资源访问管理 RAM
组织 Organizations
资源编排服务 RFS
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
解决方案
高性能计算 HPC
SAP
混合云灾备
开天工业工作台 MIW
Haydn解决方案工厂
数字化诊断治理专家服务
云生态
云商店
合作伙伴中心
华为云开发者学堂
华为云慧通差旅
开发与运维
软件开发生产线 CodeArts
需求管理 CodeArts Req
流水线 CodeArts Pipeline
代码检查 CodeArts Check
编译构建 CodeArts Build
部署 CodeArts Deploy
测试计划 CodeArts TestPlan
制品仓库 CodeArts Artifact
移动应用测试 MobileAPPTest
CodeArts IDE Online
开源镜像站 Mirrors
性能测试 CodeArts PerfTest
应用管理与运维平台 ServiceStage
云应用引擎 CAE
开源治理服务 CodeArts Governance
华为云Astro轻应用
CodeArts IDE
Astro工作流 AstroFlow
代码托管 CodeArts Repo
漏洞管理服务 CodeArts Inspector
联接 CodeArtsLink
软件建模 CodeArts Modeling
Astro企业应用 AstroPro
CodeArts盘古助手
华为云Astro大屏应用
计算
弹性云服务器 ECS
Flexus云服务
裸金属服务器 BMS
云手机服务器 CPH
专属主机 DeH
弹性伸缩 AS
镜像服务 IMS
函数工作流 FunctionGraph
云耀云服务器(旧版)
VR云渲游平台 CVR
Huawei Cloud EulerOS
云化数据中心 CloudDC
网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
企业路由器 ER
企业交换机 ESW
全球加速 GA
企业连接 EC
云原生应用网络 ANC
CDN与智能边缘
内容分发网络 CDN
智能边缘云 IEC
智能边缘平台 IEF
CloudPond云服务
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
威胁检测服务 MTD
态势感知 SA
认证测试中心 CTC
边缘安全 EdgeSec
大数据
MapReduce服务 MRS
数据湖探索 DLI
表格存储服务 CloudTable
可信智能计算服务 TICS
推荐系统 RES
云搜索服务 CSS
数据可视化 DLV
数据接入服务 DIS
数据仓库服务 GaussDB(DWS)
数据治理中心 DataArts Studio
湖仓构建 LakeFormation
智能数据洞察 DataArts Insight
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
API网关 APIG
分布式缓存服务 DCS
多活高可用服务 MAS
事件网格 EG
开天aPaaS
应用平台 AppStage
开天企业工作台 MSSE
开天集成工作台 MSSI
API中心 API Hub
云消息服务 KooMessage
交换数据空间 EDS
云地图服务 KooMap
云手机服务 KooPhone
组织成员账号 OrgID
云空间服务 KooDrive
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
配置审计 Config
应用身份管理服务 OneAccess
资源访问管理 RAM
组织 Organizations
资源编排服务 RFS
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
区块链
区块链服务 BCS
数字资产链 DAC
华为云区块链引擎服务 HBS
解决方案
高性能计算 HPC
SAP
混合云灾备
开天工业工作台 MIW
Haydn解决方案工厂
数字化诊断治理专家服务
价格
成本优化最佳实践
专属云商业逻辑
云生态
云商店
合作伙伴中心
华为云开发者学堂
华为云慧通差旅
其他
管理控制台
消息中心
产品价格详情
系统权限
客户关联华为云合作伙伴须知
公共问题
宽限期保留期
奖励推广计划
活动
云服务信任体系能力说明
开发与运维
软件开发生产线 CodeArts
需求管理 CodeArts Req
流水线 CodeArts Pipeline
代码检查 CodeArts Check
编译构建 CodeArts Build
部署 CodeArts Deploy
测试计划 CodeArts TestPlan
制品仓库 CodeArts Artifact
移动应用测试 MobileAPPTest
CodeArts IDE Online
开源镜像站 Mirrors
性能测试 CodeArts PerfTest
应用管理与运维平台 ServiceStage
云应用引擎 CAE
开源治理服务 CodeArts Governance
华为云Astro轻应用
CodeArts IDE
Astro工作流 AstroFlow
代码托管 CodeArts Repo
漏洞管理服务 CodeArts Inspector
联接 CodeArtsLink
软件建模 CodeArts Modeling
Astro企业应用 AstroPro
CodeArts盘古助手
华为云Astro大屏应用
存储
对象存储服务 OBS
云硬盘 EVS
云备份 CBR
高性能弹性文件服务 SFS Turbo
弹性文件服务 SFS
存储容灾服务 SDRS
云硬盘备份 VBS
云服务器备份 CSBS
数据快递服务 DES
云存储网关 CSG
专属分布式存储服务 DSS
数据工坊 DWR
地图数据 MapDS
键值存储服务 KVS
容器
云容器引擎 CCE
云容器实例 CCI
容器镜像服务 SWR
云原生服务中心 OSC
应用服务网格 ASM
华为云UCS
数据库
云数据库 RDS
数据复制服务 DRS
文档数据库服务 DDS
分布式数据库中间件 DDM
云数据库 GaussDB
云数据库 GeminiDB
数据管理服务 DAS
数据库和应用迁移 UGO
云数据库 TaurusDB
人工智能
AI开发平台ModelArts
华为HiLens
图引擎服务 GES
图像识别 Image
文字识别 OCR
自然语言处理 NLP
内容审核 Moderation
图像搜索 ImageSearch
医疗智能体 EIHealth
企业级AI应用开发专业套件 ModelArts Pro
人脸识别服务 FRS
对话机器人服务 CBS
语音交互服务 SIS
人证核身服务 IVS
视频智能分析服务 VIAS
城市智能体
自动驾驶云服务 Octopus
盘古大模型 PanguLargeModels
IoT物联网
设备接入 IoTDA
全球SIM联接 GSL
IoT数据分析 IoTA
路网数字化服务 DRIS
IoT边缘 IoTEdge
设备发放 IoTDP
企业应用
域名注册服务 Domains
云解析服务 DNS
企业门户 EWP
ICP备案
商标注册
华为云WeLink
华为云会议 Meeting
隐私保护通话 PrivateNumber
语音通话 VoiceCall
消息&短信 MSGSMS
云管理网络
SD-WAN 云服务
边缘数据中心管理 EDCM
云桌面 Workspace
应用与数据集成平台 ROMA Connect
ROMA资产中心 ROMA Exchange
API全生命周期管理 ROMA API
政企自服务管理 ESM
视频
实时音视频 SparkRTC
视频直播 Live
视频点播 VOD
媒体处理 MPC
视频接入服务 VIS
数字内容生产线 MetaStudio
迁移
主机迁移服务 SMS
对象存储迁移服务 OMS
云数据迁移 CDM
迁移中心 MGC
专属云
专属计算集群 DCC
开发者工具
SDK开发指南
API签名指南
DevStar
华为云命令行工具服务 KooCLI
Huawei Cloud Toolkit
CodeArts API
云化转型
云架构中心
云采用框架
用户服务
账号中心
费用中心
成本中心
资源中心
企业管理
工单管理
客户运营能力
国际站常见问题
支持计划
专业服务
合作伙伴支持计划
我的凭证
华为云公共事业服务云平台
工业软件
工业数字模型驱动引擎
硬件开发工具链平台云服务
工业数据转换引擎云服务

通过APIG创建GRPC API

更新时间:2025-01-24 GMT+08:00
分享

API网关支持创建GRPC API。gRPC是RPC(远程过程调用)的一种,只需定义每个API的Request和Response,剩下的gRPC框架就可以完成。它的典型特征就是使用protobuf(protocol buffers)作为其接口定义语言(Interface Definition Language,缩写IDL),同时底层的消息交换格式也是使用protobuf。下表列出了GRPC API与REST API的区别:

表1 GRPC 和 REST区别

参数

GRPC

REST

消息编码

protobuf

JSON

传输协议

HTTP/2

HTTP

传输性能

传输内容少,速度快

传输内容多

传输形式

  • 简单 RPC(Unary RPC)

    发送单个请求,接收单个响应。

  • 服务端流式 RPC (Server streaming RPC)

    发送单个请求,接收多个响应。

  • 客户端流式 RPC (Client streaming RPC)

    发送多个请求,接收单个响应。

  • 双向流式 RPC(Bi-directional streaming RPC)

    发送多个请求,接收多个响应。

发送单个请求,接收单个响应。

当您的客户端和服务端都为GRPC类型时,可以通过创建GRPC类型的API来开放后端能力。GRPC适用于内部服务的调用,性能消耗低,传输率高,便于服务治理。

约束与限制

  • 不支持API管理模块中的导入导出API功能、导入API设计文件、导入CSE微服务功能、导入CCE工作负载功能、调试API功能。
  • 不支持后端降级策略中后端策略类型为Mock、HTTP&HTTPS、FunctionGraph的断路器策略。
  • 不支持Base64编码配置。
  • 不支持参数编排。

前提条件

  • 已创建API分组。如果未创建API分组,请创建API分组
  • 如果后端服务需要使用负载通道,请创建负载通道
  • 后端服务已定义proto文件,即在proto文件中定义API的Request和Response。proto文件是用于定义数据结构和服务接口的文件,通常在gRPC中使用。它基于Protobuf语言,用于描述数据的结构和交互方式,充当客户端和后端服务之间通信的合同。

创建GRPC API

  1. 进入API网关控制台页面。
  2. 根据实际业务在左侧导航栏上方选择实例。
  1. 在左侧导航栏选择“API管理 > API分组”。
  2. 单击分组名称,进入“分组信息”页面。
  3. 在“API运行”页面,单击“创建API > 创建GRPC API”。

    1. 根据下表参数信息,配置前端定义。
      创建API时,当API所属分组、请求方法、请求路径、匹配模式都重复时,API无法创建成功。
      表2 前端定义

      参数

      说明

      API名称

      API名称,根据规划自定义。建议您按照一定的命名规则填写API名称,方便您快速识别和查找。

      支持中文、英文、数字、中划线、下划线、点、斜杠、中英文格式下的小括号和冒号、中文格式下的顿号,且只能以英文、汉字和数字开头,长度为3~255个字符。

      所属分组

      API所属的分组。选择已有的分组,如果需要新建分组,单击“新建分组”即可创建。

      URL

      前端地址由请求方法、请求协议、子域名和路径组成。

      • 请求方法:默认为POST。
      • 请求协议:默认为GRPCS.。
      • 子域名:所在分组的调试域名。
      • 路径:需要根据实际业务从以下三种配置方式中选择配置。
        • /
        • /{包名}.{服务名}
        • /{包名}.{服务名}/{方法名}
        说明:
        • 包名、服务名、方法名从proto文件中获取。
        • 当前端路径设置“/{包名}.{服务名}/{方法名}”时,API的匹配模式才可以使用“绝对匹配”。

      网关响应

      网关响应指未能成功处理API请求,从而产生的错误响应。

      API网关提供默认的网关响应(default)。如果您需要自定义响应状态码或网关响应内容,可在API分组管理中新增网关响应,其中响应内容符合JSON格式即可。

      匹配模式

      选择API请求路径的匹配模式。

      • 绝对匹配:API请求中的请求路径要与“路径”的配置一致。
      • 前缀匹配:API请求中的请求路径要以“路径”的配置为前缀。前缀匹配支持接口定义多个不同Path。

        例如,“路径”为/test/AA,使用前缀匹配时,通过/test/AA/BB和/test/AA/CC都可以访问API,但是通过/test/AACC无法访问。

      说明:
      • 使用前缀匹配时,匹配剩余的路径将透传到后端。

        例如,使用前缀匹配,前端请求路径定义为/test/,后端请求路径定义为/test2/,通过/test/AA/CC访问API,则后端收到的请求url为/test2/AA/CC。

      • 使用前缀匹配时,以最长路径优先规则匹配。

        例如,两个API都开启前缀匹配,“路径”为/test/AA和/test/AA/BB,请求/test/AA/BB/c会匹配路径为/test/AA/BB的API。

      • 当两个API的所属分组、请求方法、请求路径都相同时,优先调用匹配模式为绝对匹配的API。

      标签

      标签主要用于对API添加分类属性,方便在创建了大量API后,快速过滤和查找。

      支持英文,数字,中文,_-*#%.:,且只能以英文,中文开头,长度为1~128个字符。支持输入多个标签,不同标签以英文逗号分隔。

      描述

      API的描述,长度为1~1000个字符。

      请求体内容描述

      填写API请求中请求体的描述信息,用于帮助API调用者理解如何正确封装API请求。

    2. 根据下表参数信息,配置安全配置。
      表3 安全配置

      参数

      说明

      类型

      API类型:

      • 公开:选择“公开”类型时,API支持上架。
      • 私有:选择“私有”类型时,当该API所在分组上架时,该API不会上架。

      安全认证

      API认证方式:

      • APP认证:表示由API网关服务负责接口请求的安全认证。推荐使用APP认证方式。
      • 华为IAM认证:表示借助IAM服务进行安全认证。
      • 自定义认证:用户有自己的认证系统或服务(如使用OAuth认证),可选择“自定义认证”。
      • 无认证:表示不需要认证。API网关对收到的调用请求不做身份认证,只需要按照API提供者提供的接口说明,封装规范的请求,发送给API网关即可。

        API网关把请求内容透传给后端服务。因此,如果您希望在API后端服务进行鉴权,可以使用“无认证”方式,API调用方传递鉴权所需字段给后端服务,由后端服务进行鉴权。

      各种认证方式下的API调用稍有不同,具体请参考调用APIG开放的API

      须知:
      • 认证方式为华为IAM认证时,任何API网关租户均可以访问此API,可能存在恶意刷流量,导致过量计费的风险。
      • 认证方式为无认证时,任何公网用户均可以访问此API,可能存在恶意刷流量,导致过量计费的风险。
      • 认证方式为自定义认证时,需要在函数服务中写一段函数,对接用户自己的认证系统或服务。如果当前Region没有上线函数工作流服务,则不支持自定义认证。

      支持简易认证

      仅当“安全认证”选择“APP认证”时可配置

      简易认证指APP认证方式下调用API时,在GRPC请求头部消息增加一个参数X-Apig-AppCode,而不需要对请求内容签名,API网关也仅校验AppCode,不校验请求签名,从而实现快速响应。

      注意支持GRPCS方式调用,不支持GRPC方式。具体使用请参考配置APIG的API简易认证AppCode

      说明:

      如果首次创建API未开启简易认证,那么之后开启简易认证,需要重新发布API。请参考发布APIG创建的API发布。

      支持双重认证

      仅当“安全认证”选择“APP认证”或“华为IAM认证”时可配置

      是否对API的调用进行双重安全认证。如果选择启用,则在使用APP认证或IAM认证对API请求进行安全认证时,同时使用自定义的函数API对API请求进行安全认证。

      自定义认证

      仅当“安全认证”选择“自定义认证”时需要配置

      选择已创建的前端类型自定义认证。若没有可用的自定义认证,可单击右侧的“新建自定义认证”,创建一个前端类型的自定义认证。

      支持跨域CORS

      是否开启跨域访问CORS(cross-origin resource sharing)。

      CORS允许浏览器向跨域服务器,发出XMLHttpRequest请求,从而克服了AJAX只能同源使用的限制。

      CORS请求分为两类:

      • 简单请求:头信息之中,增加一个Origin字段。
      • 非简单请求:在正式通信之前,增加一次GRPC查询请求。

      开启CORS(非简单请求)时,您需要单独创建一个“请求方法”为“OPTIONS”的API,具体操作请参考开启跨域访问

  4. 单击“下一步”,配置后端服务。
  5. 定义默认后端。

    添加策略后端前必须定义一个默认后端,当不满足任何一个策略后端的API请求,都将转发到默认的API后端。

    在“后端配置”页面,选择API后端服务类型。

    后端服务类型有表4表5

    说明:

    FunctionGraph依赖于函数工作流服务FunctionGraph,如果当前环境中未部署FunctionGraph服务,则后端服务类型FunctionGraph不可用。

    GRPC API的后端FunctionGraph类型,当前仅贵阳一、上海一、北京四、上海二、圣地亚哥区域支持。

    表4 GRPC&GRPCS类型定义后端服务

    参数

    说明

    负载通道

    是否使用负载通道访问后端服务。

    URL

    URL地址由请求方法、请求协议、负载通道/后端服务地址和路径组成。

    • 请求方法

      默认为POST。

    • 请求协议

      支持“GRPC”或“GRPCS”。定义的后端服务协议须与用户的后端业务协议保持一致。

    • 负载通道

      仅在使用负载通道时,需要设置。选择已创建的负载通道名称,或者新建负载通道

      负载通道中,云服务器的安全组必须允许100.125.0.0/16网段访问,否则将导致健康检查失败及业务不通。

    • 后端服务地址

      仅在不使用负载通道时,需要设置

      填写后端服务的访问地址,格式:“主机:端口”。主机为后端服务的访问IP地址/域名;端口为后端服务的端口。未指定端口时,GRPC协议默认使用80端口,GRPCS协议默认使用443端口。

      如果后端服务地址中需要携带环境变量,则使用“#变量名#”的形式将环境变量添加到后端服务地址中,如#ipaddress#。支持添加多个环境变量,如#ipaddress##test#。

      说明:

      IP地址/域名可以是公网IP(支持云服务器的弹性IP地址、用户自己服务器的公网IP地址、ELB地址)/公网域名,前提需要开启实例的公网出口。可以是内网的IP,不可以是内网域名。

      2022年10月30日后创建的实例支持APIG与后端服务tls握手阶段向后端服务传SNI。

    • 路径

      后端服务的路径,即服务的uri,可以包含路径参数,以{路径参数}形式表示,比如/getUserInfo/{userId}。

      如果请求路径中含有环境变量,则使用#变量名#的方式将环境变量定义到请求路径中,如/#path#。支持创建多个环境变量,如/#path##request#。

    说明:
    • 在URL中配置了变量标识后,在API调试页面将无法调试。
    • 如果在URL中设置变量,那么必须在待发布环境上配置变量名和变量值,否则变量无法赋值,API将无法正常调用。
    • 变量名严格区分大小写。

    自定义host头域

    仅在使用负载通道时,可设置

    自定义后端服务请求中的Host头域,默认将使用请求中原始的host头域。

    后端超时(ms)

    后端服务请求的超时时间,可填写范围1ms~60000ms。

    • 如果在API调试过程中,遇到后端响应超时之类的错误,请适当调大后端超时时间,以便排查原因。
    • 如果当前的超时时间范围不能满足实际业务需求,请在实例配置参数中修改超时时间上限,可修改范围为1ms~600000ms。如果您修改了超时时间上限,需要同步修改此处的超时时间。

    重试次数

    后端服务请求失败后的重试次数,默认值为0,取值范围-1~10。

    • 值为-1时,表示不开启重试功能,但除POST和PATCH外的其他请求类型会默认重试1次。
    • 值为0~10时,表示开启重试功能,并根据设置的值执行重试。当值为0时,不重试。

    使用负载通道时,重试次数应小于负载通道中已启用的后端服务器个数。

    TLS双向认证

    仅在协议为“GRPCS”时,可设置。

    选择是否在API网关和后端服务间启用双向认证,如果选择“使用backend_client_certificate配置的证书做客户端认证”,您需在实例的配置参数中提前配backend_client_certificate证书。

    后端认证

    当您的后端服务需要对API调用增加自己的认证,则开启后端认证。

    后端认证需要先添加一个自定义认证,自定义认证通过函数服务实现,在函数服务中编写一个函数,实现您的认证鉴权流程,或者使用函数调用您的统一鉴权服务。

    说明:

    后端认证依赖函数服务,此功能仅在部分区域开放。

    表5 FunctionGraph类型定义后端服务

    参数

    说明

    函数名

    添加函数后,函数名自动生成。

    函数URN

    函数请求唯一标识。

    单击“添加”,添加所需的函数URN。

    版本或别名

    选择函数的版本或别名,函数的版本或别名功能请参考版本管理章节或别名管理章节。

    调用类型

    默认为Synchronous,同步调用。指后端函数服务收到调用请求后立即执行并返回调用结果,客户端发送请求后同步等待,收到后端响应后关闭连接。

    后端超时(ms)

    后端服务请求的超时时间,可填写范围1ms~60000ms。

    • 如果在API调试过程中,遇到后端响应超时之类的错误,请适当调大后端超时时间,以便排查原因。
    • 如果当前的超时时间范围不能满足实际业务需求,请在实例配置参数中修改超时时间上限,可修改范围为1ms~600000ms。如果您修改了超时时间上限,需要同步修改此处的超时时间。

    后端认证

    当您的后端服务需要对API调用增加自己的认证,则开启后端认证。

    后端认证需要先添加一个自定义认证,自定义认证通过函数服务实现,在函数服务中编写一个函数,实现您的认证鉴权流程,或者使用函数调用您的统一鉴权服务。

    说明:

    后端认证依赖函数服务,此功能仅在部分区域开放。

  6. (可选)添加策略后端。

    添加多个后端策略后,通过不同的策略条件,请求被转发到不同的后端服务中。

    1. 单击添加策略后端。
    2. 后端策略增加的参数,具体如表6所示,其他参数说明参考表4表5
      表6 后端策略参数

      参数

      说明

      后端策略名称

      您自定义的名称,用于识别不同的后端策略。

      支持英文、数字、下划线和中划线,只能以英文字母开头,长度为3-64个字符。

      生效方式

      选择策略后端的生效方式。

      • 满足任一条件:只要满足策略条件中的任意一项,此后端策略就可以生效。
      • 满足全部条件:只有满足所有的策略条件,此后端策略才生效。

      策略条件

      添加后端策略生效的条件,具体如表7所示。

      表7 策略条件

      参数

      说明

      条件来源

      策略条件中判断条件的来源。

      • 源地址:以访问API的请求地址作为策略条件来源。
      • 请求入参:以请求入参参数作为策略条件来源。
      • Cookie:表示以API请求的Cookie信息作为判断条件。
      • 系统参数:以网关内置参数作为策略条件来源。网关内置参数指API网关处理API请求时的系统运行时参数信息。
      须知:
      • 选择“请求入参”作为策略条件时,入参需要在API前端请求中配置好,如在Header中添加一个参数。
      • 如果未展示“系统参数”请联系技术支持升级实例。

      参数名称

      • 当“条件来源”为“请求入参”时,需要设置。选择已创建的入参参数名称。
      • 当“条件来源”为“系统参数”时,需要选择参数名称。
        • reqPath:请求URI,如“/a/b/c”。
        • reqMethod:请求方法,如“GET”。
      • 当“条件来源”为“COOKIE”时,需要填写Cookie中的参数名称。

      参数位置

      仅在“条件来源”为“请求入参”时,展示请求入参的参数位置。

      条件类型

      仅在“条件来源”为“请求入参”、“系统参数”、“COOKIE”时需要配置。

      • 相等:请求参数值必须为输入值时,条件成立。
      • 枚举:请求参数值只需要和枚举值中任何一个值相同,条件成立。
      • 匹配:请求参数值只需要和正则表达式中任何一个值相同,条件成立。
      说明:

      当“条件来源”为“系统参数”并且“参数名称”为“reqMethod”时,“条件类型”仅支持选择相等或枚举。

      条件值

      填写判断条件的值,条件值的长度为1~1024个字符。

      • “条件类型”为“相等”时,输入一个值。
      • “条件类型”为“枚举”时,输入多个值,以英文逗号隔开。
      • “条件类型”为“匹配”时,输入一个范围,例如:[0-5]。
      • “条件来源”为“源地址”时,输入一个或多个IP地址,以英文逗号隔开。
      • “条件来源”为“系统参数-前端认证参数”时,且当条件值填写boolean类型时,需全部小写。

  7. 单击“完成”,进入“API运行”页面,可查看API详情。
文档反馈

文档反馈

意见反馈

0/500

标记内容

同时提交标记内容