响应示例 状态码： 200 添加acl响应 { "data" : { "rules" : [ { "id" : "0475c516-0e41-4caf-990b-0c504eebd73f", "name" : "testName" } ] } } 状态码： 400 Bad Request { "error_code" : "CFW.00900016", "error_msg" : "导入任务进行中，请任务结束后再操作" }

请求示例 示例为添加一个IPv4类型的外到内的规则，名称为测试规则，源类型为IP地址，地址为1.1.1.1，目的类型为IP地址，目的地址为2.2.2.2，服务类型为服务，协议类型为TCP，源端口为0，目的端口为0，不支持长连接，动作为放行，启用状态为启用 https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/acl-rule { "object_id" : "ae42418e-f077-41a0-9d3b-5b2f5ad9102b", "rules" : [ { "name" : "测试规则", "status" : 1, "action_type" : 0, "description" : "", "source" : { "type" : 0, "address" : "1.1.1.1" }, "destination" : { "type" : 0, "address" : "2.2.2.2" }, "service" : { "type" : 0, "protocol" : 6, "source_port" : "0", "dest_port" : "0" }, "address_type" : 0, "tag" : { "tag_key" : "", "tag_value" : "" }, "long_connect_enable" : 0, "direction" : 0, "sequence" : { "top" : 1, "dest_rule_id" : null } } ], "type" : 0 }

