用友YonBIP V3.0 (R5_2312_1) 旗舰版私有云用户手册-云平台-连接集成服务-API管理.pdf

YonBIPV3.0(R5_2312_1)旗舰版云平台篇-连接集成服务-API管理用友网络科技股份有限公司2024年1月用户手册1/59版权©2024用友集团版权所有。未经用友集团的书面许可，本用户手册任何整体或部分的内容不得被复制、复印、翻译或缩减以用于任何目的。本用户手册的内容在未经通知的情形下可能会发生改变，敬请留意。请注意：本用户手册的内容并不代表用友网络所做的承诺。用户手册2/59目录第一章总体概述................................................................................................................................................41.1产品概述................................................................................................................................................41.2应用价值................................................................................................................................................4第二章操作指南................................................................................................................................................42.1发布API.................................................................................................................................................42.1.1总体概述............................................................................................................42.1.2总体价值............................................................................................................42.1.3相关内容............................................................................................................42.1.4API分组.............................................................................................................42.1.5API发布.............................................................................................................82.2调用API...............................................................................................................................................162.2.1总体概述.........................................................................................................162.2.2总体价值.........................................................................................................172.2.3API接入申请..................................................................................................172.2.4API调用...........................................................................................................202.2.5API文档...........................................................................................................282.2.6API日志...........................................................................................................312.2.7API路由...........................................................................................................332.3安全策略.............................................................................................................................................372.3.1总体概述.........................................................................................................37用户手册3/592.3.2总体价值.........................................................................................................372.3.3IP访问控制.....................................................................................................372.3.4限流控制.........................................................................................................392.4企业授权.............................................................................................................................................402.4.1总体概述.........................................................................................................402.4.2总体价值.........................................................................................................412.4.3授权服务商.....................................................................................................412.5事件订阅.............................................................................................................................................452.5.1总体概述.........................................................................................................452.5.2总体价值.........................................................................................................452.5.3相关内容.........................................................................................................462.5.4事件文档.........................................................................................................462.5.5事件日志.........................................................................................................482.5.6事件订阅.........................................................................................................502.6网关设置.............................................................................................................................................532.6.1总体概述.........................................................................................................532.6.2总体价值.........................................................................................................532.6.3相关内容.........................................................................................................542.6.4系统参数.........................................................................................................54用户手册4/59第一章总体概述1.1产品概述API管理提供API的全生命周期的管理，包括创建、维护、发布、运行、下线等，包括分组管理、参数对象、API管理、插件管理、API日志、API文档、API接入申请、授权KEY管理、IP访问控制、限流控制、熔断控制、API注册审核、API监控等。1.2应用价值API管理旨在为企业中台化建设，提供统一能力的管理平台。第二章操作指南2.1发布API2.1.1总体概述为租户提供API发布能力，租户可以进行建造API分组、API分类之后，进行API发布。2.1.2总体价值租户可以在此发布系统内部接口，进行API全生命周期管理；可以发布接口同步给客开或者第三方开发者进行使用。2.1.3相关内容API分组API发布2.1.4API分组Commented[陈宇1]:产品定义已经变更为API分组用户手册5/592.1.4.1功能描述支持API分组的维护和API分类的管理，API的组织线索为API分组>API分类>API，API的发布、API文档的显示等都按此组织线索来呈现。通常一级分组对应一个应用系统，可按照分组维度配置实例、API分类管理、访问控制设置、删除、启用/停用。2.1.4.2业务规则支持API分组的管理；支持API分组的添加、修改、查看、删除、启用/停用；支持分组的实例配置，后端API的统一实例地址，并可统一配置实例参数；支持分组下的API分类管理；支持API分组级的访问控制配置；2.1.4.3栏目说明2.1.4.3.1API分组信息栏目名称说明分组路径用户自定义编码，由字母,数字,_-构成，且禁止使用ucgManage分组名称必填项，且不能重复分组描述分类详细描述信息，非必填项2.1.4.3.2API分类信息栏目名称说明分类编码用户自定义编码，非必填项，建议填写分类名称必填项，且同一个产品下的分类不可重复描述详细描述信息，非必填项用户手册6/592.1.4.3.3操作说明API分组管理API分组管理，可创建、编辑、删除分组信息，可配置分组的实例信息。API一级分组信息可以维护基本信息、门户是否可见及实例信息。用户手册7/59在二级分组可以进行访问控制。访问控制类型，包含：IP访问控制、限流及熔断。API分类管理二级分组下，允许设置API分类。用户手册8/592.1.5API发布2.1.5.1功能描述API发布支持API的新增、导入、编辑、删除、发布、取消发布、访问控制、生成文档文档等操作。API管理组织层次为，API分组->API分类->API。如果需要先维护分组信息，请参考API分组的文档说明。用户手册9/592.1.5.2业务规则API分组查询\查看：通过分组名称查询分组列表，同时可查看分组详情、API的详情；API发布：支持API的新增、Excel导入、Excel导出、swagger导入，支持API的批量发布、取消发布，支持API文档的生成，支持API测试，查看API日志和监控。2.1.5.3操作说明API分组查询：输入分组名称，回车或点击搜索图标搜索查询满足条件的分组。【图】分组搜索新增API：点击产品卡片上的【API发布】进入此分组下的API列表页，点击左上角的<新增API>，进入添加API页面，新增API包括填写基本信息定义API请求定义API后端服务三个步骤。Step1:填写基本信息，输入API名称；选择API分类，API分类为在此产品下设置的API分类，可点击【API分组】二级分组中定义API分类；如果有个性化安全认证，可以选择安全认证插件，不选择默认为access_token安全认证插件；选择后端接入方式，取决您后端服务的类型；用户手册10/59【图】基本信息维护API名称：填写API的名称，建议名称见名思义，能够通过名称就能知道该api的用途。API分类：API的分组，每一组都是一套API，比如组织，该分类下会有组织新增、修改、删除、停用、启用。后端接入方式：目前主要用到的是rest、iris、自定义。该类型是开放平台调用业务接口的时候的请求方，可按照实际情况选择。开放模式：用友原厂的api均是公开，即发布之后，外部的所有客户均可以调用。API描述：描述该API的使用场景以及其他说明。Step2:点击下一步进入API请求定义维护界面，如下图：用户手册11/59【图】定义API请求完整发布地址：开放平台对外公开的地址，不可编辑，域名+分类路径+请求路径组成完整的API发布地址。域名：开发平台API对外调用的域名，不可编辑。分类路径：API所属API分组和分组的编码作为API发布地址的一部分。请求路径：接口请求的路径，用户手工输入，建议该地址见名思意，能根据地址看出来接口用途，格式如：/users/{userId}/projects，{}中的变量为请求参数，表示匹配”/“之间的一整段，不支持匹配”/“之间的一部分，例如/abc{userId}；请求Path中包含请求参数时，必须设置对应的入参定义。匹配所有子路径：调用的请求路径将以创建时填写的API请求路径为前缀，支持接口定义多个不同Path。例如：请求路径为/test/AA，使用匹配所有子路径时，通过/test/AA/BB、test/AA/CC都可以访问，但是通过/test/AACC无法访问。ContentType：内容类型，可根据实际情况选择，默认为：application/json。请求类型：支持GET、POST、PUT、DELETE、ANY（表示该API支持任意请求方法）。body透传:当选择为true网关只做body参数的转发，不做body参数过滤和映射。请求参数：可定义接口的请求参数。可配置参数的数据类型、是否数组、参数位置、默认值、是否必填、描述、用户可见(为false，则在文档中不可见，默认为true).建议参数的描述和是否必填一定要写清楚，这样用户在看文档的时候能清晰的知道该参数的含义，以及是否必须传入。名称：参数的名称，如果参数在“PATH”位置，那么参数名称需要和“请求路径”中的名称相同。类型：字段的类型，包括String、int、long、boolean、object等，其中object表示对象类型，可以为子参数，并且只有参数位置为Body时显示。用户手册12/59是否数组：标记参数是否是数组。描述：参数的中文描述，建议参数的描述一定要写清楚，让API调用方在文档中能清晰的知道该参数的含义。数值类型建议标记精度、字符串类型建议标记最大长度、若值为枚举的建议在描述中标记所有枚举值和说明。默认值：“必填”为“否”时，默认值生效。请求中不包含此参数时，API网关自动增加默认值发送给后端服务。是否必填：请求API时，此参数是否为必填。如果选择“是”，API网关将校验请求中是否包含此参数，如果不包含，则拒绝该请求。用户可见：设置成不可见，则在API文档中用户看不到此参数。示例：参数值的填写示例，建议填写。参数验证：参数验证正则表达式，若要对参数验证格式可以在此录入相应的正则表达式。请求示例：该示例必填，会展示在文档中，用户可以参考该示例调用接口。参数拓展：参数拓展按钮，专为支持与租户级拓展对象的高效交互而设计，仅用于YonBIP分类场景下。开启参数后，API定义直接关联到业务对象B。当API调用发生，后端服务可以接收包含拓展字段的数据，进而将其正确入库。且API文档可以展示业务对象的拓展信息。请求参数是否展示扩展：如果选该参数，仅在请求参数内增加扩展字段。返回参数是否展示扩展：如果选该参数，仅在返回参数内增加扩展字段。扩展参数是否放在customExtend：如果选该参数，由customExtend封装后传递扩展参数。例如：customExtend{“A”:”code”}。Step3:点击下一步进入定义API后端服务维护界面，如下图：用户手册13/59用户手册14/59【图】定义API后端服务后端请求地址：后端服务的路径，可以包含路径参数，以{路径参数}形式表示，比如getUserInfo/{userId}，并要求路径参数要保持和请求参数定义的路径参数名一致。后端请求类型：支持GET、POST、PUT、DELETE、ANY（表示该API支持任意请求方法）。后端超时时间：请求超时时间，建议1~180秒。默认10秒。常量参数：如果后端服务需要接收API调用者不可见的常量，可以通过设置常量参数来实现。API网关在请求后端服务时，将常量参数增加到指定请求位置，并将请求发送给后端服务。后端请求参数映射：网关会根据该参数映射，进行入参和到后端参数的映射。当对外暴露的参数名称，参数位置和后端真实参数名、参数位置不同时，可使用该配置进行映射。后端返回结果定义：该接口的返回值定义，需明确定义返回值参数名称、描述、类型、是否数组以及示例。o名称：参数的名称。o类型：字段的类型，包括String、int、long、boolean、object等，其中object表示对象类型，可以为子参数。o是否数组：标记参数是否是数组。o描述：参数的中文描述，建议参数的描述一定要写清楚，让API调用方在文档中能清晰的知道该参数的含义。数值类型建议标记精度、字符串类型建议标记最大长度、若值为枚举的建议在描述中标记所有枚举值和说明。o示例：参数值的填写示例，建议填写。高级选项：用户手册15/59o业务扩展插件：业务扩展插件可以让API开发者在平台访问后端服务和将后端服务返回值返回前插入自定义的业务代码进行扩展。例如可以根据后端服务的鉴权要求增加鉴权参数的处理。o返回值插件：网关规范要求API返回值标准格式必须是JSON对象，对象属性包括：1.code：状态码，正确返回值为2002.message：提示信息，当code不为200时，出示错误信息，非必选项3.data：后端服务返回的数据部分，非必选项示例:{“code”:”200”,”message”:”xxxxxxxxxx”,”data”:{“name”:”zhangsan”,”age”:20}}若后端服务返回值不是此结构，就需要通过开发自定义的【返回值解析插件】进行转换若后端服务返回结构是JSON对象，也有状态码、提示信息和数据参数，仅仅是参数名不是code、message和data，平台提供【返回值参数映射插件】，用户无需开发新的插件，只需维护参数映射关系即可。设置为Mock返回结果：将正确返回示例设置为Mock返回值。Mock一般用于开发调试验证。在项目初始阶段，后端服务没有搭建好API联调环境，可以使用Mock模式，将预期结果固定返回给API调用方，方便调用方进行项目开发。延时：设置为Mock返回结果为true时显示，默认为0，0表示不延迟，其他值时，网关会延迟设置的时长后才返回mock数据。正确返回示例生成示例：成功调用API时，返回的响应信息示例错误返回示例：调用API失败时，返回的响应信息示例。错误码：API返回的错误码列表，可以让调用方明确知道错误原因和解决方案。编辑API：点击产品卡片上的【API发布】进入此产品下的API列表页，可对产品下的API清单进行查询，点击列表中右侧的<编辑>按钮进行修改。【图】API编辑用户手册16/59注：发布过的API，编辑保存后，需要点击重新发布才能生效。编辑步骤与API新增类似。删除API：只有未发布的API才可以删除，ps:删除API操作将删除数据，请谨慎操作。发布：在API列表中点击某API的<发布>按钮后，将修改API状态为发布状态，则调用方可以访问，只有发布的API才能生成文档。API为发布状态的情况进行了编辑，保存后，修改的部分将不会生效，只有【重新发布】后才生效。如不需要向用户展示可以进行【取消发布】操作，取消发布后所有调用方将无法调用此API。同时为管理者提供了批量发布、批量取消发布的操作功能。提供批量【生成文档】功能，点击<生成文档>按钮，系统将自动将此产品下的已发布的全部API生成文档，并可通过API文档进行查看。访问控制：可为某API个性化设置访问控制，在产品下的API列表页中点击<访问控制>按钮，进入访问控制管理页面，如下图：【图】访问控制注：点击添加可从插件列表中选择需要使用的插件，添加后可进行删除、启用/停用；点击<添加>将显示由插件管理节点维护的插件类型为访问控制插件，插件等级为API的插件。2.2调用API2.2.1总体概述用户手册17/59企业通过调用API来快速授权第三方应用调用云服务的API，为第三方应用分配能够通过AppKey，AppSecret来安全调用API，租户可通过此模块的管理能力来有效控制调用方。2.2.2总体价值API调用提供调用方的授权管理及针对授权KEY安全策略的设置。API文档通过API文档可全方位的了解API详情。2.2.3API接入申请2.2.3.1功能描述企业根据购买的领域服务及集成需要，可以申请API接入，向集成运营人员申请需要接入的API。2.2.3.2业务规则支持用友云开放API的申请和服务商API的申请；支持已申请用友开放API和已申请服务商API的查询、查看；支持申请历史记录的查询。2.2.3.3操作说明功能入口：通过菜单，集成服务>API管理>调用API>API接入申请。查看已申请用友开放API：Commented[陈宇2]:该节点已经下架用户手册18/59查看已申请服务商API：点击申请分类，右边显示API列表，在API列表中点击详情可跳转到开放平台的文档中心的API详情；申请API:点击【申请API】页签，点击分类右侧的【申请服务】，选择API分类，点击【申请服务】处的【确认】按钮完成申请操作；用户手册19/59用户手册20/59查看分类API:点击分类，右侧显示分类下的API列表，点击列表中的详情跳转到开放平台的文档中心查看API详情说明；2.2.4API调用用户手册21/592.2.4.1功能描述为API调用方授权，分配AppKey、AppSecret，调用方通过AppKey、AppSecret来调用由网关开放的API，网关通过AppKey、AppSecret来进行鉴权，保护API的合法访问，保护数据的安全。2.2.4.2业务规则添加和修改授权Key自动生成全局唯一的AppKey和AppSecret；AppKey不允许修改；AppSecret支持重新生成。API授权为AppKey分配可访问的OpenAPI，包括原厂、服务商和内部API。事件订阅为AppKey订阅开放平台公开的各类事件类型（如更改人员信息、更改组织机构等），一旦数据发生变动，开放平台会将企业租户变动数据推送给应用后台接口，应用后台进行数据同步。2.2.4.3栏目说明授权Key信息：栏目名称说明授权KEY描述授权KEY的描述信息AppKey全局唯一的AppKey标识AppSecretAppKey对应的密钥信息，可重新生成API授权信息：用户手册22/59栏目名称说明授权Key授权KeyAPI主键授权的API主键类型原厂、服务商、内部事件订阅信息：栏目名称说明授权Key授权Key回调地址开放平台推送事件的地址，需要保证可以在公网访问，在保存订阅信息时，开放平台会向该地址推送测试事件，以验证回调地址的有效性。开发人员在开发事件订阅接口时可使用测试按钮推送测试事件，待测试事件推送成功后，再订阅具体的业务事件。必填项。预警邮箱事件推送失败，开放平台会向此邮箱发送邮件限流策略设置推送的限流策略。0标识不限流。重试次数推送失败重试次数订阅的事件列表已订阅的事件列表访问控制：栏目名称说明授权Key授权Key插件ID应用级别的插件类型，包括：API授权、应用级限流、IP访问控制访问控制：栏目名称说明授权Key授权Key插件ID应用级别的插件类型，包括：API授权、应用级限流、IP访问控制执行顺序多个访问控制的执行顺序用户手册23/59访问控制策略关联的访问控制策略状态启用、禁用2.2.4.4操作说明2.2.4.4.1新增授权KEY进入API调用页面，点击左上角的<添加>按钮，弹出维护窗口，填写授权KEY描述，点击<保存>完成添加，授权KEY描述一般为调用方的描述信息，例如:MES系统供应链API调用。操作界面如下图：新增授权KEY注：可点击隐藏图标来查看AppSecret，可点击重置来重新生成AppSecret。2.2.4.4.2API授权为此授权KEY授予可调用的API，点击<API授权>按钮进入API授权页面，显示已经授权的API，点击<新增API>下拉选择【用友开放API】、【服务商API】、【内部API】，其中【用用户手册24/59友开放API】表示用友原厂开放的API，【服务商API】表示服务商开放的API，内部API表示当前租户自己开放的API；进入选择API页面，选择需要授权的API，可多选，点击<确定>完成API的授权，在API授权页面可查看API详情，也可删除某API的授权。已授权的API用户手册25/59新增API授权2.2.4.4.3事件订阅为此授权KEY订阅事件，点击<事件订阅>按钮进入事件订阅页面，显示订阅的基本信息和已经订阅的事件。订阅的基本信息包括回调地址、预警邮箱、限流配置和重试次数。【回调地址】是开放平台推送事件的地址，需要保证可以在公网访问，在保存订阅信息时，开放平台会向该地址推送测试事件，以验证回调地址的有效性。开发人员在开发事件订阅接口时可使用测试按钮推送测试事件，待测试事件推送成功后，再订阅具体的业务事件。【预警邮箱】事件订阅推送失败会向此邮箱。【限流配置】可配置多少秒内推送的次数，以免将应用后端服务压力过大。【重试次数】可配置推送失败重新发送的次数。点击<新增订阅>，进入新增订阅页面，选择需要订阅的事件，可多选，点击<确定>完成事件的订阅，在事件订阅页面可删除已订阅的事件。用户手册26/59已订阅事件新增订阅2.2.4.4.4访问控制为此授权KEY进行应用级别的访问控制，包括API授权、限流和IP访问控制。点击<访问控制>按钮进入访问控制页面，显示已有的访问控制插件，可以删除、启停用、排序和关联策略。用户手册27/59点击<添加>可从访问控制插件列表中选择需要使用的应用级别的访问控制插件。【API授权】添加后，则此AppKey访问的API时必须先进行API授权后才允许访问，若不配置，则访问API时不做API授权的控制，建议加上。系统默认自动添加。【限流】控制此AppKey访问API的限流策略，需关联限流策略。【IP访问控制】可以配置黑白名单，需关联IP访问控制策略。在访问控制首页，在限流记录上，点击关联策略，可以选择租户配置的限流策略。用户手册28/59在访问控制首页，在IP访问控制记录上，点击关联策略，可以选择租户匹配值的IP访问控制策略。2.2.5API文档2.2.5.1功能描述租户可通过API文档来查询租户发布的API和API详细信息，通过API文档可了解某API的请求地址、请求方式、鉴权参数、请求参数的说明及示例、正确返回的示例、错误返回码、错误返回示例。集成开发人员根据此信息来开发调用。用户手册29/592.2.5.2业务规则API查询输入API名称或者地址，模糊查询出符合条件的API列表，点击具体API，可快速定位并打开API详情页面。API清单选择产品分类、产品和API分类时可以查看下属的所有API清单。API详情页通过API查询，或者点击左侧树中某个API时，可打开API详情页。在线测试开放平台提供在线测试API功能，用户直接输入参数，即可进行调试，并查看调试结果。2.2.5.3操作说明2.2.5.3.1API查询进入API文档页面，如下图：用户手册30/59顶部查询条件，输入API名称或者访问地址，回车或点击查询图标按钮，列出所有符合条件的API名称，如下图：点击查询列表中的具体API，则快速定位到此API，并显示此API的详情页，如下图：用户手册31/592.2.5.3.2API测试工具开放平台提供在线测试API功能，用户直接输入参数，即可进行调试，并查看调试结果。在API详情页，页面顶部或底部，点击<API测试工具>按钮，进入API测试工具页面，如下图：左侧输入参数，点击<开始>发起调试，右侧显示调试结果，如下图：用户手册32/592.2.6API日志2.2.6.1功能描述租户可通过API日志来查询租户调用API的日志信息。2.2.6.2业务规则API日志查询支持根据TranceId，ApiID、API名称、API地址、AppKey、状态、请求参数和调用日期范围进行API调用日志查询。API日志详情页通过API日志查询，可打开API日志详情页。2.2.6.3操作说明2.2.6.3.1API日志进入API日志页面，输入相应查询条件，点击查询可以查询到API调用日志，如下图：用户手册33/59点击查询结果列表中的trancId，打开API日志详情页，可以查看日志详情，如下图：2.2.7API路由2.2.7.1功能描述API路由是指在Web应用程序中定义和管理不同的URL路径（端点），以便将HTTP请求路用户手册34/59由到相应的处理程序或控制器函数。它是构建Web服务和API的关键组成部分，可以让客户端应用程序与服务器端进行通信和数据交换。2.2.7.2业务规则由于集成平台的路由条件属性仅支持header或query参数，所以在API定义时，需要在入参里手工增加路由条件对应参数，然后在路由配置时一定要选择header或query里的参数，不要选择body里的参数。需要支持路由的集成方案，领域需要提前规划好支持哪些路由条件属性，领域开发调用集成方案API时，需要将可能的路由条件属性值添加到请求header或query里。2.2.7.3操作说明API路由配置：管理端提供两个配置入口。第1种路由增加方式，首先在”API发布”查询到相关API，接下来进入API详情，可以看到路由配置页签，点击“新增”增加API路由配置。用户手册35/59管理端提供两个配置入口。第2种路由增加方式，在管理端的菜单，查找到”API路由”，进入”API路由”填写路由名称及描述，完成规则配置。用户手册36/59用户手册37/592.3安全策略2.3.1总体概述租户进行安全策略的管理，通过IP地址来控制调用方系统那些IP是合法属性、那些IP不允许调用API，同时也可对调用方来进行限流的配置，以保护服务和数据。2.3.2总体价值IP访问控制用户手册38/59支持IP黑名单的设置，设置成为黑名单的IP地址将不能够访问API，而其它不在黑名单范围内的IP地址都可以正常访问API。支持白名单的设置，设置成为白名单的IP地址，表明只允许白名单范围内的IP地址可正常访问API。IP名单设置支持一个策略设置多个IP地址。限流控制提供限流策略的配置，通过限流策略的控制来保护API服务。支持按时间段、数量、维度来设置限流策略。2.3.3IP访问控制2.3.3.1功能描述提供IP访问控制策略的配置，策略名称用于标识IP访问控制，策略类型分为黑名单、白名单，黑名单为表示在黑名单内的IP不允许访问，其它IP可以访问，白名单表示只允许白名单内的IP可访问。2.3.3.2业务规则支持IP控制策略的添加、编辑、删除、查看，被关联的IP访问控制不能被删除2.3.3.3栏目说明IP控制策略：字段名称说明策略名称IP访问控制策略名称，必填策略描IP访问控制策略描述信息，非必填用户手册39/59述类型黑名单、白名单，必填黑名单表示禁止访问；白名单表示运行访问IP名单支持多个，必填2.3.3.4操作说明2.3.3.4.1添加IP访问控制策略为策略命名，选择策略类型，填写策略描述，维护IP名单，操作界面如下：注：配置完成的IP访问控制，使用访问控制插件后，可关联IP访问控制策略。2.3.4限流控制2.3.4.1功能描述提供调用应用基本的限流策略的维护，可维护策略名称、策略描述。支持限流策略控制的配置，配置时间段、数量、维度，即在这个时间段限制最大调用的数量，可针对API、发布方应用、IP、系统、调用方应用等维度。用户手册40/592.3.4.2业务规则支持限流策略的添加，支持维护限流策略的具体配置；支持限流策略的查看、编辑、删除。2.3.4.3栏目说明限流策略：字段名称说明策略名称限流策略名称，必填策略描述限流策略描述信息，非必填策略级别调用应用，固定限流明细维护时间段、数量、维度，维度包括调用方应用、API、IP支持多个，必填2.3.4.4操作说明2.3.4.4.1添加IP访问控制策略为策略命名，选择策略类型，填写策略描述，维护限流明细，操作界面如下：用户手册41/59维度包括调用方应用、API、IP，其中维度若为【调用方应用】表示按整个应用的所有请求不能超过所设限流阈值；若为【API】表示当前应用按每个API的所有请求不能超过所设限流阈值；若为【IP】表示当前应用按每个请求IP的所有请求不能超过所设限流阈值。注：配置完成的限流策略后，使用限流插件时可关联限流策略。2.4企业授权2.4.1总体概述ISV服务商可以申请为企业提供集成开发，租户可以对申请的集成开发的供应商进行审核，允许ISV服务商可以使用企业的数据和集成资产（API）。2.4.2总体价值授权服务商对ISV的申请进行管理，可以允许或拒绝那家软件集成开发的服务。2.4.3授权服务商用户手册42/592.4.3.1功能描述可以查看已授权服务商，可以审核提出授权申请的服务商，授权申请包括企业租户申请、开发人员申请和延期申请。其中【企业租户申请】是服务商申请建立和租户的服务关系；【开发人员申请】是服务商的开发人员申请加入到租户里；【延期申请】是服务商申请延长服务期限。2.4.3.2业务规则企业授权审核：审核服务商提出的授权申请授权服务商管理：可终止服务商，延长期限2.4.3.3栏目说明授权服务商：字段名称说明服务商ID已授权的服务商租户ID企业租户ID状态正常、终止开发人员列表已授权的开发人员用户ID授权申请记录信息：字段名称说明申请单ID申请单ID申请服务商ID授权申请的服务商ID授权租户ID申请授权的企业租户ID状态草稿、待审核、审核通过、审核不通过用户手册43/59申请时间申请时间申请人申请人申请类型企业租户申请、开发人员申请、延期申请2.4.3.4操作说明2.4.3.4.1企业授权审核进入授权服务商页面，在【授权申请】标签页里默认列出当前待审核的授权申请，界面如下：点击审核按钮，打开审核页面，【授权申请】界面如下：用户手册44/59【开发人员申请】界面如下：【延期申请】界面如下：用户手册45/59点击通过或不通过按钮，进行审核2.4.3.4.2已授权服务商管理进入授权服务商页面，在【已授权服务商】标签页里默认列出已授权的服务商，界面如下：【开发人员】按钮：弹窗打开查看开发人员页面，可以查看已授权的服务商的开发人员列表，如下图：用户手册46/59【授权延期】按钮：弹窗打开授权延期页面，可以重新设定服务商的服务到期时间，如下图：2.5事件订阅2.5.1总体概述为租户提供了开放事件，相关文档查看能力，并对应用接入事件，事件相关日志查看能力。2.5.2总体价值租户可以查看所有开放事件的文档及事件推送的相关日志。用户手册47/592.5.3相关内容事件文档事件日志2.5.4事件文档2.5.4.1功能描述租户可通过事件文档来查询发布的事件和事件详细信息，通过事件文档可了解某事件的请事件描述、事件编码、事件字段描述、事件内容示例等信息。集成开发人员根据此信息来开发调用。2.5.4.2关键应用事件查询输入事件名称或者事件编码，模糊查询出符合条件的事件列表，点击具体事件，可快速定位并打开事件详情页面事件清单选择产品分类、产品和API分类时可以查看下属的所有事件清单事件详情页通过事件查询，或者点击左侧树中某个事件时，可打开事件详情页。2.5.4.3字段说明此页面只是事件查询功能，无字段说明2.5.4.4操作说明事件查询进入事件文档页面，如下图：用户手册48/59顶部查询条件，输入事件名称或者事件编码，回车或点击查询图标按钮，列出所有符合条件的事件名称，如下图：点击查询列表中的具体事件，则快速定位到此事件，并显示此事件的详情页，如下图：用户手册49/592.5.5事件日志2.5.5.1功能描述租户可通过事件日志来查询租户定义事件的日志信息2.5.5.2关键应用事件日志查询支持根据产品分类、产品、模块、消息ID、事件名称、事件编码、推送结果、推送时间范围进行事件日志查询事件日志详情页通过事件日志查询，可打开事件日志详情页。2.5.5.3字段说明此页面只是事件日志查询功能，无字段说明用户手册50/592.5.5.4操作说明2.5.5.4.1事件日志进入事件日志页面，输入相应查...