华为云用户手册

规则说明 2020年10月16日前，未在CodeArts某个区域下产生过费用的用户，按照新版计费规则，需在该区域开通/购买CodeArts或单独购买需求管理服务后使用。 在该区域内产生过费用的用户，延续旧版计费规则，可参考购买服务在该区域开通需求管理服务包年/包月套餐。 例如： 用户于2020年3月在“华北-北京四”购买了半年期的包月套餐。由于疫情影响业务，套餐到期后关闭了CodeArts服务；2020年10月20日将重新启用CodeArts。 如果用户仍使用“华北-北京四”，可以购买旧版套餐使用。 如果用户使用其它区域，则需购买CodeArts或者需求管理服务新版计费。

购买须知 在CodeArts支持的区域内，各区域独立开通购买、独立计费。 您可以需求管理单服务套餐，或者开通/购买软件开发生产线服务组合套餐，体验一站式、全流程、安全可信的软件开发生产线。 购买需求管理服务需要您拥有租户账号，或拥有Tenant Administrator权限的 IAM 用户账号，配置权限策略方法请参考创建用户组并授权。 如果已经购买了CodeArts套餐，则不能再单独购买需求管理服务。

包年/包月资源 对于包年/包月计费模式的资源，例如包年/包月的需求管理服务、包年/包月的云硬盘等，用户在购买时会一次性付费，服务将在到期后自动停止使用。 如果在计费周期内不再使用包年/包月需求管理服务，您可以执行退订操作。需求管理服务套餐、资源扩展支持退订。系统将根据资源是否属于五天无理由退订、是否使用代金券和折扣券等条件返还一定金额到您的账户。详细的退订规则请参见云服务退订规则概览。 如果您已开启“自动续费”功能，为避免继续产生费用，请在自动续费扣款日（默认为到期前7日）之前关闭自动续费。

资源扩展 需求管理服务提供单独的存储扩展，允许需求管理服务的基础版、专业版套餐在资源不足的时候购买。 表1 知识库存储扩展 计费方式 包年/包月 适用场景 当需求管理服务中包含的知识库文件存储容量不满足实际使用需求时，可购买知识库存储扩展。 计费项 存储容量（GB） 购买限制 购买知识库存储扩展前，须完成需求管理服务基础版及以上规格套餐的购买。 10GB起购，步长10GB，购买上限为1000GB。 计费公式 单价*存储容量*购买时长 计费周期 根据购买时长确定（以GMT+08:00时间为准）。一个计费周期的起点是您开通或续费知识库存储扩展的时间（精确到秒），终点则是到期日的23:59:59。 例如，您在2023/03/08 15:50:04购买时长为一个月的知识库存储扩展，那么计费周期为：2023/03/08 15:50:04 ~ 2023/04/08 23:59:59。 变更配置 支持变更存储容量，变更时系统将按照如下规则为您计算变更费用。 资源升配：变更后的存储容量高于变更前，此时您需要支付新老配置的差价。 资源降配：变更后的存储容量低于变更前，此时华为云会将新老配置的差价退给您。 更多信息请参见变更资源规格费用说明。 到期后影响 到期未续费时，已购知识库存储扩展将失效。 父主题： 计费模式

续费相关的功能 包年/包月需求管理服务续费相关的功能如表1所示。 表1 续费相关的功能 功能 说明 手动续费 包年/包月需求管理服务从购买到被自动删除之前，您可以随时在需求管理服务控制台进行续费，以延长需求管理服务的使用时间。 自动续费 开通自动续费后，需求管理服务会在每次到期前自动续费，避免因忘记手动续费而导致资源被自动删除。 在包年/包月需求管理服务生命周期的不同阶段，您可以根据需要选择一种方式进行续费，具体如图1所示。 图1 需求管理服务生命周期 需求管理服务从购买到到期前，处于正常运行阶段，套餐状态为“正常”。 到期后，套餐状态变为“已过期”。 到期未续费时，需求管理服务首先会进入宽限期，宽限期到期后仍未续费，套餐状态变为“保留”。 超过宽限期仍未续费将进入保留期，如果保留期内仍未续费，资源将被自动删除。 华为云根据客户等级定义了不同客户的宽限期和保留期时长。 在需求管理服务到期前均可开通自动续费，到期前7日凌晨3:00首次尝试自动续费，如果扣款失败，每天凌晨3:00尝试一次，直至需求管理服务到期或者续费成功。到期前7日自动续费扣款是系统默认配置，您也可以根据需要修改此扣款日。