响应参数 状态码： 200 表13 响应Body参数 参数 参数类型 描述 data RuleIdList object 创建规则返回值data数据 表14 RuleIdList 参数 参数类型 描述 rules Array of RuleId objects 规则id列表 表15 RuleId 参数 参数类型 描述 id String 规则id name String 规则名称 状态码： 400 表16 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。可通过如何获取用户Token获取。 表4 请求Body参数 参数 是否必选 参数类型 描述 object_id 是 String 防护对象id，是创建 云防火墙 后用于区分互联网边界防护和VPC边界防护的标志id，可通过调用查询防火墙实例接口获得，通过返回值中的data.records.protect_objects.object_id（.表示各对象之间层级的区分）获得，注意type为0的为互联网边界防护对象id，type为1的为VPC边界防护对象id，type可通过data.records.protect_objects.type（.表示各对象之间层级的区分）获得 type 是 Integer 规则类型，0：互联网边界规则，1：vpc间规则，2：nat规则，当type取0时，规则源和目的地址需要为公网ip或 域名 ，vpc间规则需要源和目的地址为私有ip，nat规则需要源地址为私网ip，目的地址为公网ip或域名。 rules 是 Array of rules objects 添加规则请求规则列表 表5 rules 参数 是否必选 参数类型 描述 name 是 String 规则名称 sequence 是 OrderRuleAclDto object 修改规则顺序请求体 address_type 是 Integer 地址类型，0表示ipv4，1表示ipv6 action_type 是 Integer 规则动作，0表示允许通行（permit），1表示拒绝通行（deny） status 是 Integer 规则启用状态，0表示禁用，1表示启用 applications 否 Array of strings 规则应用列表，规则应用类型包括：“HTTP”，"HTTPS"，"TLS1"，“DNS”，“SSH”，“MYSQL”，“SMTP”，“RDP”，“RDPS”，“VNC”，“POP3”，“IMAP4”，“SMTPS”，“POP3S”，“FTPS”，“ANY”，“BGP”等。 long_connect_time 否 Long 长连接时长 long_connect_time_hour 否 Long 长连接时长对应小时 long_connect_time_minute 否 Long 长连接时长对应分钟 long_connect_time_second 否 Long 长连接时长秒 long_connect_enable 是 Integer 是否支持长连接，0表示不支持长连接，1表示支持长连接 description 否 String 描述 direction 否 Integer 方向：0表示外到内，1表示内到外，规则type=0（互联网规则）或者type= 2（nat规则）时方向值必填 source 是 RuleAddressDtoForRequest object 源地址传输对象 destination 是 RuleAddressDtoForRequest object 目的地址传输对象 service 是 RuleServiceDto object 服务对象 tag 否 TagsVO object 规则附带标签对象 表6 OrderRuleAclDto 参数 是否必选 参数类型 描述 dest_rule_id 否 String 目标规则id，添加规则位于此规则之后，非置顶时不能为空，置顶时为空，目标规则id可以通过查询防护规则接口获得，通过返回值中的data.records.rule_id（.表示各对象之间层级的区分）获得。 top 否 Integer 是否置顶，0代表非置顶，1代表置顶 bottom 否 Integer 是否置底，0代表非置底，1代表置底 表7 RuleAddressDtoForRequest 参数 是否必选 参数类型 描述 type 是 Integer 输入类型0手工输入，1关联IP地址组，2域名，3地理位置，4域名组，5多对象，6域名组-网络型，7域名组-应用型。 address_type 否 Integer 地址类型0 ipv4，1 ipv6，当type为0手动输入类型时不能为空 address 否 String IP地址信息，当type为0手动输入类型时不能为空 address_set_id 否 String 关联IP地址组ID，当type为1关联IP地址组类型时不能为空，可通过查询地址组列表接口查询获得，通过返回值中的data.records.set_id（.表示各对象之间层级的区分）获得。 address_set_name 否 String 关联IP地址组名称，当type为1关联IP地址组类型时不能为空，可通过查询地址组列表接口查询获得，通过返回值中的data.records.name（.表示各对象之间层级的区分）获得。 domain_address_name 否 String type为2（域名）和7（应用域名组）具体内容根据type中7修改后的类型名称 region_list_json 否 String 规则地域列表json值 region_list 否 Array of IpRegionDto objects 规则地域列表 domain_set_id 否 String 域名组id，type为4（域名组）或7（域名组-应用型）时不能为空。可通过查询域名组列表接口查询获得，通过返回值中的data.records.set_id（.表示各对象之间层级的区分）获得。 domain_set_name 否 String 域名组名称，type为4（域名组）或7（域名组-应用型）时不能为空。可通过查询域名组列表接口查询获得，通过返回值中的data.records.name（.表示各对象之间层级的区分）获得。 ip_address 否 Array of strings IP地址列表，当type为5（多对象）时不能为空。 address_set_type 否 Integer 地址组类型，当type为1（关联IP地址组）时不能为空。0表示自定义地址组，1表示WAF回源IP地址组，2表示DDoS回源IP地址组，3表示NAT64转换地址组 predefined_group 否 Array of strings 预定义地址组id列表，当type为5（多对象）时不能为空。地址组id可通过查询地址组列表接口查询获得，通过返回值中的data.records.set_id（.表示各对象之间层级的区分）获得。查询条件中query_address_set_type需要设置为1预定义地址组。 address_group 否 Array of strings 地址组id列表，当type为5（多对象）时不能为空。地址组id可通过查询地址组列表接口查询获得，通过返回值中的data.records.set_id（.表示各对象之间层级的区分）获得。查询条件中query_address_set_type需要设置为0自定义地址组。 表8 IpRegionDto 参数 是否必选 参数类型 描述 region_id 否 String 区域id，可通过获取账号、 IAM 用户、项目、用户组、区域、委托的名称和ID获取。 description_cn 否 String 区域中文描述，仅当区域为中国区域时使用，可通过地域信息表获取。 description_en 否 String 区域英文描述，仅当区域为非中国区域时使用，可通过地域信息表获取。 region_type 否 Integer 区域类型，0表示国家，1表示省份，2表示大洲，可通过地域信息表获取。 表9 RuleServiceDto 参数 是否必选 参数类型 描述 type 是 Integer 服务输入类型，0为手动输入类型，1为自动输入类型 protocol 否 Integer 协议类型：TCP为6，UDP为17，ICMP为1，ICMPV6为58，ANY为-1,type为0手动类型时不能为空。 protocols 否 Array of integers 协议列表，协议类型：TCP为6，UDP为17，ICMP为1，ICMPV6为58，ANY为-1,type为0手动类型时不能为空。 source_port 否 String 源端口 dest_port 否 String 目的端口 service_set_id 否 String 服务组id，当type为1（关联IP地址组）时不能为空，可通过获取服务组列表接口查询获得，通过返回值中的data.records.set_id（.表示各对象之间层级的区分）获得。 service_set_name 否 String 服务组名称,当type为1（关联IP地址组）时不能为空，可通过获取服务组列表接口查询获得，通过返回值中的data.records.name（.表示各对象之间层级的区分）获得。 custom_service 否 Array of ServiceItem objects 自定义服务 predefined_group 否 Array of strings 预定义服务组id列表，服务组id可通过获取服务组列表接口查询获得，通过返回值中的data.records.set_id（.表示各对象之间层级的区分）获得。查询条件中query_service_set_type需要设置为1预定义服务组。 service_group 否 Array of strings 服务组id列表，服务组id可通过获取服务组列表接口查询获得，通过返回值中的data.records.set_id（.表示各对象之间层级的区分）获得。查询条件中query_service_set_type需要设置为0自定义服务组。 service_group_names 否 Array of ServiceGroupVO objects 服务组名称列表 service_set_type 否 Integer 服务组类型，0表示自定义服务组，1表示常用WEB服务，2表示常用远程登录和PING，3表示常用数据库 表10 ServiceItem 参数 是否必选 参数类型 描述 protocol 否 Integer 协议类型：TCP为6，UDP为17，ICMP为1，ICMPV6为58，ANY为-1,RuleServiceDto.type为0时不能为空。 source_port 否 String 源端口 dest_port 否 String 目的端口 description 否 String 服务成员描述 name 否 String 服务成员名称 表11 ServiceGroupVO 参数 是否必选 参数类型 描述 name 否 String 服务组名称 protocols 否 Array of integers 协议列表，协议类型：TCP为6，UDP为17，ICMP为1，ICMPV6为58，ANY为-1 service_set_type 否 Integer 服务组类型，0表示自定义服务组，1表示预定义服务组 set_id 否 String 服务组id，可通过获取服务组列表接口查询获得，通过返回值中的data.records.set_id（.表示各对象之间层级的区分）获得。 表12 TagsVO 参数 是否必选 参数类型 描述 tag_id 否 String 规则id tag_key 否 String 规则标签键 tag_value 否 String 规则标签值

