华为云用户手册

补丁基本信息说明 表1 补丁基本信息 补丁号 MRS 3.3.1-LTS.1.2 发布时间 2024-08-19 解决的问题 MRS 3.3.1-LTS.1.2修复问题列表： 解决Doris集群产生RFC请求耗时超过阈值的误告警问题 解决Doris的BE实例crash重启的问题 解决Doris物化视图测试时出现过crash重启的问题 解决Doris审计日志SQL截断的问题 解决Doris coredump文件内存打印未关联源码位置的问题 解决Doris 某个tablet的副本数据查询不一致的问题 解决Doris UDF异常数据处理的问题，该问题需要在安装补丁前删掉UDF函数，打完补丁重新创建UDF函数 解决Doris开源问题 解决Doris 执行select * from quires() 存在kill失败的慢查询记录的问题 解决Hudi隐式分区refresh table导致作业异常的问题 解决HBase Cache key had block type null日志打印过多，影响性能的问题 解决HBase偶现Ranger协处理器抛NullPointerException，导致regionserver重启的问题 解决HBase修改log4j动态配置未重启实例时，日志未脱敏的问题 [Hidden partitioning] identity(col) function doesn't support the timestamp type [Hidden partitioning] Check fields exist in table schema [Hidden partitioning] Incorrect partition rules in CREATE TABLE should be restricted [Hidden partitioning] Partitioned table can enable hidden partitioning, which needs to be restricted [Hidden partitioning] Sql execution INSERT OVERWRITE will overwrite the entire table time travel 和delta保存兼容性 解决Hudi海量分区场景查询过滤不带分区条件，查询性能慢的问题 Identical substrings in primary keys with bucket index cause duplicate keys error 解决Hudi删除外表之后重建报错的问题 解决Hive查询Hudi特殊场景下失败的问题 [Hidden partitioning] Fix Job fails for non-partitioned table for streaming read 解决Flink on hudi模块存在默认密码硬编码的问题 增加新的call命令，清除所有历史版本数据，仅保留所有最新的fileslice，同时清理timeline文件，仅保留一个最新的commit 单条数据大小估算时跳过包含delete操作的commit [Hidden partitioning] RENAME and DROP hidden partition column is prohibited [Hidden partitioning] Clustering with hidden partition field order is prohibited [Hidden partitioning] Support newline char in hidden partition rule [Hidden partitioning] Change hidden partition properties is forbidden 解决Flink流读Hudi非分区表带过滤条件，流读失败的问题 解决HetuEngine访问Hudi带log文件失败的问题 解决Hudi表执行drop partition后重新写入相同分区的数据，分区无法添加到MetaStore，导致Hive/HetuEngine读不到新数据的问题 解决Flink创建Hudi隐式分区表失败的问题 解决Hive使用Tez引擎执行了union all后生产了HIVE_UNION_DIR目录，后面再使用concatenate语句对分区执行小文件合并时必现数据丢失的问题 解决更改集群ntp服务器失败的问题 解决未配置ntp时钟源ip地址的问题 解决Kudu 45476告警资料跟告警无法对应的问题 解决Kudu英文资料存在huawei字样的问题 解决Impala租户资源配置Manager页面报错的问题 解决Kudu和Impala客户端过大的问题 解决Impala开启Ldap后上报服务亚健康检查告警的问题 解决Impala并发把资源池打满，导致服务健康检查失败，Impalad实例重启的问题 Knox支持@符号转化成中划线，支持邮箱形式账号提交作业 解决Hudi的bucket(col,N)函数不支持timestamp字段类型，建表后插入数据，数据转换错误的问题 解决Hudi的identity(col)函数不支持date字段类型，转换出来的隐式分区显示default的问题 解决Hudi的truncate(col, W)函数，W在建表时可以为负数的问题 解决Hudi分区规则属性包含5个以上的规则应建表失败的问题 父主题： MRS_3.3.1-LTS.1.2补丁说明

前提条件 系统管理员已明确业务需求，并规划好不同系统的 域名 。域名只能包含大写字母、数字、圆点（.）及下划线（_），且只能以字母或数字开头。例如“DOMAINA.HW”和“DOMAINB.HW”。 配置跨集群互信前，两个Manager系统的域名必须不同。MRS创建E CS /BMS集群时会随机生成唯一系统域名，通常无需修改。 配置跨集群互信前，两个集群中不能存在有相同的主机名，也不能存在相同的IP地址。 配置互信的两个集群系统时间必须一致，且系统上的NTP服务必须使用同一个时间源。 配置互信的两个集群如果包含MRS 3.3.1及之后版本，需要确保两集群所使用的加密算法和模式一致。 可在MRS集群中执行cat ${CONTROLLER_HOME}/inst/conf/oms-config.ini | grep "krb5_supported_enctypes"命令，根据“krb5_supported_enctypes”参数值确认加密类型。 参数值为空：表示使用默认加密算法和模式，即“AES256- CTS -HMAC-SHA1-96 AES128-CTS-HMAC-SHA1-9” aes256-sha1,aes128-sha1：表示加密算法和模式为“AES256-CTS-HMAC-SHA1-96 AES128-CTS-HMAC-SHA1-9”。 aes256-sha2,aes128-sha2：表示加密算法和模式为“AES256-CTS-HMAC-SHA384-192 AES128-CTS-HMAC-SHA256-128”。 配置互信的两个集群系统内所有集群全部组件的运行状态均为“良好”。 配置互信的两个集群，需要在相同的VPC中。如果两集群不在同一VPC中，则需要已建立VPC对等连接，相关操作请参考VPC对等连接。 MRS 3.x及之后版本，Manager内所有集群的ZooKeeper服务的“acl.compare.shortName”参数需确保为默认值“true”。否则请修改该参数为“true”后重启ZooKeeper服务。

对系统的影响 配置跨集群互信后，外部系统的用户可以在本系统中使用，请系统管理员根据企业业务与安全要求，定期检视Manager系统中用户的权限。 配置跨集群互信时需要重启受影响的服务，会造成对应服务的业务中断。 配置跨集群互信后，互信的集群中均会增加Kerberos内部用户“krbtgt/本集群域名@外部集群域名”、“krbtgt/外部集群域名@本集群域名”，用户不能删除。 针对MRS 2.x及之前版本，密码默认为“Crossrealm@123”。 MRS 3.x及之后版本，请系统管理员根据企业安全要求，及时且定期修改密码，需同时修改互信系统中4个用户且密码保持一致。具体请参见修改MRS集群组件运行用户密码。修改密码期间可能影响跨系统业务应用的连接。 MRS 3.x及之后版本，如果修改了系统域名，且集群有运行中的HetuEngine计算实例，需要重启HetuEngine的计算实例。 MRS 3.x及之后版本，配置跨集群互信后，各个集群都需要重新下载并安装客户端。 配置跨集群互信后，验证配置后是否可以正常工作，且如何使用本系统用户访问对端系统资源，请参见配置互信MRS集群的用户权限。