相关操作 有关主机扫描得分的计算方法参考如下： 扫描任务被创建后，初始得分是一百分，任务扫描完成后，根据扫描出的漏洞级别会扣除相应的分数。 主机评分 = 100分 – 高危漏洞数 * 3分/个 – 中危漏洞数 * 2分/个 – 低危漏洞数 * 1分/个。每类漏洞最多计算20个。 得分越高，表示漏洞数量越少，主机越安全。 如果得分偏低，请根据实际情况对漏洞进行忽略标记，或根据修复建议修复漏洞。 漏洞修复后，建议重新扫描一次查看修复效果。 有关修复主机漏洞的详细介绍，请参见如何修复扫描出来的主机漏洞？。

集群跨VPC绑定ELB前提条件 开启ELB跨VPC后端 登录弹性负载均衡管理控制台。 在弹性负载均衡列表选择实例类型为独享型且规格为网络型的弹性负载均衡，单击弹性负载均衡名称进入详情页面。 在基本信息页面选择开启“跨VPC后端”，确认无误后，单击“确定”。 开启后用户需查看所属VPC与子网网段。 打通集群VPC与ELB所属VPC网络(该案例展示使用对等连接的方式打通网络，用户还可用其他方式打通) 登录 GaussDB (DWS)管理控制台。 单击“集群管理”。默认显示用户所有的集群列表。 在集群列表中，单击指定集群名称进入“集群详情”页面，在集群详情界面查看集群所在VPC与子网网段。 登录虚拟私有云管理控制台，在左侧导航栏选择“我的VPC”，找到需要建立对等连接的VPC。 在虚拟私有云左侧导航栏下选择“对等连接”，在页面右上角单击“创建对等连接”。 在弹出页面中选择“本端VPC”为集群VPC，“对端VPC”为ELB所在VPC，确认无误后，单击“确定”。 创建成功后单击“查看路由”添加路由信息。 单击创建后的对等连接名称，进入对等连接基本信息页面，切换至“本端路由”页签，单击“路由表”选择需要添加的路由表（集群所在VPC的路由表）并单击“添加路由”。 在本端路由表中添加“目的地址”为ELB所在VPC的子网网段，“下一跳类型”为“对等连接”，“下一跳”选择已创建好的对等连接，单击“确定”创建路由。 再次进入创建好的对等连接基本信息页面，切换至“对端路由”页签，单击“路由表”选择需要添加的路由表（ELB所在VPC的路由表）并单击“添加路由”。 在对端路由表中添加“目的地址”为集群所在VPC的子网网段，“下一跳类型”为“对等连接”，“下一跳”选择已创建好的对等连接，单击“确定”创建路由。 创建完毕后集群所在VPC与ELB所在VPC网络已打通，可查看绑定ELB步骤进行绑定。

解绑ELB 登录GaussDB(DWS) 管理控制台。 单击“集群管理”。默认显示用户所有的集群列表。 在集群列表中，单击指定集群名称进入“集群详情”页面。 单击“解绑弹性负载均衡”，进行ELB解绑操作。 解绑命令下发成功后，返回集群管理页面，集群列表显示“弹性负载均衡服务解绑中”任务信息，解绑需要一定时间，请耐心等待。 进入负载均衡服务控制台，单击解绑的ELB名称，切换到“后端服务器”页签，检查集群CN节点是否已被删除。

创建自定义应用事件源 登录事件网格控制台。 在左侧导航栏选择“事件源”，进入“事件源”页面。 单击“自定义事件源”，弹出“创建自定义事件源”对话框。 参考表1，填写自定义事件源的配置信息。 表1 自定义应用事件源参数说明 参数名称 说明 事件源名称 您自定义的事件源名称，用于识别不同的事件源。 事件源创建成功后，事件源名称不支持修改。 描述（可选） 事件源的描述信息。 事件源类型 事件源类型，选择“自定义应用”。 单击“确定”，完成自定义应用事件源的创建。 创建成功后，在“自定义事件源”页签，查看创建的事件源。 如果需要修改自定义事件源的描述信息，单击待修改事件源后的“编辑”，在弹出的对话框中编辑描述及相关参数信息。 如果需要查看自定义事件源的信息，单击待查看信息的事件源名称，在弹出的对话框中查看自定义事件源信息。 如果发送事件界面配置的事件源为新事件源（事件源列表查询不到），发送事件后，无法在 CES 服务监控里查询到监控信息。

