API概览

本产品(Cloudfw/2017-12-07)的OpenAPI采用RPC签名风格,签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(78410016550),在专家指导下进行签名对接。

在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey

概览

API

标题

API概述

DescribeUserBuyVersion 获取用户云防火墙实例信息 获取用户版本信息。
DescribeInstanceRiskLevels 查询实例风险等级 查询实例风险等级。
ReleasePostInstance 释放按量付费防火墙 释放按量付费防火墙。
ReleaseExpiredInstance 释放已到期防火墙实例 释放已过期的实例
DescribePostpayTrafficTotal 查询后付费计费流量总计 查询后付费计费流量总计,包括各个边界防火墙。
DescribePostpayTrafficDetail 查询后付费计费流量明细 查询后付费计费流量明细。

防火墙开关

API

标题

API概述

互联网边界防火墙 互联网边界防火墙
DescribeAssetList 查询云防火墙防护的资产的信息 查询云防火墙防护的资产的信息。
DescribeAssetStatistic 获取资产统计信息 查询云防火墙防护的资产的统计信息。
DescribeAssetRiskList 获取资产风险等级列表 获取资产风险等级列表。
PutEnableFwSwitch 开启防火墙开关 开启防火墙开关。
PutEnableAllFwSwitch 开启所有防火墙开关 开启所有防火墙开关。
PutDisableFwSwitch 关闭防火墙开关 关闭防火墙开关。
PutDisableAllFwSwitch 关闭所有防火墙开关 关闭所有防火墙开关。
NAT边界防火墙 NAT边界防火墙
DescribeNatFirewallList 查询NAT防火墙 本接口用于获取NAT边界防火墙的详细信息。
CreateSecurityProxy 创建NAT防火墙 创建NAT防火墙。
SwitchSecurityProxy 开/关NAT防火墙 开/关NAT防火墙。
DeleteSecurityProxy 删除NAT防火墙 删除NAT防火墙。
VPC边界防火墙 VPC边界防火墙
高速通道 高速通道
DescribeVpcFirewallList 获取高速通道防火墙列表 查询VPC边界防火墙(防护通过高速通道连接的两个VPC之间的流量)的信息。
DescribeVpcFirewallDetail 查询VPC边界防火墙的详情 查询VPC边界防火墙(防护通过高速通道连接的两个VPC之间的流量)的详细信息。
CreateVpcFirewallConfigure 创建VPC边界防火墙 创建VPC边界防火墙(防护通过高速通道连接的两个VPC之间的流量)。
ModifyVpcFirewallConfigure 修改VPC边界防火墙的配置信息 修改VPC边界防火墙(防护通过高速通道连接的两个VPC之间的流量)的配置信息。
ModifyVpcFirewallSwitchStatus 修改VPC边界防火墙的开关状态 修改VPC边界防火墙(防护通过高速通道连接的两个VPC之间的流量)的开关状态。
DeleteVpcFirewallConfigure 删除VPC边界防火墙 删除VPC边界防火墙(防护通过高速通道连接的两个VPC之间流量)。
云企业网(基础版) 云企业网(基础版)
DescribeVpcFirewallCenList 查询云企业网(基础版)防火墙列表 查询VPC边界防火墙(防护云企业网内的网络实例和指定VPC之间的互访流量)的信息。
DescribeVpcFirewallCenDetail 查询VPC边界防火墙的详细信息 查询VPC边界防火墙(防护云企业网内的网络实例和指定VPC之间的互访流量)的详细信息。
CreateVpcFirewallCenConfigure 创建VPC边界防火墙 创建VPC边界防火墙(防护云企业网内的网络实例和指定VPC之间的互访流量)。
ModifyVpcFirewallCenConfigure 修改VPC边界防火墙的配置信息(云企业网) 修改VPC边界防火墙(防护云企业网内的网络实例和指定VPC之间的互访流量)的配置信息。
ModifyVpcFirewallCenSwitchStatus 修改VPC边界防火墙的开关状态(云企业网) 修改VPC边界防火墙(防护云企业网内的网络实例和指定VPC之间的互访流量)的开关状态。
DeleteVpcFirewallCenConfigure 删除VPC边界防火墙(云企业网) 删除VPC边界防火墙(防护云企业网内的网络实例和指定VPC之间的互访流量)。
云企业网(企业版) 云企业网(企业版)
DescribeTrFirewallsV2List 获取云企业网(企业版)防火墙列表 获取TR防火墙列表。
DescribeTrFirewallsV2Detail 获取TR防火墙详情 获取TR防火墙详情。
DescribeTrFirewallsV2RouteList 获取TR防火墙路由表列表 获取TR防火墙路由表列表。
DescribeTrFirewallV2RoutePolicyList 获取TR防火墙路由策略列表 获取TR防火墙路由策略列表。
DescribeTrFirewallPolicyBackUpAssociationList 获取TR防火墙恢复路由表 获取TR防火墙ACL备份。
CreateTrFirewallV2 创建TR防火墙 创建TR防火墙。
CreateTrFirewallV2RoutePolicy 创建TR防火墙路由规则 创建TR防火墙路由规则。
CreateVpcFirewallCenManualConfigure 创建VPC防火墙手动配置 创建VPC防火墙手动配置
ModifyTrFirewallV2Configuration 修改TR防火墙配置 修改TR防火墙配置。
ModifyFirewallV2RoutePolicySwitch 修改路由策略开关 修改路由策略开关。
ModifyTrFirewallV2RoutePolicyScope 修改TR防火墙路由策略范围 修改TR防火墙路由策略范围。
DeleteTrFirewallV2 删除TR防火墙 删除TR防火墙。
DeleteFirewallV2RoutePolicies 删除TR防火墙路由策略 删除TR防火墙路由策略。