更新互信集群客户端配置（MRS 2.x及之前版本） 配置跨集群互信后，因在MRS Manager修改了服务配置参数并重启了服务，请重新准备好客户端配置文件并更新客户端。 场景1： A集群和B集群（对端集群、互信集群）是同类型集群，例如均是分析集群或者流式集群，请参见更新客户端配置（2.x及之前版本）分别更新客户端配置文件。 更新A集群的客户端配置文件。 更新B集群的客户端配置文件。 场景2： A集群和B集群（对端集群、互信集群）是不同类型集群，请执行如下步骤分别更新对端集群的配置文件到本端集群和本端集群自身的配置文件。 将A集群的客户端配置文件更新到B集群上。 将B集群的客户端配置文件更新到A集群上。 更新A集群的客户端配置文件。 更新B集群的客户端配置文件。 登录MRS Manager(A集群)。 单击“服务管理”，然后单击“下载客户端”。 图1 下载客户端 “客户端类型”选择“仅配置文件”。 “下载路径”选择“远端主机”。 将“主机IP”设置为B集群的主Master节点IP地址，设置“主机端口”为“22”，并将“存放路径”设置为“/tmp”。 如果使用SSH登录B集群的默认端口“22”被修改，请将“主机端口”设置为新端口。 “存放路径”最多可以包含256个字符。 “登录用户”设置为“root”。 如果使用其他用户，请确保该用户对保存目录拥有读取、写入和执行权限。 在“登录方式”选择“密码”或“SSH私钥”。 密码：输入创建集群时设置的root用户密码。 SSH私钥：选择并上传创建集群时使用的密钥文件。 单击“确定”开始生成客户端文件。 若界面显示以下提示信息表示客户端包已经成功保存，单击“关闭”。 下载客户端文件到远端主机成功。 若界面显示以下提示信息，请检查用户名密码及远端主机的安全组配置，确保用户名密码正确，及远端主机的安全组已增加SSH(22)端口的入方向规则。然后从2执行重新下载客户端。 连接到服务器失败，请检查网络连接或参数设置。 使用VNC方式，登录弹性云服务器（B集群）。参见登录弹性云服务器（VNC方式） 。 所有镜像均支持Cloud-init特性。Cloud-init预配置的用户名“root”，密码为创建集群时设置的密码。 执行以下命令切换到客户端目录，例如“/opt/Bigdata/client”： cd /opt/Bigdata/client 执行以下命令，将A集群的客户端配置更新到B集群上： sh refreshConfig.sh 客户端安装目录客户端配置文件压缩包完整路径 例如，执行命令： sh refreshConfig.sh /opt/Bigdata/client /tmp/MRS_Services_Client.tar 界面显示以下信息表示配置刷新更新成功： ReFresh components client config is complete. Succeed to refresh components client config. 步骤1~11的操作也可以参考更新客户端配置（2.x及之前版本）页面的方法二操作。 参见1~11，将B集群的客户端配置文件更新到A集群上。 参见更新客户端配置（2.x及之前版本），分别更新本端集群自身的客户端配置文件： 更新A集群的客户端配置文件。 更新B集群的客户端配置文件。

升级HDFS上组件的zip包 登录集群主节点并执行以下命令： su - omm cd /opt/Bigdata/patches/{MRS补丁版本号}/client/ source /opt/Bigdata/client/bigdata_env 所有涉及{MRS补丁版本号}目录名称的操作，均以实际安装的补丁号为准。 例如： cd /opt/Bigdata/patches/MRS_3.3.1-LTS.1.2/client/ 安全集群需要认证对HDFS有权限的用户，普通集群无需执行： kinit {用户} 执行以下命令升级HDFS上的zip包： sh update_hdfs_file.sh 升级完成后需要在 FusionInsight Manager界面上重启Spark的JD BCS erver2x实例。

升级客户端 如果有使用自主安装的客户端（集群内、外新下载客户端），需要执行客户端升级操作。 登录集群主节点并执行以下命令： cd /opt/Bigdata/patches/{MRS补丁版本号}/download/ 将补丁安装包拷贝到客户端机器/opt/目录下： scp patch.tar.gz {客户端机器IP}:/opt/ 例如： scp patch.tar.gz 127.0.0.1:/opt/ 登录客户端所在节点。 执行以下命令创建补丁目录并解压补丁包： mkdir /opt/{MRS补丁版本号} tar -zxf /opt/patch.tar.gz -C /opt/{MRS补丁版本号} 执行客户端补丁升级。 登录客户端所在节点，并执行以下命令： cd /opt/{MRS补丁版本号}/client sh upgrade_client.sh upgrade {客户端安装目录} 例如： sh upgrade_client.sh upgrade /opt/client/

约束与限制 可以为云服务器备份存储库、SFS Turbo备份存储库、云硬盘备份存储库、 云桌面 存储库、文件备份存储库、数据库服务器存储库设置备份策略。 通过备份策略的方式对资源进行周期性备份，仅当启用备份策略后，系统才会自动备份所绑定的存储库绑定的资源，并定期删除过期的备份。 每个用户最多只能创建32个备份策略。 设置备份时间和复制备份的时间时，尽量在确保备份策略执行完毕备份任务已完成后再执行复制策略，否则可能会出现复制备份失败的情况。 策略保留规则过期清理时，仅会删除过期自动备份数据，不会删除手动备份数据。 只有“运行中”、“关机”状态的服务器才可进行备份。 只有“可用”或“正在使用”状态的磁盘才可进行备份。 默认情况下，对一个新的资源第一次进行全量备份，后续进行增量备份。 两次全量备份的最小时间间隔不能小于1天。 由组织管理账号统一创建的策略，成员账号只可以使用，不能进行编辑、删除、停用、启用操作。

SFS Turbo备份和文件备份的区别 对比维度 SFS Turbo备份 文件备份 备份/恢复对象 高性能弹性文件服务中的SFS Turbo文件系统 云上服务器和用户数据中心虚拟机或服务器中的单个或多个文件 备份粒度 SFS Turbo文件系统 文件 存储库类型 SFS Turbo备份存储库 混合云备份存储库 推荐场景 需要对SFS Turbo文件系统的数据进行保护，备份数据与文件系统分开存放，可以使用备份创建新的文件系统 需要对云上服务器和用户数据中心虚拟机或服务器中的单个或多个文件进行单独备份，能够在云上进行备份和恢复。

约束限制 如果备份文件时，该文件正在被其他应用更改，且备份客户端对其有读权限时，会导致备份数据不完整，建议应用层停止更改后再进行备份操作，保证数据的完整性。 如果备份文件时，该文件被其他进程使用或者备份客户端没有读权限，会导致备份数据不完整。 不建议对正在运行的应用程序的文件进行恢复，建议停止应用程序运行后再执行恢复操作。 单个安装客户端的资源最多支持添加8个备份文件目录。 每个资源仅允许安装一个客户端。 支持在无限制个资源上安装客户端。 单个目录下文件数不超过50万个，建议执行文件备份的主机配备4GB以上可用内存。 备份路径的长度不超过200个字符。 文件备份数据传输带宽上限是16Gbit/s。如果带宽达到该阈值，请求会触发流控。 文件备份不支持对云服务器挂载的SFS文件系统中的文件数据进行备份。 操作系统为Windows的主机/服务器中文件写入频繁的目录，可能会出现备份失败的情况。 跨云或跨区域场景下，网络带宽不低于50Mbits。

文件备份适用范围 支持本地主机的操作系统列表如表1所示。 表1 文件集备份支持的操作系统 操作系统类型 版本范围 Windows Server Windows Server 2019 for x86_64 Windows Server 2016 for x86_64 Windows Server 2012 for x86_64 Windows Windows 10 Windows 7 CentOS CentOS 7 Euler Euler OS 2.5

URI DELETE /V1.0/{project_id}/resource-groups/{group_id} 参数说明 表1 参数说明 名称 类型 是否必选 说明 project_id String 是 项目ID。 获取方式请参见获取项目ID。 group_id String String 资源分组ID。 请求样例： DELETE https://{ 云监控 的endpoint}/V1.0/{project_id}/resource-groups/{group_id}