快速部署 本章节主要帮助用户快速部署该解决方案。 表1 参数填写说明（入门版） 参数名称 类型 是否必填 参数解释 默认值 ga_name string 必填 全球加速实例名称，该模板新建GA，不允许重名。取值范围：1-64个字符，支持数字、字母、中文、_(下划线)。 global-accelerator-for-cross-border-e-commerce area string 必填 加速区域。支持选择“中国大陆以外”（OUTOFCM）或“中国大陆”(CM)，默认选择“中国大陆”。 CM region_id list 必填 区域ID。终端节点组所属的区域，每个区域对应code请见表3 地区代码。 ["cn-north-4","cn-east-3"] region_ips_map list 必填 控制每个终端节点组下的终端节点个数。例如region_id为[cn-north-4,cn-east-3]，则填写北京4指代0，上海1指代为1。如北京4下有3个后端节点，上海1下有1个后端节点，则填写[0,0,0,1]。默认为[0,1]。 [0, 1] resource_id list 必填 客户端请求访问的目标后端服务器关联的公网ID。最多支持绑定10个ID。后端服务器ID需按region_ips_map的顺序填写，具体请参考部署指南。 无 ip_address list 必填 客户端请求访问的目标后端服务器关联的公网IP。最多支持绑定10个IP。后端服务器IP需按region_ips_map的顺序填写，具体请参考部署指南。 无 protocol string 必填 指定监听器转发请求所使用的协议。取值可以是TCP或UDP。 TCP from_port list 必填 监听器监听的起始端口。取值范围在1-65535之间。目前支持填写一个端口。目前只支持监听单端口，from_port和to_port需要为同一值。 无 to_port list 必填 监听器监听的终止端口。取值范围在1-65535之间。目前只支持监听单端口，from_port和to_port需要为同一值。 无 表2 参数填写说明（进阶版） 参数名称 类型 是否必填 参数解释 默认值 region_ids string 必填 区域ID。弹性云服务器所属的区域，每个区域对应code请见地区和终端节点官网。 ['cn-north-4','cn-south-1'] ecs_volume_type string 必填 系统盘类型。云服务器系统盘对应的磁盘类型。需要与系统所提供的磁盘类型相匹配。取值范围：SATA：普通IO磁盘类型。SAS：高IO磁盘类型。SSD：超高IO磁盘类型。GPSSD：为通用型SSD磁盘类型。co-p1：高IO (性能优化I型)。uh-l1：超高IO (时延优化)。ESSD：为极速IO磁盘类型。GPSSD2：通用型SSD V2磁盘类型。ESSD2：极速型SSD V2磁盘类型。 'SSD' ecs_admin_pass string 必填 密码。登录弹性云服务器的密码。长度为8-26位。密码至少必须包含大写字母、小写字母、数字和特殊字符（!@$%^-_=+[{}]:,./?）中的三种。不能包含用户名或用户名的逆序，不能包含用户名中超过两个连续字符的部分。需要将密码填写在"内。 无 ecs_count string 必填 弹性云服务器数量。每个region和每个可用区内创建的弹性云服务器的个数。每个子列表代表一个region，子列表内的值代表每个region下每个可用区的云服务器数量。例如，[1,1]表示北京四的可用区1和可用区2各创建一个弹性云服务器。 [[1, 1], [1, 1]] ecs_flavor_ref string 必填 系统规格。待创建云服务器的系统规格的ID。可通过 规格列表接口查询，该接口支持通过availability_zone参数过滤出待创建云服务器可用区下可用的规格。 's6.xlarge.2' ecs_image_ref string 必填 镜像规格。待创建云服务器的系统镜像。需要指定已创建镜像的ID，ID格式为通用唯一识别码(Universally Unique Identifier,简称UUID)。镜像的ID可以从 镜像服务 的查询镜像列表接口获取，该接口可根据 __imagetype、__os_type 等参数过滤选择合适镜像。 每个region指定一个镜像，例如f4a6e420-49e0-4e99-aa59-02756805c141对应cn-north-4。 ['f4a6e420-49e0-4e99-aa59-02756805c141', '45612c2e-27ce-49ec-9b51-a3d580e687fd'] eip_type string 必填 弹性公网IP类型。具体类型请参考EIP官方文档。 '5_bgp' elb_protocol string 必填 监听协议。取值范围：TCP、HTTP、UDP、TERMINATED_HTTPS。客户端与负载均衡监听器建立流量分发连接的协议。 'TCP' elb_protocol_port string 必填 监听端口。取值范围[1，65535]。客户端与负载均衡监听器建立流量分发连接的监听端口。如果监听协议为UDP,端口号不支持4789。 80 elb_algorithm string 必填 分配策略类型。后端云服务器组的负载均衡算法。取值：ROUND_ROBIN：加权轮询算法；LEAST_CONNECTIONS：加权最少连接算法；SOURCE_IP：源IP算法；当该字段的取值为SOURCE_IP时，后端云服务器组绑定的后端云服务器的weight字段无效。 'ROUND_ROBIN' elb_member_protocol_port string 必填 端口号。后端云服务器自身提供的协议的端口号。取值范围[1，65535]。如使用Windows操作系统上安装的IIS（webservice），该服务默认的协议为HTTP，端口为80。 80 ga_area string 必填 加速区域。支持选择“中国大陆以外”（OUTOFCM）或“中国大陆”(CM)，默认选择“中国大陆”。 'CM' ga_protocol string 必填 GA监听协议。指定GA监听器转发请求所使用的协议。取值可以是TCP或UDP。 'TCP' ga_port_list string 必填 GA监听的端口号或端口范围。如果是单个数值可填[[80, 80]]，范围值可填[[80,88]]。 [[80, 80]] ga_endpoint_group string 必填 终端节点组名称。只允许使用字母、数字和连字符(-)。长度范围：1-64个字符。 ['group1', 'group2'] ga_healthcheck_port string 必填 健康检查端口号。取值范围：[1，65535]。 80 identity_agency_name string 必填 委托名称。在IAM服务中创建的委托名称，用于 函数工作流 服务创建方案所需要的资源。与现有委托不可重名。此变量不需在"内。取值范围：4-64个字符，以字母开头，支持数字、字母、_（下划线）、（中划线）。 agency_for_all 入门版快速部署步骤 登录华为云解决方案实践，选择“基于GA的跨境电商加速”解决方案。单击“一键部署（入门版）”，跳转至解决方案创建堆栈界面。 图1 解决方案实施库 在选择模板界面中,单击“下一步”。 图2 选择模板 在配置参数界面中，参考表1完成自定义参数填写，单击“下一步”。 图3 配置参数 在资源栈设置页面中，权限委托选择“rf_admin_trust”(可选)，单击“下一步”。 图4 资源栈设置 在配置确认页面中，单击“创建执行计划”。 图5 配置确认 在弹出的创建执行计划框中，自定义填写执行计划名称，单击“确定”。 图6 创建执行计划 待执行计划状态为“创建成功，待部署”后，单击“部署”，并且在弹出的执行计划确认框中单击“部署”。 图7 执行计划 图8 执行计划确认 等待解决方案自动部署。部署成功后，单击“事件”，回显结果如下: 图9 资源创建成功 进阶版快速部署步骤 登录华为云解决方案实践，选择“基于GA的跨境电商加速”解决方案。单击“一键部署（进阶版）”，跳转至解决方案创建堆栈界面。 图10 解决方案实施库 在选择模板界面中,单击“下一步”。 图11 选择模板 在配置参数界面中，参考表2完成自定义参数填写，单击“下一步”。 图12 配置参数 在资源栈设置页面中，权限委托选择“rf_admin_trust”(可选)，单击“下一步”。 图13 资源栈设置 在配置确认页面中，单击“创建执行计划”。 图14 配置确认 在弹出的创建执行计划框中，自定义填写执行计划名称，单击“确定”。 图15 创建执行计划 待执行计划状态为“创建成功，待部署”后，单击“部署”，并且在弹出的执行计划确认框中单击“部署”。 图16 执行计划 图17 执行计划确认 等待解决方案自动部署。部署成功后，单击“事件”，回显结果如下: 图18 资源创建成功 单击资源可以看见创建好的函数：create_func，delete_func 图19 函数创建成功 单击create_func跳转到函数控制台，使用create_func创建方案所需资源 图20 函数控制台界面，单击测试 部署函数测试事件，选择空白模板，单击创建 图21 函数测试事件 再次单击测试，函数运行 图22 函数运行界面 在监控-日志-请求日志中查看函数运行结果。出现"Finish invoke request"代表函数运行结束 父主题： 实施步骤