URI POST /v1/{project_id}/acl-rule 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID, 可以从调API处获取，也可以从控制台获取。项目ID获取方式 表2 Query参数 参数 是否必选 参数类型 描述 enterprise_project_id 否 String 企业项目ID，用户根据组织规划企业项目，对应的ID为企业项目ID，可通过如何获取企业项目ID获取，用户未开启企业项目时为0 fw_instance_id 否 String 防火墙id，可通过防火墙ID获取方式获取

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 否 String 发送的实体的MIME类型。默认使用application/json; charset=UTF-8。 缺省值：application/json; charset=UTF-8 最小长度：1 最大长度：64 X-Auth-Token 否 String 用户Token 最小长度：1 最大长度：16384

URI GET /v2/{project_id}/alarms 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户ID 最小长度：1 最大长度：64 表2 Query参数 参数 是否必选 参数类型 描述 alarm_id 否 String 告警规则ID 正则匹配：^al([0-9A-Za-z]){22}$ name 否 String 告警名称, 只能包含0-9/a-z/A-Z/_/-或汉字，长度1-128 最小长度：1 最大长度：128 正则匹配：^([\u4E00-\u9FFF]|[a-z]|[A-Z]|[0-9]|_|-)+$ namespace 否 String 查询服务的命名空间，各服务命名空间请参考“服务命名空间” 最大长度：32 正则匹配：^((([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_)*\.([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_)*)|)$ resource_id 否 String 告警资源ID，多维度情况按字母升序排列并使用逗号分隔。 最大长度：700 正则匹配：^([a-z]|[A-Z]|[0-9]|_|-|:|,|\.|)+$ enterprise_project_id 否 String 企业项目ID 正则匹配：^((([a-z]|[0-9]){8}-([a-z]|[0-9]){4}-([a-z]|[0-9]){4}-([a-z]|[0-9]){4}-([a-z]|[0-9]){12})|0)$ offset 否 Integer 分页偏移量 最小值：0 最大值：10000 缺省值：0 正则匹配：^([0]|[1-9]|[1-9][0-9]|[1-9][0-9][0-9]|[1-9][0-9][0-9][0-9]|10000)$ limit 否 Integer 分页大小 最小值：1 最大值：100 缺省值：10 正则匹配：^([1-9]|[1-9][0-9]|100)$

响应示例 状态码： 200 配置成功 { "rules" : [ { "app_id" : "123456789abcdefghijklmno", "rule_id" : "456789abc", "create_time" : "2006-01-02T15:04:05.075Z", "obs_addr" : { "bucket" : "obsName", "location" : "cn-north-4", "object" : "Record/", "project_id" : "ad7456ce8ef89adf567" }, "record_formats" : [ "MP4" ], "mp4_config" : { "record_cycle" : 60, "record_max_duration_to_merge_file" : 0 }, "update_time" : "2006-01-02T15:04:05.075Z" } ] } 状态码： 400 配置失败，语义有误，当前请求无法被服务器理解，或参数有误 { "error_code" : "RTC.00001003", "error_msg" : "InvalidParameterValue" } 状态码： 404 配置失败，应用不存在 { "error_code" : "RTC.00001003", "error_msg" : "InvalidParameterValue" } 状态码： 500 配置失败，服务器端错误 { "error_code" : "RTC.00002xxx", "error_msg" : "InternalError" }

响应参数 状态码： 200 表4 响应Header参数 参数 参数类型 描述 X-request-Id String 此字段携带请求ID号，以便任务跟踪。 表5 响应Body参数 参数 参数类型 描述 rules Array of RecordRule objects 录制规则列表 表6 RecordRule 参数 参数类型 描述 rule_id String 规则id，由服务端返回。创建或修改规则的时候不携带 app_id String 应用id obs_addr RecordObsFileAddr object 保存录制文件所在的桶信息 record_formats Array of strings 录制格式：HLS格式或者MP4格式 hls_config HLSRecordConfig object hls格式录制规则管理 mp4_config MP4RecordConfig object mp4格式录制规则管理 create_time String 创建时间，形如“2006-01-02T15:04:05.075Z”，时区为：UTC update_time String 更新时间，形如“2006-01-02T15:04:05.075Z”，时区为：UTC 表7 RecordObsFileAddr 参数 参数类型 描述 location String OBS Bucket所在RegionID cn-north-4 project_id String OBS Bucket所在Region的项目ID bucket String OBS的bucket名称 object String OBS对象路径，遵守OBS Object定义。如果为空则保存到根目录 表8 HLSRecordConfig 参数 参数类型 描述 record_cycle Integer 周期录制时长。 取值范围：[60，43200]或者0，如果为0则整个流录制为一个文件。 单位：秒。 record_prefix String 录制m3u8文件含路径和文件名的前缀 默认{app_id}/{record_format}/{stream}_{file_start_time}/{stream}_{file_start_time} 可自定义以下特殊变量： {app_id}：应用id {record_format}：录制格式 {stream}：流名 {file_start_time}：文件生成时间 record_slice_duration Integer 录制HLS时ts的切片时长，非必填。 取值范围：[2，60]，缺省为10。 单位：秒。 record_max_duration_to_merge_file Integer 录制HLS文件拼接时长，如果流中断超过该时间，则生成新文件。 取值范围：[-1，300]，缺省为0。 单位：秒。 如果为0表示流中断就生成新文件。 如果为-1则表示流中断恢复后追加到原来的文件中（相隔不超过30天）。 表9 MP4RecordConfig 参数 参数类型 描述 record_cycle Integer 周期录制时长。 取值范围：[60，10800]。 单位：秒。 record_prefix String 录制文件含路径和文件名的前缀。 默认{app_id}/{record_format}/{stream}_{file_start_time}/{stream}_{file_start_time} 可自定义以下特殊变量： {app_id}：应用id {record_format}：录制格式 {stream}：流名 {file_start_time}：文件生成时间 record_max_duration_to_merge_file Integer 录制MP4拼接时长，如果流中断超过该时间，则生成新文件。 取值范围：[0，300]，缺省为0。 单位：秒。 如果为0表示流中断就生成新文件。 状态码： 400 表10 响应Header参数 参数 参数类型 描述 X-request-Id String 此字段携带请求ID号，以便任务跟踪。 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 404 表12 响应Header参数 参数 参数类型 描述 X-request-Id String 此字段携带请求ID号，以便任务跟踪。 表13 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 500 表14 响应Header参数 参数 参数类型 描述 X-request-Id String 此字段携带请求ID号，以便任务跟踪。 表15 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 内容类型。 X-Auth-Token 否 String 用户Token。使用Token鉴权方式时必选。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 Authorization 否 String 使用AK/SK方式认证时必选，携带的鉴权信息。 X-Sdk-Date 否 String 使用AK/SK方式认证时必选，请求的发生时间。 X-Project-Id 否 String 使用AK/SK方式认证时必选，携带项目ID信息。

规则组随防护模式变更的默认动作对照表 - 观察模式 拦截模式-严格 拦截模式-中等 拦截模式-宽松 “观察”规则组 观察 禁用 禁用 禁用 “严格”规则组 观察 拦截 禁用 禁用 “中等”规则组 观察 拦截 拦截 禁用 “宽松”规则组 观察 拦截 拦截 拦截 观察：防火墙对匹配当前规则的流量，记录至攻击事件日志中，不做拦截。 拦截：防火墙对匹配当前规则的流量，记录至攻击事件日志中并进行拦截。 禁用：防火墙对匹配当前规则的流量，不记录、不拦截。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 参数说明：用户Token。通过调用IAM服务 获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 Instance-Id 否 String 参数说明：实例ID。物理多租下各实例的唯一标识，一般华为云租户无需携带该参数，仅在物理多租场景下从管理面访问API时需要携带该参数。您可以在IoTDA管理控制台界面，选择左侧导航栏“总览”页签查看当前实例的ID。 表3 请求Body参数 参数 是否必选 参数类型 描述 rule_name 否 String 参数说明：规则名称。 取值范围：长度不超过256，只允许中文、字母、数字、以及_?'#().,&%@!-等字符的组合 最小长度：1 最大长度：256 description 否 String 参数说明：用户自定义的规则描述。 最小长度：0 最大长度：256 subject 是 RoutingRuleSubject object 参数说明：资源事件信息。 app_type 否 String 参数说明：租户规则的生效范围，默认GLOBAL，。 取值范围： GLOBAL：生效范围为租户级。 APP：生效范围为资源空间级。如果类型为APP，创建的规则生效范围为携带的app_id指定的资源空间，不携带app_id则创建规则生效范围为默认资源空间。 app_id 否 String 参数说明：资源空间ID。。 取值范围：长度不超过36，只允许字母、数字、下划线（_）、连接符（-）的组合。 select 否 String 参数说明：用户自定义sql select语句，最大长度2500，该参数仅供标准版和企业版用户使用。可填参数可参考帮助文档数据流转下各接口的请求参数，如notify_data.body。 最小长度：0 最大长度：2500 where 否 String 参数说明：用户自定义sql where语句，最大长度2500，该参数仅供标准版和企业版用户使用,可填参数可参考帮助文档数据流转下各接口的请求参数，如notify_data.body。 最小长度：0 最大长度：2500 表4 RoutingRuleSubject 参数 是否必选 参数类型 描述 resource 是 String 参数说明：资源名称。 取值范围： device：设备。 device.property：设备属性。 device.message：设备消息。 device.message.status：设备消息状态。 device.status：设备状态。 batchtask：批量任务。 product：产品。 device.command.status：设备异步命令状态。 最小长度：1 最大长度：50 event 是 String 参数说明：资源事件。 取值范围：与资源有关，不同的资源，事件不同。event需要与resource关联使用，具体的“resource：event”映射关系如下： device：create（设备添加） device：delete（设备删除） device：update（设备更新） device.status：update （设备状态变更） device.property：report（设备属性上报） device.message：report（设备消息上报） device.message.status：update（设备消息状态变更） batchtask：update （批量任务状态变更） product：create（产品添加） product：delete（产品删除） product：update（产品更新） device.command.status：update（设备异步命令状态更新） 最小长度：1 最大长度：50

请求示例 创建规则触发条件，触发条件为设备创建通知。 POST https://{endpoint}/v5/iot/{project_id}/routing-rule/rules { "rule_name" : "rulename", "subject" : { "resource" : "device", "event" : "create" }, "app_type" : "GLOBAL", "description" : "description" } 创建规则触发条件，触发条件为属性上报。 POST https://{endpoint}/v5/iot/{project_id}/routing-rule/rules { "rule_name" : "rulename", "subject" : { "resource" : "device.property", "event" : "report" }, "app_type" : "GLOBAL", "description" : "description" } 创建规则触发条件，触发条件为消息上报(根据sql进行topic筛选，基础版不支持该sql筛选能力)。 POST https://{endpoint}/v5/iot/{project_id}/routing-rule/rules { "rule_name" : "rulename", "subject" : { "resource" : "device.message", "event" : "report" }, "app_type" : "GLOBAL", "description" : "description", "select" : "notify_data.header as header,notify_data.body as body,'12345678901234abcd' as id", "where" : "notify_data.body.topic = '$oc/devices/646c7579a5adc915f8966e8b_8514932826827763/user/testmsg'" }

响应示例 状态码： 201 Created { "rule_id" : "5bcaddda-75bf-4623-8c8d-26175c41fcca", "rule_name" : "rulename", "description" : "description", "subject" : { "resource" : "device", "event" : "create" }, "app_type" : "GLOBAL", "app_id" : "1a7ffc5cd89c44dd8265b1653d951ce0", "select" : "*", "where" : "product_id='d89c-44dd-8265-b1653d951ce0'", "active" : false }

响应参数 状态码： 201 表5 响应Body参数 参数 参数类型 描述 rule_id String 规则触发条件ID，用于唯一标识一个规则触发条件，在创建规则条件时由 物联网平台 分配获得。 rule_name String 用户自定义的规则名称。 最小长度：1 最大长度：256 description String 用户自定义的规则描述。 最小长度：1 最大长度：256 subject RoutingRuleSubject object 资源事件信息，即资源变化事件。 app_type String 租户规则的生效范围，取值如下： GLOBAL：生效范围为租户级 APP：生效范围为资源空间级。 app_id String 资源空间ID select String 用户自定义sql select语句，最大长度2500，该参数仅供标准版和企业版用户使用。 最小长度：0 最大长度：2500 where String 用户自定义sql where语句，最大长度2500，该参数仅供标准版和企业版用户使用。 最小长度：0 最大长度：2500 active Boolean 规则条件的状态是否为激活。 表6 RoutingRuleSubject 参数 参数类型 描述 resource String 参数说明：资源名称。 取值范围： device：设备。 device.property：设备属性。 device.message：设备消息。 device.message.status：设备消息状态。 device.status：设备状态。 batchtask：批量任务。 product：产品。 device.command.status：设备异步命令状态。 最小长度：1 最大长度：50 event String 参数说明：资源事件。 取值范围：与资源有关，不同的资源，事件不同。event需要与resource关联使用，具体的“resource：event”映射关系如下： device：create（设备添加） device：delete（设备删除） device：update（设备更新） device.status：update （设备状态变更） device.property：report（设备属性上报） device.message：report（设备消息上报） device.message.status：update（设备消息状态变更） batchtask：update （批量任务状态变更） product：create（产品添加） product：delete（产品删除） product：update（产品更新） device.command.status：update（设备异步命令状态更新） 最小长度：1 最大长度：50