流量分析

API

标题

API概述

DescribeUserAssetIPTrafficInfo 查询用户指定资产的流量信息 查询用户指定资产的流量信息。
DescribeOutgoingDomain 查询主动外联的域名信息 查询主动外联的域名信息。
DescribeOutgoingDestinationIP 查询主动外联的目的IP信息 查询主动外联的目的IP信息。
DescribeInternetOpenIp 获取防护资产暴露到互联网的IP 查询云防火墙访问控制策略组的详细信息。
DescribeInternetTrafficTrend 获取互联网流量趋势 获取互联网流量趋势。
DescribeNatFirewallTrafficTrend 获取NAT防火墙流量趋势 概览页-NAT流量趋势
AI访问流量 AI访问流量
DescribeAITrafficAnalysisStatus 查询AI流量分析开启状态 查询AI流量分析开启状态
UpdateAITrafficAnalysisStatus 修改AI流量分析开启状态 修改AI流量分析开启状态

检测响应

API

标题

API概述

入侵防御 入侵防御
DescribeRiskEventPayload 获取入侵防御事件的攻击payload 获取入侵防御事件的攻击Payload。
DescribeRiskEventGroup 获取入侵防御事件的详细数据 获取入侵防御事件的详细数据。
漏洞防护 漏洞防护
DescribeVulnerabilityProtectedList 获取漏洞防护列表 获取云防火墙支持防护的漏洞列表。
失陷感知 失陷感知
DescribeInvadeEventList 查询云防火墙失陷感知事件的信息 查询云防火墙失陷感知事件的信息。

防护配置

API

标题

API概述