快速卸载 入门版快速卸载步骤 解决方案部署成功后，单击该方案堆栈后的“删除” 图1 一键卸载 在弹出的删除堆栈确认框中，输入Delete，单击“确定”，即可卸载解决方案。删除资源大概需要一分钟 图2 删除堆栈确认 进阶版快速卸载步骤 解决方案部署成功后。如果需要删除方案创建的资源。在 资源编排 服务控制台，单击delete_func，跳转到函数控制台界面 图3 资源编排服务界面 在delete_func的函数界面单击测试，使用delete_func删除方案内包含的资源 图4 delete_func函数界面 配置测试事件，选择空白模板，单击创建 图5 配置函数测试事件 再次单击测试，delete_func运行 图6 delete_func运行界面 在监控-日志-请求日志中查看函数运行结果。delete_func运行完成。出现"Finish invoke request"代表函数运行结束 图7 函数运行结束 一键卸载创建的函数和委托。在资源编排服务控制台，单击删除 图8 一键卸载 在弹出的删除堆栈确认框中，输入Delete，单击“确定”，即可卸载解决方案。删除资源大概需要一分钟。 图9 删除堆栈确认 父主题： 实施步骤

x-apigateway-backend-policies.conditions 含义：API网关定义的API后端策略条件。 作用域：x-apigateway-backend-policies 示例： paths: '/users/{userId}': get: produces: - "application/json" responses: default: description: "default response" x-apigateway-request-type: "public" x-apigateway-backend: type: "backend endpoint type" x-apigateway-backend-policies: - type: "backend endpoint type" name: "backend policy name" conditions: - type: "equal/enum/pattern", value: "string", origin: "source/request_parameter", parameter_name: "string" 表1 参数说明 参数 是否必选 类型 说明 type 是 String 策略条件类型，支持equal、enum、pattern value 是 String 策略条件值 origin 是 String 策略条件输入来源，支持source、request parameter 否 String 策略条件输入来源为request时，请求入参的名称 父主题： 扩展定义