返回值 正常 204 异常 返回值 说明 400 Bad Request 请求错误。 401 Unauthorized 未提供认证信息，或认证信息错误。 403 Forbidden 请求页面被禁止访问。 408 Request Timeout 请求超出了服务器的等待时间。 429 Too Many Requests 当前请求过多。 500 Internal Server Error 请求未完成，服务异常。 503 Service Unavailable 系统暂时不可用，请求受限。

修订记录 发布日期 修订记录 2024-11-6 第七次正式发布。 修改如下章节： 添加连接器用户入参role_list枚举值变更。 归档接收的合约数据入参data_packet_id变更为data_packet_ids，参数类型变更为Array of strings。 查询合约列表入参status增加枚举值CLOSED（到期关闭）。 上架offer入参data_resource_list的data_artifact_id属性修改为非必填。 订阅offer入参where由数组更改为device_ip、device_mac属性。 点对点生成合约入参删除mask_sensitive。 更新错误码。 删除如下章节： 查询应用中用户绑定的资源列表 提交合约 下载文件 资产使用次数统计 查询指定连接器的数据接收者列表 2024-5-30 第六次正式发布。 修改如下章节： 查询offer详情（不限连接器）出参增加subscription_type参数。 查询指定offer详情出参增加subscription_type参数。 2024-4-28 第五次正式发布。 新增如下章节： 移除空间成员 连接器收回 查询连接器数据主权保护倡议 签署连接器数据主权保护倡议 查询应用中用户绑定的资源列表 修改如下章节： 查询指定租户的连接器详情出参增加protocol_signed参数。 查询用户实例列表接口出参增加administrator_user_id参数。 更新错误码。 2024-3-15 第四次正式发布。 新增如下章节： 资产使用次数统计 修改如下章节： 修改搜索offer列表（不限连接器）、查询offer详情（不限连接器）、 查询指定offer详情、订阅Offer、查询合约详情接口的限制使用时间参数（when）和策略的扩展属性参数（additional_attributes）类型。 查询用户连接器列表，查询连接器列表接口出参新增protocol_signed参数。 实例添加客租户接口入参增加iam_user_id和iam_user_name参数。 2024-1-31 第三次正式发布。 新增如下章节： 查询指定offer资源列表（指定连接器） 查询用户实例列表 查询指定连接器下的团队列表 查询指定连接器的数据接收者列表 修改如下章节： 错误码，新增错误码EDS.00031013、EDS.00031014、EDS.00031015、EDS.00031016、EDS.00031017、EDS.00031018、EDS.00031020。 修改查询搜索条件（不限连接器）、搜索offer列表（不限连接器）、查询指定offer资源列表（不限连接器）、查询指定连接器下的offer列表、我的订阅、订阅待审批列表、查询合约列表、查询接收的合约数据、查看实例化应用列表、查询应用模板列表、查询数据资产的审计日志列表、查询数据资产统计列表、查询用户连接器列表、查询连接器列表等接口的limit参数说明。 查询指定offer详情接口出参增加offer_status参数。 查询用户连接器列表接口出参增加create_user_id、create_user_name、connector_owner_name、connector_owner_Id参数。 查询连接器列表接口出参增加create_user_id、create_user_name、connector_owner_name、connector_owner_Id参数 查询指定租户连接器详情接口出参增加create_user_id、create_user_name、connector_owner_name、connector_owner_Id参数。 订阅Offer接口入参增加user_type参数。 点对点生成合约接口入参删除deviceIps、deviceMacs参数。 上架offer接口入参删除deviceIps、deviceMacs参数。 2024-1-2 第二次正式发布。 新增如下章节： 查询搜索条件（不限连接器） 搜索offer列表（不限连接器） 查询offer详情（不限连接器） 查询指定offer资源列表（不限连接器） 上架offer 订阅Offer 我的订阅 撤销订阅 订阅待审批列表 审批订阅请求 查询合约列表 点对点生成合约 查询接收的合约数据 归档接收的合约数据 合约资产使用控制策略执行 查询应用模板列表 新增应用 查看实例化应用列表 下载文件 查询数据资产统计列表 实例添加客租户 连接器转让 添加连接器用户 修改如下章节： 应用内部授权，新增搜索offer列表（不限连接器）、查询搜索条件（不限连接器）、查询offer详情（不限连接器）、查询指定offer资源列表（不限连接器）、上架offer、我的订阅、订阅Offer、订阅待审批列表、审批订阅请求、撤销订阅、查询合约列表、点对点生成合约、查询接收的合约数据、归档接收的合约数据、合约资产使用控制策略执行、查看实例化应用列表、新增应用、查询应用模板列表、下载文件、连接器转让等API权限说明。 错误码，新增错误码EDS.00012301。 2023-08-28 第一次正式发布。

响应示例 状态码： 200 OK 应用模板列表。 { "data" : [ { "id" : "234ac118-d58e-4324-9d41-************", "name" : "PDF_JS", "description" : "用于预览PDF文件，仅供测试", "type" : "PDF_JS", "self" : null, "natives" : true, "operation" : [ "VIEW" ], "status" : "NORMAL", "icon" : "icon: data:image/png;base64,iVBORw0KGgoAAAAN*** // ***代表省略的图标编码", "create_time" : "2023-05-23T21:37:02Z" }, { "id" : "234c118-758e-4324-9d41-************", "name" : "本地下载", "description" : "用于将文件下载到本地", "type" : "LOCAL_DOWN", "self" : null, "natives" : true, "operation" : [ "DOWNLOAD" ], "status" : "NORMAL", "icon" : "icon: data:image/png;base64,iVBORw0KGgoAAAAN*** // ***代表省略的图标编码", "create_time" : "2023-05-23T21:37:02Z" } ], "total" : 2, "error_code" : null, "error_msg" : null }

URI GET /v1/{project_id}/eds/instances/{instance_id}/connectors/{connector_id}/applications/templates 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 获取方法请参考获取项目ID。 instance_id 是 String 实例ID，开通的交换数据平台实例ID。 获取方法请参考获取实例ID。 connector_id 是 String 连接器ID，指定交换数据平台下连接器的ID。 获取方法请参考获取连接器ID。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 偏移量，表示从此偏移量开始查询，offset大于等于0。 最小值：0 最大值：999999 缺省值：0 limit 否 Integer 每页显示条目数量，最大数量999，超过999后只返回999（防止单页返回过大）。 最小值：1 最大值：999 缺省值：10

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 data Array of ApplicationTemplate objects 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 表5 ApplicationTemplate 参数 参数类型 描述 id String 应用模板ID。 name String 应用模板名称。 description String 应用模板描述。 type String 应用模板类型： STRUCTURED：支持jdbc、csv下载 TRUSTED_ENV：支持可信环境下载 LOCAL_DOWN：支持本地下载 LUCKY_EXCEL：支持excel本地预览 UNSTRUCTURED：支持 obs、sftp、ftp下载 PDF_JS：支持pdf本地预览 STRUCTURED_VIEW：支持csv jdbc本地预览 WPS：wps应用 IMAGE_VIEWER：本地图片查看 枚举值： STRUCTURED TRUSTED_ENV LOCAL_DOWN LUCKY_EXCEL UNSTRUCTURED PDF_JS STRUCTURED_VIEW WPS IMAGE_VIEWER DATA_TABLE_PRO CES SING self Boolean 资源是否是自己的。 natives Boolean 是否内置应用 true：内置 false：自创 operation Array of strings 限制使用的操作。 枚举值： VIEW PROCESS DOWNLOAD status String 状态： NORMAL：正常使用状态 DISABLE：停用状态，不再分配给新的eds实例 枚举值： NORMAL DISABLE icon String 应用图标。 create_time String 创建时间。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 data Object 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 状态码： 500 表7 响应Body参数 参数 参数类型 描述 data Object 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。