访问控制 访问控制
互联网边界 互联网边界
DescribeControlPolicy 获取所有访问控制策略的信息 获取所有访问控制策略的信息。
DescribeACLProtectTrend 查询互联网访问控制拦截趋势图 查询互联网访问控制拦截趋势图。
DescribePolicyAdvancedConfig 查询访问控制策略严格模式的开启状态 查询访问控制策略严格模式的开启状态。
DescribePolicyPriorUsed 查询访问控制策略优先级使用范围 查询访问控制策略优先级生效范围。
DescribeDomainResolve 获取域名DNS的解析结果 获取域名DNS的解析结果。
AddControlPolicy 添加访问控制策略 添加访问控制策略。
ModifyControlPolicy 修改安全访问控制策略的配置信息 修改安全访问控制策略的配置信息。
ModifyControlPolicyPriority 修改访问控制策略的优先级 修改访问控制策略的优先级。
ModifyControlPolicyPosition 修改访问控制策略的优先级 修改互联网边界防火墙IPv4访问控制策略(表示访问控制策略中的访问源IP、目的IP使用IPv4格式)的优先级。
ModifyPolicyAdvancedConfig 开启或关闭访问控制策略严格模式 开启或关闭访问控制策略严格模式。
DeleteControlPolicy 删除访问控制策略 删除访问控制策略。
NAT边界 NAT边界
DescribeNatAclPageStatus 查询NAT防火墙分页状态 查询NAT防火墙分页状态。
DescribeNatFirewallControlPolicy 获取所有NAT防火墙访问控制策略的信息 获取所有NAT防火墙访问控制策略的信息。
DescribeNatFirewallPolicyPriorUsed 查询NAT防火墙访问控制策略优先级使用范围 查询NAT防火墙访问控制策略优先级生效范围。
CreateNatFirewallControlPolicy 添加NAT防火墙访问控制策略 添加NAT防火墙访问控制策略。
ModifyNatFirewallControlPolicy 修改NAT防火墙访问控制策略的配置信息 修改NAT防火墙安全访问控制策略的配置信息。
ModifyNatFirewallControlPolicyPosition 修改NAT防火墙访问控制策略的优先级 修改NAT防火墙访问控制策略的优先级。
ResetNatFirewallRuleHitCount 重置NAT防火墙命中数 重置NAT防火墙命中数。
DeleteNatFirewallControlPolicy 删除NAT防火墙访问控制策略 删除NAT防火墙访问控制策略。
DeleteNatFirewallControlPolicyBatch 批量删除NAT防火墙策略 批量删除NAT防火墙策略。
VPC边界 VPC边界
DescribeVpcFirewallAclGroupList 获取VPC防火墙所有访问控制策略组信息 获取VPC防火墙所有访问控制策略组信息。
DescribeVpcFirewallControlPolicy 查询指定的VPC边界防火墙的所有访问控制策略信息 查询指定的VPC边界防火墙的所有访问控制策略信息。
DescribeVpcFirewallPolicyPriorUsed 查询VPC防火墙策略组访问控制策略优先级生效范围 查询指定VPC防火墙策略组访问控制策略优先级生效范围。
CreateVpcFirewallControlPolicy 为指定VPC防火墙策略组添加访问控制策略 为指定VPC防火墙策略组添加访问控制策略。
ModifyVpcFirewallControlPolicy 修改VPC防火墙策略组的访问控制策略 修改指定VPC防火墙策略组的访问控制策略的配置信息。
ModifyVpcFirewallControlPolicyPosition 修改VPC防火墙策略组访问控制策略优先级 修改指定VPC防火墙策略组访问控制策略的优先级。
ResetVpcFirewallRuleHitCount VPC防火墙问控制策略命中计数清零 将指定的VPC防火墙策略组访问控制策略的命中计数清零。
DeleteVpcFirewallControlPolicy 删除VPC防火墙策略组访问控制策略 删除指定VPC防火墙策略组的访问控制策略。
BatchCopyVpcFirewallControlPolicy 从源VPC边界防火墙策略组拷贝所有策略到目标VPC边界防火墙策略组 从源VPC边界防火墙策略组拷贝所有策略到目标VPC边界防火墙策略组。
BatchDeleteVpcFirewallControlPolicy 批量删除VPC防火墙访问控制策略 批量删除VPC防火墙访问控制策略。
DNS边界 DNS边界
DescribeDnsFirewallPolicy 获取DNS防火墙ACL列表 获取DNS防火墙ACL列表
AddDnsFirewallPolicy 添加DNS防火墙ACL 添加DNS防火墙ACL
ModifyDnsFirewallPolicy 修改DNS防火墙规则 修改DNS防火墙规则
DeleteDnsFirewallPolicy 删除DNS防火墙规则 删除DNS防火墙规则
IPS防护 IPS防护
DescribeSignatureLibVersion 查询特征库版本信息 查询特征库版本信息。
互联网边界 互联网边界
DescribeDefaultIPSConfig 互联网IPS防护功能 互联网IPS防护功能。
ModifyDefaultIPSConfig 修改默认IPS配置 修改默认IPS配置。
VPC边界 VPC边界
DescribeVpcFirewallDefaultIPSConfig 获取指定VPC边界防火墙的入侵防御配置信息 获取指定VPC边界防火墙的入侵防御配置信息。
DescribeVpcFirewallIPSWhitelist 获取VPC防火墙IPS白名单 获取VPC防火墙IPS白名单。
ModifyVpcFirewallDefaultIPSConfig 修改VPC边界防火墙的入侵防御配置信息 修改VPC边界防火墙的入侵防御配置信息。
ModifyVpcFirewallIPSWhitelist 修改VPC防火墙IPS白名单 修改VPC防火墙IPS白名单。
地址簿 地址簿
DescribeAddressBook 查询访问控制策略地址簿 查询云防火墙访问控制策略地址簿的详细信息。
AddAddressBook 添加访问控制地址簿 添加安全访问控制地址簿,包括IP地址簿、ECS标签地址簿、端口地址簿和域名地址簿。
ModifyAddressBook 修改访问控制策略中设置的地址簿 修改地址簿。
DeleteAddressBook 删除安全访问控制的地址簿 删除访问控制地址簿。
同步节点 同步节点
DescribePrivateDnsEndpointList 查询私网DNS终端节点列表 查询私网DNS终端节点列表
DescribePrivateDnsEndpointDetail 查询私网DNS终端节点详情 查询私网DNS终端节点详情
ModifyPrivateDnsEndpoint 修改私网DNS终端节点 修改私网DNS终端节点
DeletePrivateDnsEndpoint 删除私网DNS终端节点 删除私网DNS终端节点
DescribePrivateDnsDomainNameList 查询私网DNS域名列表 查询私网DNS域名列表
AddPrivateDnsDomainName 添加私网DNS域名 添加私网DNS域名
DeletePrivateDnsDomainName 删除私网DNS域名 删除私网DNS域名
DeletePrivateDnsAllDomainName 清空私网DNS域名 清空私网DNS域名