x-apigateway-access-controls.policy 含义：访问控制策略定义。 作用域：x-apigateway-access-controls 示例： x-apigateway-access-controls: customAccessControlName: acl-type: "DENY" entity-type: "IP" value: 127.0.0.1,192.168.0.1/16 表1 参数说明 参数 是否必选 类型 说明 acl-type 是 String 访问控制行为，支持PERMIT、DENY entity-type 是 String 访问控制对象，仅支持IP value 是 String 访问控制策略值，多个值以“,”间隔 父主题： 扩展定义

x-apigateway-ratelimits 含义：流控策略名称与关联策略映射。 作用域：Swagger Object 示例： x-apigateway-ratelimits: customRatelimitName: api-limit: 200 app-limit: 200 user-limit: 200 ip-limit: 200 interval: 1 unit: second/minute/hour shared: true special: - type: APP limit: 100 instance: xxxxxxxxx 表1 参数说明 参数 是否必选 类型 说明 customRatelimitName 否 x-apigateway-ratelimits.policy 指定名称的流控策略。 要使用该策略，将x-apigateway-ratelimit属性值引用为该策略名称。 父主题： 扩展定义

x-apigateway-backend.functionEndpoints 含义：API网关定义的FUNCTION类型API后端服务定义。 作用域：x-apigateway-backend 示例： paths: '/users/{userId}': get: produces: - "application/json" parameters: - name: "X-Auth-Token" description: "认证token" type: "string" in: "header" required: true responses: default: description: "default response" x-apigateway-request-type: "public" x-apigateway-backend: type: "FUNCTION" functionEndpoints: version: "v1" function-urn: "" invocation-type: "synchronous" timeout: 30000 表1 参数说明 参数 是否必选 类型 说明 function-urn 是 String 函数URN地址 version 是 String 函数版本 invocation-type 是 String 函数调用类型，支持async、sync timeout 否 Number 函数超时时间，单位毫秒，缺省值为5000，取值范围为1 ~ 60000 父主题： 扩展定义