基本概念 账号 用户注册时的账号，账号对其所拥有的资源及云服务具有完全的访问权限，可以重置用户密码、分配用户权限等。由于账号是付费主体，为了确保账号安全，建议您不要直接使用账号进行日常管理工作，而是创建用户并使用他们进行日常管理工作。 用户 由账号在 IAM 中创建的用户，是云服务的使用人员，具有身份凭证（密码和访问密钥）。 在我的凭证下，用户可以查看账号ID和IAM用户ID。通常在调用API的鉴权过程中，用户需要用到账号、用户和密码信息。 区域（Region） 从地理位置和网络时延维度划分，同一个Region内共享弹性计算、块存储、对象存储、VPC网络、弹性公网IP、镜像等公共服务。Region分为通用Region和专属Region，通用Region指面向公共租户提供通用云服务的Region；专属Region指只承载同一类业务或只面向特定租户提供业务服务的专用Region。 详情请参见区域和可用区。 可用区（AZ，Availability Zone） 一个可用区是一个或多个物理数据中心的集合，有独立的风火水电，AZ内逻辑上再将计算、网络、存储等资源划分成多个集群。一个Region中的多个AZ间通过高速光纤相连，以满足用户跨AZ构建高可用性系统的需求。 项目 区域默认对应一个项目，这个项目由系统预置，用来隔离物理区域间的资源（计算资源、存储资源和网络资源），以默认项目为单位进行授权，用户可以访问您账号中该区域的所有资源。如果您希望进行更加精细的权限控制，可以在区域默认的项目中创建子项目，并在子项目中创建资源，然后以子项目为单位进行授权，使得用户仅能访问特定子项目中的资源，使得资源的权限控制更加精确。 图1 项目隔离模型 同样在我的凭证下，您可以查看项目ID。 企业项目 企业项目是项目的升级版，针对企业不同项目间的资源进行分组和管理，具有逻辑隔离能力。企业项目中可以包含多个区域的资源，且项目中的资源可以迁入迁出。 关于企业项目ID的获取及企业项目特性的详细信息，请参见《企业管理用户指南》。

响应示例 状态码： 200 OK 新增应用返回体。 { "data" : { "type" : "UNSTRUCTURED", "name" : "OBS-APP-TEST", "id" : "22c59dd8-12ef-4ead-94ff-************", "temp_id" : "335ac118-758e-4324-9d41-************", "temp_name" : "文档下载", "natives" : false, "operation" : [ "DOWNLOAD" ], "description" : "abc", "icon" : "icon: data:image/png;base64,iVBORw0KGgoAAAAN*** // ***代表省略的图标编码", "connection" : { "datasource_type" : "OBS", "connection" : null }, "create_user_id" : "test-***********", "create_user_name" : "test-***********", "create_date" : "2023-12-05T18:27:52Z" }, "total" : 1, "error_code" : null, "error_msg" : null }

请求示例 新增应用。 POST https://{endpoint}/v1/{project_id}/eds/instances/{instance_id}/connectors/{connector_id}/applications { "type" : "UNSTRUCTURED", "name" : "OBS-APP-TEST", "temp_id" : "335ac118-758e-4324-9d41-************", "icon" : "icon: data:image/png;base64,iVBORw0KGgoAAAAN*** // ***代表省略的图标编码", "description" : "test", "connection" : { "datasource_type" : "OBS", "connection" : { "obs_connection" : { "endpoint" : "obs.************.huawei.com", "bucket_name" : "obs-***", "access_key" : "QA**************", "secret_key" : "8X**************", "path" : "obs-test/folder1" } } } }

响应参数 状态码： 200 表7 响应Body参数 参数 参数类型 描述 data AppInfo object 新增应用返回体。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 表8 AppInfo 参数 参数类型 描述 type String 实例化的应用类型： STRUCTURED：支持jdbc、csv下载 TRUSTED_ENV：支持可信环境下载 LOCAL_DOWN：支持本地下载 LUCKY_EXCEL：支持excel本地预览 UNSTRUCTURED：支持 obs、sftp、ftp下载 PDF_JS：支持pdf本地预览 STRUCTURED_VIEW：支持csv jdbc本地预览 WPS：wps应用 IMAGE_VIEWER：本地图片查看 枚举值： STRUCTURED TRUSTED_ENV LOCAL_DOWN LUCKY_EXCEL UNSTRUCTURED PDF_JS STRUCTURED_VIEW WPS IMAGE_VIEWER name String 应用名称。 id String 应用ID。 temp_id String 应用模板ID。 temp_name String 应用模板名称。 natives Boolean 是否内置应用 true：内置 false：自创 operation Array of strings 应用操作。 枚举值： VIEW PROCESS DOWNLOAD description String 应用描述。 icon String 应用图标。 connection DataSourceConnect object 应用连接信息。 create_user_id String 创建人ID。 create_user_name String 创建人名称。 create_date String 创建时间。 表9 DataSourceConnect 参数 参数类型 描述 datasource_type String 数据源类型。 枚举值： OBS connection DataSourceConnection object 数据源连接信息。 表10 DataSourceConnection 参数 参数类型 描述 obs_connection ObsConnection object OBS数据源连接信息。 表11 ObsConnection 参数 参数类型 描述 endpoint String OBS访问地址。 参数校验规则：最小长度1，最大长度1000，匹配域名正则表达式。 bucket_name String OBS名称。 参数校验规则：最小长度1，最大长度100，匹配字母、数字、下划线、.及-。 access_key String OBS永久访问密钥。 参数校验规则：最大长度1024。 secret_key String OBS永久密钥。 参数校验规则：最大长度1024。 path String OBS访问路径。 参数校验规则：最小长度1，最大长度100，只能包含英文字母、数字、下划线、中文、/、\及-。 状态码： 400 表12 响应Body参数 参数 参数类型 描述 data Object 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 状态码： 500 表13 响应Body参数 参数 参数类型 描述 data Object 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token，通过调用IAM服务“获取用户Token”接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 type 是 String 应用模板类型： STRUCTURED：支持jdbc、csv下载 TRUSTED_ENV：支持可信环境下载 LOCAL_DOWN：支持本地下载 LUCKY_EXCEL：支持excel本地预览 UNSTRUCTURED：支持 obs、sftp、ftp下载 PDF_JS：支持pdf本地预览 STRUCTURED_VIEW：支持csv jdbc本地预览 WPS：wps应用 IMAGE_VIEWER：本地图片查看 枚举值： STRUCTURED TRUSTED_ENV LOCAL_DOWN LUCKY_EXCEL UNSTRUCTURED PDF_JS STRUCTURED_VIEW WPS IMAGE_VIEWER name 是 String 应用名称。 temp_id 是 String 应用模板ID。 description 否 String 应用描述。 icon 否 String 应用图标。 connection 是 DataSourceConnect object 数据源连接信息。 表4 DataSourceConnect 参数 是否必选 参数类型 描述 datasource_type 否 String 数据源类型。 枚举值： OBS connection 否 DataSourceConnection object 数据源连接信息。 表5 DataSourceConnection 参数 是否必选 参数类型 描述 obs_connection 否 ObsConnection object OBS数据源连接信息。 表6 ObsConnection 参数 是否必选 参数类型 描述 endpoint 否 String OBS访问地址。 参数校验规则：最小长度1，最大长度1000，匹配域名正则表达式。 bucket_name 否 String OBS名称。 参数校验规则：最小长度1，最大长度100，匹配字母、数字、下划线、.及-。 access_key 否 String OBS永久访问密钥。 参数校验规则：最大长度1024。 secret_key 否 String OBS永久密钥。 参数校验规则：最大长度1024。 path 否 String OBS访问路径。 参数校验规则：最小长度1，最大长度100，只能包含英文字母、数字、下划线、中文、/、\及-。