日志监控

API

标题

API概述

DescribeLogStoreInfo 获取日志服务信息 获取日志服务信息。
CreateSlsLogDispatch 创建云防火墙SLS日志投递 创建云防火墙SLS日志投递。

系统设置

API

标题

API概述

多账号统一管理 多账号统一管理
DescribeInstanceMembers 获取云防火墙成员账号信息 获取云防火墙成员账号信息。
AddInstanceMembers 添加云防火墙成员账号 添加云防火墙成员账号。
ModifyInstanceMemberAttributes 更新云防火墙成员账号信息 更新云防火墙成员账号信息。
DeleteInstanceMembers 删除云防火墙成员账号 删除云防火墙成员账号。
下载任务 下载任务
DescribeDownloadTask 查询文件下载任务 查询文件下载任务,包括任务信息以及下载地址。
DescribeDownloadTaskType 查询文件下载任务类型 查询下载任务类型。对应下载任务相关接口中的TaskType字段。
CreateDownloadTask 创建文件下载任务 创建文件下载任务。
DeleteDownloadTask 删除文件下载任务 删除文件下载任务。

其他

API

标题

API概述

ModifyThreatIntelligenceSwitch 修改威胁情报配置的信息 修改威胁情报配置的信息
DescribeCfwRiskLevelSummary 查询防火墙风险等级 查询防火墙风险等级。
DescribePrefixLists 查询前缀列表 查询前缀列表。
DescribeVpcListLite 获取VPC列表 获取VPC列表。
DescribeVpcZone 查询VPC zone 查询VPC zone。
ModifyObjectGroupOperation 修改对象组操作 修改对象组操作。
DeleteControlPolicyTemplate 删除ACL模板 删除ACL模板。