x-apigateway-backend.parameters 含义：API网关定义的API后端参数定义。 作用域：x-apigateway-backend 示例： paths: '/users/{userId}': get: produces: - "application/json" parameters: - name: "X-Auth-Token" description: "认证token" type: "string" in: "header" required: true - name: "userId" description: "用户名" type: "string" in: "path" required: true responses: default: description: "default response" x-apigateway-request-type: "public" x-apigateway-backend: type: "HTTP" parameters: - name: "userId" value: "userId" in: "query" origin: "REQUEST" description: "用户名" - name: "X-Invoke-User" value: "apigateway" in: "header" origin: "CONSTANT" description: "调用者" 表1 参数说明 参数 是否必选 类型 说明 name 是 String 参数名称，由字母、数字、下划线、连线、点组成，以字母开头，最长32字节 header位置的参数名称不区分大小写 value 是 String 参数值，当参数来源为REQUEST时，值为请求参数名称 in 是 String 参数位置，支持header、query、path origin 是 String 参数映射来源，支持REQUEST、CONSTANT description 否 String 参数含义描述 父主题： 扩展定义

x-apigateway-match-mode 含义：API网关定义的API请求URL的匹配模式，支持NORMAL和SWA。 作用域：Operation Object(2.0)/Operation Object(3.0) 示例： paths: '/path': get: x-apigateway-match-mode: 'SWA' 表1 参数说明 参数 是否必选 类型 说明 x-apigateway-match-mode 是 String API匹配模式，支持SWA和NORMAL。 SWA：前缀匹配，如“/prefix/foo”和“/prefix/bar”都会被“/prefix ”匹配，但“/prefixpart”却不会被匹配。 NORMAL：绝对匹配。 父主题： 扩展定义

x-apigateway-cors 含义：API网关定义的API请求是否支持跨域，boolean类型。 作用域：Operation Object(2.0)/Operation Object(3.0) 示例： paths: '/path': get: x-apigateway-cors: true 表1 参数说明 参数 是否必选 类型 说明 x-apigateway-cors 是 boolean 是否支持开启跨域请求的标识。 true：支持 false：不支持 开启跨域访问的API请求，响应会增加如下头域： 头 域名 称 头域值 描述 Access-Control-Max-Age 172800 预检响应最大缓存时间 单位：s Access-Control-Allow-Origin * 允许任何域。 Access-Control-Allow-Headers X-Sdk-Date，X-Sdk-Nonce，X-Proxy-Signed-Headers，X-Sdk-Content-Sha256，X-Forwarded-For，Authorization，Content-Type，Accept，Accept-Ranges，Cache-Control，Range 正式请求允许的头域 Access-Control-Allow-Methods GET，POST，PUT，DELETE，HEAD，OPTIONS，PATCH 正式请求允许的方法 父主题： 扩展定义

x-apigateway-ratelimits.policy.special 含义：特殊流控策略定义。 作用域：x-apigateway-ratelimits.policy 示例： x-apigateway-ratelimits: customRatelimitName: api-limit: 200 app-limit: 200 user-limit: 200 ip-limit: 200 interval: 1 unit: MINUTE shared: false special: - type: USER limit: 100 instance: xxxxxxxx 表1 参数说明 参数 是否必选 类型 说明 type 是 String 特殊流控策略类型，支持APP、USER limit 是 Number 访问次数 instance 是 String 特殊APP或USER的对象标识 父主题： 扩展定义

x-apigateway-backend.mockEndpoints 含义：API网关定义的MOCK类型API后端服务定义。 作用域：x-apigateway-backend 示例： paths: '/users/{userId}': get: produces: - "application/json" parameters: - name: "X-Auth-Token" description: "认证token" type: "string" in: "header" required: true responses: default: description: "default response" x-apigateway-request-type: "public" x-apigateway-backend: type: "MOCK" mockEndpoints: result-content: "mocked" 表1 参数说明 参数 是否必选 类型 说明 result-content 是 String MOCK返回结果 父主题： 扩展定义

x-apigateway-ratelimit 含义：引用流控策略。 作用域：Operation Object(2.0)/Operation Object(3.0) 示例： paths: '/path': get: x-apigateway-ratelimit: 'customRatelimitName' 表1 参数说明 参数 是否必选 类型 说明 x-apigateway-ratelimit 否 String 流控策略 父主题： 扩展定义

x-apigateway-auth-type 含义：基于Swagger的apiKey认证格式，定义API网关支持的特有认证方式。 作用域：Security Scheme Object(2.0)/Security Scheme Object(3.0) Swagger： securityDefinitions: apig-auth-app: in: header name: Authorization type: apiKey x-apigateway-auth-type: AppSigv1 apig-auth-iam: in: header name: unused type: apiKey x-apigateway-auth-type: IAM OpenAPI示例： securitySchemes: apig-auth-app: in: header name: Authorization type: apiKey x-apigateway-auth-type: AppSigv1 apig-auth-iam: in: header name: unused type: apiKey x-apigateway-auth-type: IAM 表1 参数说明 参数 是否必选 类型 说明 x-apigateway-auth-type 是 String API网关认证方式，支持AppSigv1、IAM type 是 String 认证类型，仅支持apiKey name 是 String 用于认证的参数名称 in 是 String 仅支持header description 否 String 描述信息 父主题： 扩展定义