URI POST /v1/{project_id}/eds/instances/{instance_id}/connectors/{connector_id}/applications 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 获取方法请参考获取项目ID。 instance_id 是 String 实例ID，开通的交换数据平台实例ID。 获取方法请参考获取实例ID。 connector_id 是 String 连接器ID，指定交换数据平台下连接器的ID。 获取方法请参考获取连接器ID。

脚本配置示例 { "cache_key": { "system_params": [ "$context.sourceIp", "$context.requestId" ], "parameters": [ "demo_parameters" ], "headers": [ "demo_header" ] }, "cache_http_status_and_ttl": [ { "http_status": [ 200 ], "ttl": 300 } ], "client_cache_control": { "mode": "apps", "datas": [ "demo_app_id_1,demo_app_id_2" ] }, "cacheable_headers": [ "demo_cacheable_headers_1,demo_cacheable_headers_2" ] }

创建集成应用 登录ROMA Connect控制台，在“实例”页面单击实例上的“查看控制台”，进入实例控制台。 在左侧的导航栏选择“集成应用”，单击页面右上角的“创建集成应用”。 在创建集成应用弹窗填写应用信息，完成后单击“确认”。 参数 配置说明 名称 自定义应用名称。 描述 填写对该应用的描述内容，选填项。 Key 集成应用的Key，若未指定则由系统自动生成。 Secret 集成应用的Secret，若未指定则由系统自动生成。

查看和编辑集成应用 在实例控制台的“集成应用”页面中，单击集成应用的名称，可查看该集成应用的详细信息。 图1 查看应用 表1 集成应用信息说明 内容 内容说明 基本信息 集成应用的基本参数信息，包括名称、描述、所属、创建时间、Key和Secret，其中Key和Secret可用于该集成应用下资源的访问认证。 您可以根据实际需要修改“名称”和“描述”信息。 您可以单击Secret右侧的“”查看Secret信息。 您可以根据实际需要重置密码，重置后旧密码自动失效。 对于账号用户，集成应用的所属均为“自建应用”。对于IAM用户，自己创建的集成应用为“自建应用”，其他IAM用户创建并授权的集成应用为“授权应用”。 对象 可查看和管理本集成应用下的资源，包括数据源、API、Topic和设备，您可对本集成应用下的资源进行创建、编辑、删除等操作，具体操作指导请参考数据源、API、Topic和设备的使用指导。

集成应用概述 ROMA Connect通过集成应用来实现同一实例内不同用户间的资源隔离。用户在ROMA Connect实例中创建的资源（如数据源、API、Topic、产品等）都要有归属的集成应用，非管理员权限（Tenant Administrator权限）的IAM用户默认只能查看和管理自己创建的集成应用和资源，无法查看其他IAM用户创建的集成应用和资源，管理员权限的用户可查看和管理其下所有IAM用户所创建的资源。 如果需要把自己创建的资源共享给其他IAM用户查看和使用，可通过将集成应用授权给其他IAM用户的方式实现，具体操作可查看配置集成应用授权。

操作步骤 登录ROMA Connect控制台，在“实例”页面单击实例上的“查看控制台”，进入实例控制台。 在左侧的导航栏选择“数据源管理”，单击页面右上角的“接入数据源”。 在接入数据源页面的“默认数据源”页签下，选择“FTP”类型的数据源，然后单击“下一步”。 在页面中配置数据源的连接信息。 表1 数据源连接信息 参数 配置说明 数据源名称 填写数据源的名称，根据规划自定义。建议您按照一定的命名规则填写数据源名称，方便您快速识别和查找。 编码格式 默认“utf-8”格式。 集成应用 选择数据源所归属的集成应用。 描述 填写数据源的描述信息。 协议 选择接入FTP数据源使用的协议，可选择“FTP”和“SFTP”。 连接地址 填写FTP数据源的连接地址和端口号。 用户名 FTP数据源的登录用户名。 密码 FTP数据源的登录密码。 连接模式 仅当“协议”选择“FTP”时需要配置。 选择FTP数据源的连接模式。 主动模式：FTP服务器主动连接客户端的数据端口。 被动模式：FTP服务器被动等待客户端连接自己的数据端口。 数据源的接入配置示例如下图所示。 图1 FTP数据源配置示例 完成数据源接入配置后，单击“开始检测”，检测ROMA Connect与数据源之间是否能够连通。 若测试结果为“数据源连接成功！”，则继续下一步。 若测试结果为“数据源连接失败！”，则检查数据源状态和数据源连接参数配置，然后单击“重新检测”，直到连接成功为止。 单击“创建”，完成数据源的接入。

响应示例 状态码： 200 OK { "id" : "5f918d104dc84480a75166ba99efff21", "tags" : [ "webApi" ], "arrange_necessary" : 2, "backend_type" : "HTTP", "auth_type" : "APP", "auth_opt" : { "app_code_auth_type" : "DISABLE" }, "backend_api" : { "update_time" : "2020-08-02T16:32:47.077028841Z", "vpc_channel_status" : 1, "vpc_channel_info" : { "vpc_channel_id" : "56a7d7358e1b42459c9d730d65b14e59", "vpc_channel_proxy_host" : "www.example.com" }, "url_domain" : "56a7d7358e1b42459c9d730d65b14e59", "req_protocol" : "HTTPS", "id" : "1ce8fda3586d4371bd83c955df37e102", "req_method" : "GET", "register_time" : "2020-07-31T12:42:51Z", "req_uri" : "/test/benchmark", "timeout" : 5000, "status" : 1, "retry_count" : "-1" }, "cors" : false, "status" : 1, "group_name" : "api_group_001", "group_id" : "c77f5e81d9cb4424bf704ef2b0ac7600", "group_version" : "V1", "match_mode" : "NORMAL", "name" : "Api_http", "req_protocol" : "HTTPS", "req_method" : "GET", "req_uri" : "/test/http", "type" : 1, "version" : "V0.0.1", "result_normal_sample" : "Example success response", "result_failure_sample" : "Example failure response", "register_time" : "2020-07-31T12:42:51Z", "update_time" : "2020-08-02T16:32:47.046288842Z", "remark" : "Web backend API", "backend_params" : [ { "name" : "X-CONSTANT-HEADER", "value" : "demo", "location" : "HEADER", "origin" : "CONSTANT", "remark" : "constant_demo", "id" : "8cb2eba19e7a4423a4e835647a8b8d76" }, { "name" : "app-id", "value" : "$context.appId", "location" : "HEADER", "origin" : "SYSTEM", "remark" : "App ID of the API caller", "id" : "216ddda836e74d528f364ff589d9dd21" } ] } 状态码： 400 Bad Request { "error_code" : "APIG.2011", "error_msg" : "Invalid parameter value,parameterName:name. Please refer to the support documentation" } 状态码： 401 Unauthorized { "error_code" : "APIG.1002", "error_msg" : "Incorrect token or token resolution failed" } 状态码： 403 Forbidden { "error_code" : "APIG.1005", "error_msg" : "No permissions to request this method" } 状态码： 404 Not Found { "error_code" : "APIG.3002", "error_msg" : "API 5f918d104dc84480a75166ba99efff21 does not exist" } 状态码： 500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error" }

