CLI命令参考
域名解析及域名组管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 查询DNS服务器列表 | hcloud CFW ListDnsServers | 查询DNS服务器列表 | |
| 更新DNS服务器列表 | hcloud CFW UpdateDnsServers | 更新DNS服务器列表 | |
| 查询域名解析IP地址 | hcloud CFW ListDomainParseDetail | 测试域名有效性 | |
| 查询域名组列表 | hcloud CFW ListDomainSets | 查询域名组列表 | |
| 添加域名组 | hcloud CFW AddDomainSet | 添加域名组 | |
| 更新域名组 | hcloud CFW UpdateDomainSet | 更新域名组 | |
| 删除域名组 | hcloud CFW DeleteDomainSet | 删除域名组 | |
| 获取域名组下域名列表 | hcloud CFW ListDomains | 获取域名组下域名列表 | |
| 添加域名列表 | hcloud CFW AddDomains | 添加域名列表 | |
| 删除域名列表 | hcloud CFW DeleteDomains | 删除域名列表 | |
| 查看域名组详情 | hcloud CFW ShowDomainSetDetail | 查看域名组详情 | |
| 获取域名地址解析结果 | hcloud CFW ListDomainParseIp | 获取域名地址解析结果 | |
| 批量删除域名组 | hcloud CFW BatchDeleteDomainSet | 批量删除域名组 | |
| 添加指定DNS服务器 | hcloud CFW AddCustomDnsServer | 添加指定DNS服务器 | |
| 获取域名解析结果 | hcloud CFW ListDomainResolveIp | 获取域名解析结果 |
防火墙管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 查询防护VPC数 | hcloud CFW ListProtectedVpcs | 查询防护vpc信息 | |
| 获取东西向防火墙信息 | hcloud CFW ListEastWestFirewall | 获取东西向防火墙信息 | |
| 创建东西向防火墙 | hcloud CFW CreateEastWestFirewall | 创建东西向防火墙 | |
| 获取CFW任务执行状态 | hcloud CFW ListJob | 获取CFW任务执行状态 | |
| 删除防火墙 | hcloud CFW DeleteFirewall | 删除防火墙,仅按需生效 | |
| 标签创建接口 | hcloud CFW CreateTag | 创建标签 | |
| 删除标签 | hcloud CFW DeleteTag | 删除标签 | |
| 创建防火墙 | hcloud CFW CreateFirewall | 创建防火墙 | |
| 查询防火墙详细信息 | hcloud CFW ListFirewallDetail | 查询防火墙实例 | |
| 查询防火墙列表 | hcloud CFW ListFirewallList | 查询防火墙列表 | |
| 更改防火墙名称 | hcloud CFW UpdateFirewallName | 更改防火墙名称 | |
| 查询防火墙配额信息 | hcloud CFW ShowConfigQuota | 查询防火墙配额信息 | |
| 查询南北向防火墙防护状态 | hcloud CFW ShowSnFirewallProtectionStatus | 查询南北向防火墙防护状态 |
访问控制规则管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 获取规则击中次数 | hcloud CFW ListAclRuleHitCount | 获取规则击中次数 | |
| 删除规则击中次数 | hcloud CFW DeleteAclRuleHitCount | 清除规则击中次数 | |
| 创建ACL规则 | hcloud CFW AddAclRule | 创建ACL规则 | |
| 批量删除Acl规则 | hcloud CFW BatchDeleteAclRules | 批量删除Acl规则 | |
| 更新ACL规则 | hcloud CFW UpdateAclRule | 更新ACL规则 | |
| 删除ACL规则 | hcloud CFW DeleteAclRule | 删除ACL规则组 | |
| 查询防护规则 | hcloud CFW ListAclRules | 查询防护规则 | |
| ACL防护规则优先级设置 | hcloud CFW UpdateAclRuleOrder | ACL防护规则优先级设置 | |
| 批量更新规则动作 | hcloud CFW BatchUpdateAclRuleActions | 批量更新规则动作 | |
| 查询规则标签 | hcloud CFW ListRuleAclTags | 查询规则标签 | |
| 查看region列表 | hcloud CFW ListRegions | 查看region列表 | |
| 查看导入状态接口 | hcloud CFW ShowImportStatus | 查看导入状态接口 | |
| 导入访问控制规则 | hcloud CFW ImportRuleAcl | 导入访问控制规则 | |
| 导出访问控制规则 | hcloud CFW ExportRuleAcl | 导出访问控制规则 | |
| 下载导入模板 | hcloud CFW DownloadImportTemplate | 下载导入模板 | |
| 下载导出结果 | hcloud CFW DownloadExportResult | 下载导出结果 | |
| 查询导出结果 | hcloud CFW ShowExportStatus | 查询导出结果 | |
| 下载导入规则 | hcloud CFW DownloadImportResult | 下载导入规则 | |
| 获取规则的命中次数和最后一次命中时间 | hcloud CFW ListAclRuleHitStatus | 获取规则的命中次数和最后一次命中时间 |
IPS管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 查询IPS特性开关状态 | hcloud CFW ListIpsSwitchStatus | 查询IPS特性开关状态 | |
| IPS特性开关操作 | hcloud CFW ChangeIpsSwitchStatus | 切换开关状态 | |
| 查询防护模式 | hcloud CFW ListIpsProtectMode | 查询防护模式 | |
| 切换防护模式 | hcloud CFW ChangeIpsProtectMode | 切换防护模式 | |
| 改变IPS规则模式 | hcloud CFW ChangeIpsRuleMode | 改变IPS规则模式 | |
| 创建频率IPS规则 | hcloud CFW UpdateAdvancedIpsRule | 创建频率IPS规则 | |
| 查询频率IPS规则信息 | hcloud CFW ListAdvancedIpsRules | 查询频率IPS规则信息 | |
| 获取IPS规则列表 | hcloud CFW ListIpsRules | 获取IPS规则列表 | |
| 获取IPS规则细节 | hcloud CFW ShowIpsUpdateTime | 获取IPS规则细节 | |
| 查看自定义IPS规则列表 | hcloud CFW ListCustomerIps | 查看自定义IPS规则列表 | |
| 创建自定义IPS规则 | hcloud CFW CreateCustomerIps | 创建自定义IPS规则 | |
| 批量删除自定义IPS规则 | hcloud CFW BatchDeleteCustomerIps | 批量删除自定义IPS规则 | |
| 批量更新自定义IPS规则的动作 | hcloud CFW BatchUpdateCustomerIpsAction | 批量更新自定义IPS规则的动作 | |
| 查询自定义IPS规则详情 | hcloud CFW ShowCustomerIpsInfo | 功能说明:自定义IPS规则详情,特性:根据路径输入的IPS ID查看对应的自定义IPS详情 | |
| 更新自定义IPS规则 | hcloud CFW UpdateCustomerIps | 更新自定义IPS规则 |
日志管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 查询流日志 | hcloud CFW ListFlowLogs | 查询流日志 | |
| 查询访问控制日志 | hcloud CFW ListAccessControlLogs | 查询访问控制日志 | |
| 查询攻击日志 | hcloud CFW ListAttackLogs | 查询攻击日志 | |
| 获取日志配置 | hcloud CFW ListLogConfig | 获取日志配置 | |
| 创建日志配置 | hcloud CFW AddLogConfig | 创建日志配置 | |
| 更新日志配置 | hcloud CFW UpdateLogConfig | 更新日志配置 | |
| 查询防火墙日志 | hcloud CFW ListLogs | 查询防火墙日志 | |
| 导出防火墙日志 | hcloud CFW ExportLogs | 导出防火墙日志 |
黑白名单管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 创建黑白名单规则 | hcloud CFW AddBlackWhiteList | 创建黑白名单规则 | |
| 批量删除黑白名单列表 | hcloud CFW BatchDeleteBlackWhiteLists | 批量删除黑白名单列表 | |
| 更新黑白名单列表 | hcloud CFW UpdateBlackWhiteList | 更新黑白名单列表 | |
| 删除黑白名单规则 | hcloud CFW DeleteBlackWhiteList | 删除黑白名单规则 | |
| 查询黑白名单列表 | hcloud CFW ListBlackWhiteLists | 查询黑白名单列表 | |
| 批量添加黑白名单列表 | hcloud CFW BatchCreateBlackWhiteList | 批量添加黑白名单列表 |
服务组管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 新建服务组 | hcloud CFW AddServiceSet | 创建服务组 | |
| 查询服务组详情 | hcloud CFW ListServiceSetDetail | 查询服务组细节 | |
| 修改服务组 | hcloud CFW UpdateServiceSet | 更新服务组 | |
| 删除服务组 | hcloud CFW DeleteServiceSet | 删除服务组 | |
| 查询服务成员列表 | hcloud CFW ListServiceItems | 查询服务组成员列表 | |
| 新建服务成员 | hcloud CFW AddServiceItems | 批量添加服务组成员 | |
| 批量删除服务组成员信息 | hcloud CFW BatchDeleteServiceItems | 批量删除服务组成员信息 | |
| 获取服务组列表 | hcloud CFW ListServiceSets | 获取服务组列表 | |
| 删除服务组成员 | hcloud CFW DeleteServiceItem | 删除服务组成员 | |
| 批量删除服务组 | hcloud CFW BatchDeleteServiceSets | 批量删除服务组 |
EIP管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 查询EIP数量 | hcloud CFW ListEipCount | 查询EIP数量 | |
| 弹性IP开启关闭 | hcloud CFW ChangeEipStatus | 开启关闭EIP,客户购买EIP后首次开启EIP防护前需使用ListEips同步EIP资产,sync字段设置为1。 | |
| 弹性IP列表查询 | hcloud CFW ListEips | 弹性IP列表查询 | |
| 查看EIP告警白名单 | hcloud CFW ListAlarmWhitelist | 查看EIP告警白名单 | |
| 修改EIP自动防护开关 | hcloud CFW SwitchAutoProtectStatus | 修改EIP自动防护开关 | |
| 获取EIP自动防护状态信息 | hcloud CFW ShowAutoProtectStatus | 获取EIP自动防护状态信息 | |
| 一键逃生/一键恢复开关 | hcloud CFW SwitchFirewallEipProtection | 一键逃生/一键恢复开关 | |
| 添加EIP告警白名单 | hcloud CFW AddEipAlarmWhitelist | 添加EIP告警白名单 |
地址组管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 查询地址组成员 | hcloud CFW ListAddressItems | 查询地址组成员 | |
| 添加地址组成员 | hcloud CFW AddAddressItem | 添加地址组成员 | |
| 批量删除地址组成员 | hcloud CFW BatchDeleteAddressItems | 批量删除地址组成员 | |
| 添加地址组 | hcloud CFW AddAddressSet | 添加地址组 | |
| 查询地址组列表 | hcloud CFW ListAddressSets | 查询地址组列表 | |
| 查询地址组详细信息 | hcloud CFW ListAddressSetDetail | 查询地址组详细 | |
| 更新地址组信息 | hcloud CFW UpdateAddressSet | 更新地址组信息 | |
| 删除地址组 | hcloud CFW DeleteAddressSet | 删除地址组 | |
| 更新对象配置描述 | hcloud CFW UpdateObjectConfigDesc | 更新对象配置描述 | |
| 删除地址组成员 | hcloud CFW DeleteAddressItem | 删除地址组成员 | |
| 批量删除地址组 | hcloud CFW BatchDeleteAddressSets | 批量删除地址组 |
抓包管理
反病毒管理
告警配置管理
标签管理
流量过滤
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 导入IP黑名单用于流量过滤 | hcloud CFW ImportIpBlacklist | 此接口用来导入IP黑名单,IP列表保存在request的body中,IP列表支持的格式如下: | |
| 获取导入的IP黑名单列表信息 | hcloud CFW ListIpBlacklist | 获取防火墙实例中已经导入的IP黑名单信息,标准版防火墙只会显示一条EIP的记录,专业版防火墙可能显示EIP、NAT或EIP和NAT的记录,根据导入的情况确定。 | |
| 删除已经导入的IP黑名单 | hcloud CFW DeleteIpBlacklist | 删除流量过滤功能下已经导入的IP黑名单,指定生效范围进行删除。 标准版的墙只会存在生效范围为EIP的IP黑名单,专业版的墙会存在生效范围为EIP和NAT的IP黑名单。 | |
| 导出用于流量过滤的IP黑名单 | hcloud CFW ExportIpBlacklist | 指定IP黑名单的名字进行导出,当前只有两种文件名,在EIP生效的文件名为ip-blacklist-eip.txt,在 NAT生效的文件名为ip-blacklist-nat.txt。 | |
| 用于流量过滤的IP黑名单导入失败后进行重新导入 | hcloud CFW RetryIpBlacklist | 用于流量过滤的IP黑名单导入失败后,调用此接口进行重试。 | |
| 获取流量过滤功能的开关信息 | hcloud CFW ListIpBlacklistSwitch | 流量过滤功能可以打开或者关闭,通过此接口可以获取当前的开关信息。 | |
| 开启或者关闭流量过滤的IP黑名单功能 | hcloud CFW EnableIpBlacklist | 开启或者关闭流量过滤功能,当前流量过滤是通过导入IP黑名单实现的。 |
VPC间防火墙管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 更新VPC间防火墙防护状态 | hcloud CFW ChangeEastWestFirewallStatus | 更新VPC间防火墙防护状态 | |
| 查询VPC边界防火墙使用的引流VPC信息 | hcloud CFW ShowEwAssociatedVpc | 查询VPC边界防火墙使用的引流VPC信息 | |
| 查询VPC间防火墙使用的企业路由器信息 | hcloud CFW ShowEwAssociatedEr | 查询VPC间防火墙使用的企业路由器信息 | |
| 获取私网网段的信息 | hcloud CFW ListPrivateNetworkSegments | 东西向私网网段查询接口 | |
| 更新私网网段 | hcloud CFW UpdatePrivateNetworkSegment | 更新私网网段的REST接口,主要特性: | |
| 创建私网网段 | hcloud CFW BatchCreatePrivateNetworkSegments | 添加私网网段的接口,添加私网网段后该网段的流量将引流到VPC防火墙防护 | |
| 删除私网网段信息 | hcloud CFW BatchDeletePrivateNetworkSegments | 删除私网网段的接口,根据用户输入的私网网段conf_id,删除对应ID的私网网段 |
IPS白名单管理
日志分析
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 查询流量趋势 | hcloud CFW ShowTrafficTrend | 查询流量趋势,包括南北向、EIP、东西向的流量趋势 | |
| 查询访问日志统计信息 | hcloud CFW ShowAccessTop | 获取访问日志的TOP统计信息,如TOP命中规则等 | |
| 查询攻击统计 | hcloud CFW ListAttackStatistic | 根据防火墙攻击日志,查询攻击统计信息 | |
| 查询攻击趋势 | hcloud CFW ShowAttackTrend | 查询攻击趋势 | |
| 查询攻击概览 | hcloud CFW ShowAttackTotal | 查询攻击概览 | |
| 查询日志数量 | hcloud CFW ShowLogsCount | 统计日志数量,如统计风险IP的数量 | |
| 查询流量日志统计详情 | hcloud CFW ShowFlowDetail | 查询流量日志统计详情,如统计某个源IP访问详情 | |
| 查询流量TOP统计 | hcloud CFW ShowFlowTop | 查询流量TOP统计 | |
| 查询流量日志统计 | hcloud CFW ListFlowStatistic | 查询流量日志统计 | |
| 查询会话趋势 | hcloud CFW ShowFlowTrend | 查询会话趋势 | |
| 查询攻击日志统计详情 | hcloud CFW ShowAttackDetail | 查询攻击日志统计详情 | |
| 查询攻击日志TOP统计 | hcloud CFW ShowAttackTop | 查询攻击日志TOP统计 | |
| 查询访问控制统计详情 | hcloud CFW ShowAccessDetail | 查询访问控制统计详情 |
多账号管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 查询账号列表 | hcloud CFW ListAccounts | 查询账号列表 | |
| 批量添加账号 | hcloud CFW BatchAddAccounts | 批量添加账号 | |
| 批量移除账号 | hcloud CFW BatchRemoveAccounts | 批量移除账号 | |
| 开启多账号管理 | hcloud CFW EnableMultiAccount | 开启多账号管理 | |
| 查询组织账号列表 | hcloud CFW ListOrganizationAccounts | 查询组织账号列表 | |
| 查询组织结构 | hcloud CFW ListOrganizationTree | 查询组织结构 |
时间表管理
安全报告
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 查询安全报告模板列表 | hcloud CFW ListReportProfiles | 查询安全报告模板列表 | |
| 创建安全报告模板 | hcloud CFW CreateReportProfile | 创建安全报告模板 | |
| 获取安全报告模板 | hcloud CFW ShowReportProfile | 获取安全报告模板 | |
| 更新安全报告模板 | hcloud CFW UpdateReportProfile | 更新安全报告模板 | |
| 删除安全报告模板 | hcloud CFW DeleteReportProfile | 删除安全报告模板 | |
| 查询安全报告发送历史 | hcloud CFW ListReportHistory | 查询安全报告发送历史 | |
| 查询安全报告 | hcloud CFW ShowFirewallReport | 查询安全报告 |