x-apigateway-backend.httpVpcEndpoints 含义：API网关定义的HTTP VPC类型API后端服务定义。 作用域：x-apigateway-backend 示例： paths: '/users/{userId}': get: produces: - "application/json" parameters: - name: "X-Auth-Token" description: "认证token" type: "string" in: "header" required: true responses: default: description: "default response" x-apigateway-request-type: "public" x-apigateway-backend: type: "HTTP-VPC" httpVpcEndpoints: name: "vpc-test-1" scheme: "http" method: "GET" path: "/users" timeout: 30000 表1 参数说明 参数 是否必选 类型 说明 name 是 Array VPC通道名称 scheme 是 String 后端请求协议定义，支持http、https method 是 String 后端请求方法，支持GET、POST、PUT、DELETE、HEAD、OPTIONS、PATCH、ANY path 是 String 后端请求路径，支持路径变量 timeout 否 Number 后端请求超时时间，单位毫秒，缺省值为5000，取值范围为1 ~ 60000 父主题： 扩展定义

x-apigateway-ratelimits.policy 含义：流控策略定义。 作用域：x-apigateway-ratelimits 示例： x-apigateway-ratelimits: customRatelimitName: api-limit: 200 app-limit: 200 user-limit: 200 ip-limit: 200 interval: 1 unit: MINUTE shared: false special: - type: USER limit: 100 instance: xxxxxxx 表1 参数说明 参数 是否必选 类型 说明 api-limit 是 Number API访问次数限制 user-limit 否 Number 用户访问次数限制 app-limit 否 Number 应用访问次数限制 ip-limit 否 Number 源IP访问次数限制 interval 是 Number 流控策略时间周期 unit 是 String 流控策略时间周期单位，支持SECOND、MINUTE、HOUR、DAY shared 否 Boolean 是否共享流控策略 special 否 x-apigateway-ratelimits.policy.special 对象数组 特殊流控策略 父主题： 扩展定义

x-apigateway-access-controls 含义：访问控制策略名称与关联策略映射。 作用域：Swagger Object 示例： x-apigateway-access-controls: customAccessControlName: acl-type: "DENY" entity-type: "IP" value: 127.0.0.1,192.168.0.1/16 表1 参数说明 参数 是否必选 类型 说明 customAccessControlName 否 x-apigateway-access-controls.policy 指定名称的访问控制策略。 要使用该策略，将x-apigateway-access-control属性值引用为该策略名称。 父主题： 扩展定义

兼容性说明 支持OpenAPI规范。 OpenAPI规范（OAS），是定义一个标准的、与具体编程语言无关的RESTful API的规范。OpenAPI规范的前身是Swagger规范，API网关目前支持两种OpenAPI规范：Swagger 2.0或OpenAPI 3.0。为了方便区分，下文中OAS表示OpenAPI规范（包含Swagger 2.0或OpenAPI 3.0），Swagger表示Swagger 2.0规范，OpenAPI表示OpenAPI 3.0规范。 API网关导入或导出的OAS对象，与API网关对象定义的映射关系。 请求参数类型与API网关参数类型差异。 API请求路径模板语法差异。 导入API时支持的API网关扩展字段。 表1 OAS对象与API网关对象定义的映射关系 Swagger对象 OpenAPI对象 （以3.0.0为例） API网关对象 导入时行为 导出时行为 info.title info.title API分组名称 导入到新的分组：新的分组名称 导入到已有分组：未使用 支持汉字、英文、数字、下划线，且只能以英文或汉字开头，3 ~ 64字符 填充为分组名称 info.description info.description API分组描述 导入到新的分组：新的分组描述 导入到已有分组：未使用 填充为分组描述信息 info.version info.version 版本 未使用 用户指定 未指定则使用当前时间 host server.url API分组域名 未使用 优先使用API分组的第一个自定义域名 如果分组未绑定自定义域名则使用分组的独立域名 basePath - - 将与每条API的请求路径拼接起来使用 未填充 paths.path paths.path API请求路径 与basePath拼接起来作为API请求路径 填充为API请求路径 operation.operationId operation.operationId API名称 作为API名称 填充为API名称 operation.description operation.description API描述 作为API描述 填充为API描述 operation.parameters operation.parameters API前端请求参数 作为API请求参数 填充为API请求参数 operation.schemes - API前端请求协议 作为API请求协议 填充为API请求协议 operation.responses operation.responses - 未使用 固定填充default响应定义 operation.security operation.security API认证方式 API认证方式 结合x-apigateway-auth-type 填充为API认证方式 结合x-apigateway-auth-type 表2 请求参数类型和API网关参数类型差异 OAS类型 API网关类型 支持的参数属性字段 integer long float double number maximum minimum default enum required description string string maxLength minLength default enum required description 其它类型 不支持 不支持 表3 API请求路径模板语法差异 语法 OAS类型Swagger类型 API网关 /users/{userName} 支持 支持 /users/prefix-{userName} /users/{userName}-suffix /users/prefix-{userName} -suffix 支持 前端请求定义不支持 后端请求定义支持 /users/{proxy+} 不支持 前端请求定义支持 后端请求定义不支持