请求示例 修改一个API，API认证方式为APP认证，后端配置使用负载通道 { "group_id" : "c77f5e81d9cb4424bf704ef2b0ac7600", "match_mode" : "NORMAL", "name" : "Api_http", "auth_type" : "APP", "backend_type" : "HTTP", "backend_api" : { "vpc_channel_status" : 1, "vpc_channel_info" : { "vpc_channel_id" : "56a7d7358e1b42459c9d730d65b14e59", "vpc_channel_proxy_host" : "www.example.com" }, "req_protocol" : "HTTPS", "req_method" : "GET", "req_uri" : "/test/benchmark", "timeout" : 5000, "retry_count" : "-1" }, "cors" : false, "req_protocol" : "HTTPS", "req_uri" : "/test/http", "remark" : "Web backend API", "type" : 1, "req_method" : "GET", "result_normal_sample" : "Example success response", "result_failure_sample" : "Example failure response", "backend_params" : [ { "name" : "X-CONSTANT-HEADER", "value" : "demo", "location" : "HEADER", "origin" : "CONSTANT", "remark" : "constant_demo" }, { "name" : "app-id", "value" : "$context.appId", "location" : "HEADER", "origin" : "SYSTEM", "remark" : "App ID of the API caller" } ], "tags" : [ "webApi" ] }