限制说明 API网关参数限制，如下所示。 API网关暂不支持formData和body位置的请求参数定义。 API网关暂不支持consumes和produces定义。 API网关中，header位置的参数名称，不区分大小写。 后端策略限制，如下所示。 默认后端类型为HTTP，策略后端支持HTTP、HTTP-VPC 默认后端类型为HTTP-VPC，策略后端支持HTTP、HTTP-VPC 默认后端类型为function，策略后端支持function 默认后端类型为mock，策略后端支持mock

x-apigateway-backend-policies 含义：API网关定义的API后端策略。 作用域：Operation Object(2.0)/Operation Object(3.0) 示例： paths: '/users/{userId}': get: produces: - "application/json" responses: default: description: "default response" x-apigateway-request-type: "public" x-apigateway-backend: type: "backend endpoint type" x-apigateway-backend-policies: - type: "backend endpoint type" name: "backend policy name" conditions: - type: "equal/enum/pattern", value: "string", origin: "source/request_parameter", parameter_name: "string" 表1 参数说明 参数 是否必选 类型 说明 x-apigateway-backend-policies 否 x-apigateway-backend-policies 策略后端 type 是 String 后端服务类型，支持HTTP、HTTP-VPC、FUNCTION、MOCK name 是 String 后端策略名称 parameters 否 x-apigateway-backend.parameters 后端参数定义 httpEndpoints 否 x-apigateway-backend.httpEndpoints HTTP类型服务定义 httpVpcEndpoints 否 x-apigateway-backend.httpVpcEndpoints HTTP-VPC类型服务定义 functionEndpoints 否 x-apigateway-backend.functionEndpoints FUNCTION类型服务定义 mockEndpoints 否 x-apigateway-backend.mockEndpoints MOCK类型服务定义 conditions 是 x-apigateway-backend-policies.conditions 策略条件数组 父主题： 扩展定义

x-apigateway-backend 含义：API网关定义的API后端服务定义。 作用域：Operation Object(2.0)/Operation Object(3.0) 示例： paths: '/users/{userId}': get: produces: - "application/json" responses: default: description: "default response" x-apigateway-request-type: "public" x-apigateway-backend: type: "backend endpoint type" 表1 参数说明 参数 是否必选 类型 说明 x-apigateway-backend 是 String API后端服务定义 type 是 String 后端服务类型，支持HTTP、HTTP-VPC、FUNCTION、MOCK parameters 否 x-apigateway-backend.parameters 后端参数定义 httpEndpoints 否 x-apigateway-backend.httpEndpoints HTTP类型后端服务定义 httpVpcEndpoints 否 x-apigateway-backend.httpVpcEndpoints HTTP-VPC类型后端服务定义 functionEndpoints 否 x-apigateway-backend.functionEndpoints FUNCTION类型后端服务定义 mockEndpoints 否 x-apigateway-backend.mockEndpoints MOCK类型后端服务定义 父主题： 扩展定义

x-apigateway-plugins 含义：API网关定义的API插件服务。 作用域：Operation Object(2.0)/Operation Object(3.0) 示例： paths: '/path': get: x-apigateway-plugins: ['Plugin_mock'] x-apigateway-plugins 表1 参数说明 参数 是否必选 类型 说明 x-apigateway-plugins 否 Array API所绑定的插件名列表。 父主题： 扩展定义