响应参数 状态码： 200 表15 响应Body参数 参数 参数类型 描述 name String API名称。 支持汉字、英文、数字、中划线、下划线、点、斜杠、中英文格式下的小括号和冒号、中文格式下的顿号，且只能以英文、汉字和数字开头，3-255个字符。 说明： 中文字符必须为UTF-8或者unicode编码。 type Integer API类型 1：公有API 2：私有API version String API的版本 最大长度：16 req_protocol String API的请求协议 HTTP HTTPS BOTH：同时支持HTTP和HTTPS GRPCS 缺省值：HTTPS req_method String API的请求方式，当API的请求协议为GRPC类型协议时请求方式固定为POST。 req_uri String 请求地址。可以包含请求参数，用{}标识，比如/getUserInfo/{userId}，支持 * / %- _ . 等特殊字符，总长度不超过512，且满足URI规范。 说明： 需要服从URI规范。 auth_type String API的认证方式 NONE：无认证 APP：APP认证 IAM：IAM认证 AUTHORIZER：自定义认证，当auth_type取值为AUTHORIZER时，authorizer_id字段必须传入 auth_opt AuthOpt object 认证方式参数 cors Boolean 是否支持跨域 TRUE：支持 FALSE：不支持 缺省值：false match_mode String API的匹配方式 SWA：前缀匹配 NORMAL：正常匹配（绝对匹配） 默认：NORMAL backend_type String 后端类型 HTTP：web后端 FUNCTION： 函数工作流 ，当backend_type取值为FUNCTION时，func_info字段必须传入 MOCK：模拟的后端，当backend_type取值为MOCK时，mock_info字段必须传入 GRPC：grpc后端 remark String API描述。字符长度不超过255 说明： 中文字符必须为UTF-8或者unicode编码。 group_id String API所属的分组编号 body_remark String API请求体描述，可以是请求体示例、媒体类型、参数等信息。字符长度不超过20480 说明： 中文字符必须为UTF-8或者unicode编码。 result_normal_sample String 正常响应示例，描述API的正常返回信息。字符长度不超过20480 说明： 中文字符必须为UTF-8或者unicode编码。 当API的请求协议为GRPC类型时不支持配置。 result_failure_sample String 失败返回示例，描述API的异常返回信息。字符长度不超过20480 说明： 中文字符必须为UTF-8或者unicode编码。 当API的请求协议为GRPC类型时不支持配置。 authorizer_id String 前端自定义认证对象的ID tags Array of strings 标签。 支持英文，数字，中文，特殊符号（-*#%.:_），且只能以中文或英文开头。 默认支持10个标签，如需扩大配额请联系技术工程师修改API_TAG_NUM_LIMIT配置。 最小长度：1 最大长度：128 response_id String 分组自定义响应ID roma_app_id String 集成应用ID 暂不支持 domain_name String API绑定的自定义域名 暂不支持 tag String 标签 待废弃，优先使用tags字段 content_type String 请求内容格式类型： application/json application/xml multipart/form-data text/plain is_send_fg_body_base64 Boolean 是否对与FunctionGraph交互场景的body进行Base64编码。仅当content_type为application/json时，可以不对body进行Base64编码。 应用场景： 自定义认证 绑定断路器插件，且断路器后端降级策略为函数后端 API后端类型为函数工作流 缺省值：true id String API编号 status Integer API状态 1： 有效 arrange_necessary Integer 是否需要编排 register_time String API注册时间 update_time String API修改时间 group_name String API所属分组的名称 group_version String API所属分组的版本 默认V1，其他版本暂不支持 缺省值：V1 run_env_id String 发布的环境编号 存在多个发布记录时，环境编号之间用|隔开 run_env_name String 发布的环境名称 存在多个发布记录时，环境名称之间用|隔开 publish_id String 发布记录编号 存在多个发布记录时，发布记录编号之间用|隔开 publish_time String 发布时间 存在多个发布记录时，发布时间之间用|隔开 roma_app_name String API归属的集成应用名称 暂不支持 ld_api_id String 当API的后端为自定义后端时，对应的自定义后端API编号 暂不支持 backend_api BackendApi object web后端详情 api_group_info ApiGroupCommonInfo object api分组信息 func_info ApiFunc object 函数工作流后端详情 mock_info ApiMock object mock后端详情 req_params Array of ReqParam objects API的请求参数列表 backend_params Array of BackendParam objects API的后端参数列表 policy_functions Array of ApiPolicyFunctionResp objects 函数工作流策略后端列表 policy_mocks Array of ApiPolicyMockResp objects mock策略后端列表 policy_https Array of ApiPolicyHttpResp objects web策略后端列表 表16 AuthOpt 参数 参数类型 描述 app_code_auth_type String AppCode简易认证类型，仅在auth_type为APP时生效，默认为DISABLE： DISABLE：不开启简易认证 HEADER：开启简易认证且AppCode位置在HEADER 缺省值：DISABLE 表17 BackendApi 参数 参数类型 描述 authorizer_id String 后端自定义认证对象的ID url_domain String 后端服务的地址。 由主机（IP或域名）和端口号组成，总长度不超过255。格式为主机:端口（如：apig.example.com:7443）。如果不写端口，则HTTPS默认端口号为443，HTTP默认端口号为80。 支持环境变量，使用环境变量时，每个变量名的长度为3 ~ 32位的字符串，字符串由英文字母、数字、下划线、中划线组成，且只能以英文开头 req_protocol String 请求协议，后端类型为GRPC时请求协议可选GRPC、GRPCS remark String 描述。字符长度不超过255 说明： 中文字符必须为UTF-8或者unicode编码。 req_method String 请求方式，后端类型为GRPC时请求方式固定为POST version String web后端版本，字符长度不超过16 req_uri String 请求地址。可以包含请求参数，用{}标识，比如/getUserInfo/{userId}，支持 * / %- _ . 等特殊字符，总长度不超过512，且满足URI规范。 支持环境变量，使用环境变量时，每个变量名的长度为3 ~ 32位的字符串，字符串由英文字母、数字、中划线、下划线组成，且只能以英文开头。 说明： 需要服从URI规范。 后端类型为GRPC时请求地址固定为/ timeout Integer API网关请求后端服务的超时时间。最大超时时间可通过实例特性backend_timeout配置修改，可修改的上限为600000。 单位：毫秒。 最小值：1 enable_client_ssl Boolean 是否开启双向认证 retry_count String 请求后端服务的重试次数，默认为-1，范围[-1,10]。 当该值为-1时，幂等的接口会重试1次，非幂等的不会重试。POST，PATCH方法为非幂等；GET，HEAD，PUT，OPTIONS和DELETE等方法为幂等的。 缺省值：-1 enable_sm_channel Boolean 是否启用SM商密通道。 仅实例支持SM系列商密算法的实例时支持开启。 id String 编号 status Integer 后端状态 1： 有效 register_time String 注册时间 update_time String 修改时间 vpc_channel_info VpcInfo object VPC通道详情。如果vpc_channel_status = 1，则这个object类型为必填信息 vpc_channel_status Integer 是否使用VPC通道 1：使用VPC通道 2：不使用VPC通道 表18 ApiGroupCommonInfo 参数 参数类型 描述 id String 编号 name String API分组名称 status Integer 状态 1： 有效 sl_domain String 系统默认分配的子域名 register_time String 创建时间 update_time String 最近修改时间 on_sell_status Integer 是否已上架云商店： 1：已上架 2：未上架 3：审核中 url_domains Array of UrlDomain objects 分组上绑定的独立域名列表 sl_domain_access_enabled Boolean 调试域名是否可以访问，true表示可以访问，false表示禁止访问 缺省值：true 表19 UrlDomain 参数 参数类型 描述 id String 域名编号 domain String 访问域名 cname_status Integer 域名cname状态： 1：未解析 2：解析中 3：解析成功 4：解析失败 ssl_id String SSL证书编号 ssl_name String SSL证书名称 min_ssl_version String 最小ssl协议版本号。支持TLSv1.1或TLSv1.2 缺省值：TLSv1.1 verified_client_certificate_enabled Boolean 是否开启客户端证书校验。只有绑定证书时，该参数才生效。当绑定证书存在trusted_root_ca时，默认开启；当绑定证书不存在trusted_root_ca时，默认关闭。 缺省值：false is_has_trusted_root_ca Boolean 是否存在信任的根证书CA。当绑定证书存在trusted_root_ca时为true。 缺省值：false ingress_http_port Integer 访问该域名绑定的http协议入方向端口，-1表示无端口且协议不支持，可使用80默认端口，其他有效端口允许的取值范围为1024~49151，需为实例已开放的HTTP协议的自定义入方向端口。 当创建域名时，该参数未填表示用默认80端口；如果填写该参数，则必须同时填写https_port；如果要http_port和https_port同时使用默认端口，则两个参数都不填。 当修改域名时，该参数未填表示不修改该端口。 最小值：-1 最大值：49151 ingress_https_port Integer 访问该域名绑定的https协议入方向端口，-1表示无端口且协议不支持，可使用443默认端口，其他有效端口允许的取值范围为1024~49151，需为实例已开放的HTTPS协议的自定义入方向端口。 当创建域名时，该参数未填表示用默认443端口；如果填写该参数，则必须同时填写http_port；如果要http_port和https_port同时使用默认端口，则两个参数都不填。 当修改域名时，该参数未填表示不修改该端口。 最小值：-1 最大值：49151 ssl_infos Array of SslInfo objects SSL证书列表。 表20 SslInfo 参数 参数类型 描述 ssl_id String SSL证书编号。 ssl_name String SSL证书名称。 algorithm_type String 证书算法类型： RSA ECC SM2 type String 证书可见范围： instance：当前实例 global：全局 缺省值：global 表21 ApiFunc 参数 参数类型 描述 function_urn String 函数URN remark String 描述信息。长度不超过255个字符 说明： 中文字符必须为UTF-8或者unicode编码。 invocation_type String 调用类型 async： 异步 sync：同步 network_type String 对接函数的网络架构类型 V1：非VPC网络架构 V2：VPC网络架构 version String 函数版本 当函数别名URN和函数版本同时传入时，函数版本将被忽略，只会使用函数别名URN 最大长度：64 alias_urn String 函数别名URN 当函数别名URN和函数版本同时传入时，函数版本将被忽略，只会使用函数别名URN timeout Integer API网关请求后端服务的超时时间。函数网络架构为V1时最大超时时间为60000，V2最大超时时间可通过实例特性backend_timeout配置修改，可修改的上限为600000。 单位：毫秒。 最小值：1 authorizer_id String 后端自定义认证ID req_protocol String 函数后端的请求协议：HTTPS、GRPCS，默认值为HTTPS，前端配置中的请求协议为GRPCS时可选GRPCS。 缺省值：HTTPS id String 编号 register_time String 注册时间 status Integer 后端状态 1： 有效 update_time String 修改时间 表22 ApiMock 参数 参数类型 描述 remark String 描述信息。长度不超过255个字符 说明： 中文字符必须为UTF-8或者unicode编码。 result_content String 返回结果 version String 版本。字符长度不超过64 authorizer_id String 后端自定义认证ID id String 编号 register_time String 注册时间 status Integer 后端状态 1： 有效 update_time String 修改时间 表23 ReqParam 参数 参数类型 描述 name String 参数名称。 长度为1 ~ 32位的字符串，字符串由英文字母、数字、中划线、下划线、英文句号组成，且只能以英文开头。 type String 参数类型 location String 参数位置 default_value String 参数默认值 sample_value String 参数示例值 required Integer 是否必须 1：是 2：否 location为PATH时，required默认为1，其他场景required默认为2 valid_enable Integer 是否开启校验 1：开启校验 2：不开启校验 缺省值：2 remark String 描述信息。长度不超过255个字符 说明： 中文字符必须为UTF-8或者unicode编码。 enumerations String 参数枚举值 min_num Integer 参数最小值 参数类型为NUMBER时有效 max_num Integer 参数最大值 参数类型为NUMBER时有效 min_size Integer 参数最小长度 参数类型为STRING时有效 max_size Integer 参数最大长度 参数类型为STRING时有效 regular String 正则校验规则 暂不支持 json_schema String JSON校验规则 暂不支持 pass_through Integer 是否透传 1：是 2：否 orchestrations Array of strings 请求参数匹配编排规则的生效优先级与列表顺序保持一致，列表中靠前的配置匹配优先级较高； 如果编排规则列表中包含none_value类型的规则，则none_value类型的规则优先级最高，至多绑定一个none_value类型的规则； 如果编排规则列表中包含default类型的规则，则default类型的规则优先级最低，至多绑定一个default类型的规则； 当编排规则为预处理策略时，该规则不能作为除default以外的最后一个编排规则； 每个API仅允许选择一个参数绑定编排规则，且编排规则不能重复，支持绑定的编排规则数量有配额限制，具体请参见产品介绍的“约束与限制”章节。 id String 参数编号 表24 ApiPolicyFunctionResp 参数 参数类型 描述 function_urn String 函数URN invocation_type String 调用类型 async： 异步 sync：同步 network_type String 对接函数的网络架构类型 V1：非VPC网络架构 V2：VPC网络架构 version String 函数版本 当函数别名URN和函数版本同时传入时，函数版本将被忽略，只会使用函数别名URN 最大长度：64 alias_urn String 函数别名URN 当函数别名URN和函数版本同时传入时，函数版本将被忽略，只会使用函数别名URN timeout Integer API网关请求后端服务的超时时间。函数网络架构为V1时最大超时时间为60000，V2最大超时时间可通过实例特性backend_timeout配置修改，可修改的上限为600000。 单位：毫秒。 最小值：1 req_protocol String 函数后端的请求协议：HTTPS、GRPCS，默认值为HTTPS，前端配置中的请求协议为GRPCS时可选GRPCS。 缺省值：HTTPS id String 编号 effect_mode String 关联的策略组合模式： ALL：满足全部条件 ANY：满足任一条件 name String 策略后端名称。字符串由中文、英文字母、数字、下划线组成，且只能以中文或英文开头。 最小长度：3 最大长度：64 backend_params Array of BackendParam objects 后端参数列表 conditions Array of CoditionResp objects 策略条件列表 authorizer_id String 后端自定义认证对象的ID 表25 ApiPolicyMockResp 参数 参数类型 描述 id String 编号 effect_mode String 关联的策略组合模式： ALL：满足全部条件 ANY：满足任一条件 name String 策略后端名称。字符串由中文、英文字母、数字、下划线组成，且只能以中文或英文开头。 最小长度：3 最大长度：64 backend_params Array of BackendParam objects 后端参数列表 conditions Array of CoditionResp objects 策略条件列表 authorizer_id String 后端自定义认证对象的ID result_content String 返回结果 表26 ApiPolicyHttpResp 参数 参数类型 描述 id String 编号 effect_mode String 关联的策略组合模式： ALL：满足全部条件 ANY：满足任一条件 name String 策略后端名称。字符串由中文、英文字母、数字、下划线组成，且只能以中文或英文开头。 最小长度：3 最大长度：64 backend_params Array of BackendParam objects 后端参数列表 conditions Array of CoditionResp objects 策略条件列表 authorizer_id String 后端自定义认证对象的ID url_domain String 策略后端的Endpoint。 由域名（或IP地址）和端口号组成，总长度不超过255。格式为域名:端口（如：apig.example.com:7443）。如果不写端口，则HTTPS默认端口号为443， HTTP默认端口号为80。 支持环境变量，使用环境变量时，每个变量名的长度为3 ~ 32位的字符串，字符串由英文字母、数字、“_”、“-”组成，且只能以英文开头。 req_protocol String 请求协议：HTTP、HTTPS、GRPC、GRPCS，后端类型为GRPC时可选GRPC、GRPCS req_method String 请求方式：GET、POST、PUT、DELETE、HEAD、PATCH、OPTIONS、ANY，后端类型为GRPC时固定为POST req_uri String 请求地址。可以包含请求参数，用{}标识，比如/getUserInfo/{userId}，支持 * / %- _ . 等特殊字符，总长度不超过512，且满足URI规范。 支持环境变量，使用环境变量时，每个变量名的长度为3 ~ 32位的字符串，字符串由英文字母、数字、中划线、下划线组成，且只能以英文开头。 说明： 需要服从URI规范。 后端类型为GRPC时请求地址固定为/ timeout Integer API网关请求后端服务的超时时间。最大超时时间可通过实例特性backend_timeout配置修改，可修改的上限为600000。 单位：毫秒。 最小值：1 retry_count String 请求后端服务的重试次数，默认为-1，范围[-1,10]。 当该值为-1时，幂等的接口会重试1次，非幂等的不会重试。POST，PATCH方法为非幂等；GET，HEAD，PUT，OPTIONS和DELETE等方法为幂等的。 缺省值：-1 enable_sm_channel Boolean 是否启用SM商密通道。 仅实例支持SM系列商密算法的实例时支持开启。 vpc_channel_info VpcInfo object VPC通道详情。如果vpc_channel_status = 1，则这个object类型为必填信息 vpc_channel_status Integer 是否使用VPC通道： 1： 使用VPC通道 2：不使用VPC通道 表27 BackendParam 参数 参数类型 描述 origin String 参数类别： 后端服务参数：REQUEST 常量参数：CONSTANT 系统参数：SYSTEM name String 参数名称。 字符串由英文字母、数字、中划线、下划线、英文句号组成，且只能以英文开头。 最小长度：1 最大长度：32 remark String 描述。字符长度不超过255 说明： 中文字符必须为UTF-8或者unicode编码。 location String 参数位置：PATH、QUERY、HEADER value String 参数值。字符长度不超过255 origin类别为REQUEST时，此字段值为req_params中的参数名称； origin类别为CONSTANT时，此字段值为参数真正的值； origin类别为SYSTEM时，此字段值为系统参数名称，系统参数分为网关内置参数、前端认证参数和后端认证参数，当api前端安全认证方式为自定义认证时，可以填写前端认证参数，当api开启后端认证时，可以填写后端认证参数。 网关内置参数取值及对应含义： $context.sourceIp：API调用者的源地址 $context.stage：API调用的部署环境 $context.apiId：API的ID $context.appId：API调用者的APP对象ID $context.requestId：当次API调用生成请求ID $context.serverAddr：网关的服务器地址 $context.serverName：网关的服务器名称 $context.handleTime：本次API调用的处理时间 $context.providerAppId：API拥有者的应用对象ID，暂不支持使用 前端认证参数取值：以“$context.authorizer.frontend.”为前缀，如希望自定义认证校验通过返回的参数为aaa，那么此字段填写为$context.authorizer.frontend.aaa 后端认证参数取值：以“$context.authorizer.backend.”为前缀，如希望自定义认证校验通过返回的参数为aaa，那么此字段填写为$context.authorizer.backend.aaa id String 参数编号 req_param_id String 对应的请求参数编号 表28 CoditionResp 参数 参数类型 描述 req_param_name String 关联的请求参数对象名称。策略类型为param时必选 sys_param_name String 系统参数-网关内置参数名称。策略类型为system时必选。支持以下参数 req_path：请求路径。如 /a/b req_method：请求方法。如 GET reqPath：请求路径，废弃。如 /a/b reqMethod：请求方法，废弃。如 GET cookie_param_name String COOKIE参数名称。策略类型为cookie时必选 最小长度：0 最大长度：255 frontend_authorizer_param_name String 系统参数-前端认证参数名称。策略类型为frontend_authorizer时必选，前端认证参数名称以"$context.authorizer.frontend."字符串为前缀。例如，前端认证参数名称为user_name，加上前缀为$context.authorizer.frontend.user_name。 condition_type String 策略条件 exact：绝对匹配 enum：枚举 pattern：正则 策略类型为param，system，cookie，frontend_authorizer时必选 condition_origin String 策略类型 param：参数 source：源IP system: 系统参数-网关内置参数 cookie: COOKIE参数 frontend_authorizer: 系统参数-前端认证参数 condition_value String 策略值。 最大长度：1024 mapped_param_name String 参数编排规则编排后生成的参数名称，当condition_origin为orchestration的时候必填，并且生成的参数名称必须在api绑定的编排规则中存在 mapped_param_location String 参数编排规则编排后生成的参数所在的位置，当condition_origin为orchestration的时候必填，并且生成的参数所在的位置必须在api绑定的编排规则中存在 id String 编号 req_param_id String 关联的请求参数对象编号 req_param_location String 关联的请求参数对象位置 表29 VpcInfo 参数 参数类型 描述 ecs_id String 云服务器ID ecs_name String 云服务器名称 cascade_flag Boolean 是否使用级联方式 暂不支持 vpc_channel_proxy_host String 代理主机 vpc_channel_id String VPC通道编号 vpc_channel_port Integer VPC通道端口 状态码： 400 表30 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 401 表31 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 403 表32 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 404 表33 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 500 表34 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述