文档

API概览

更新时间:
本产品(云防火墙/2017-12-07)的OpenAPI采用RPC签名风格,签名细节参见签名机制说明我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(11370001915),在专家指导下进行签名对接。
在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey

NAT防火墙

API标题API概述
DescribeNatFirewallList查询NAT防火墙本接口用于获取NAT边界防火墙的详细信息。
CreateSecurityProxy 创建NAT防火墙创建NAT防火墙。
DeleteSecurityProxy删除NAT防火墙删除NAT防火墙。
SwitchSecurityProxy开/关NAT防火墙开/关NAT防火墙。

防火墙开关

API标题API概述
DescribeAssetList查询云防火墙防护的资产的信息查询云防火墙防护的资产的信息。
PutDisableFwSwitch关闭防火墙开关关闭防火墙开关。
PutEnableAllFwSwitch开启所有防火墙开关开启所有防火墙开关。
PutEnableFwSwitch开启防火墙开关开启防火墙开关。
PutDisableAllFwSwitch关闭所有防火墙开关关闭所有防火墙开关。

访问控制

API标题API概述
NAT边界NAT边界
CreateNatFirewallControlPolicy添加NAT防火墙访问控制策略添加NAT防火墙访问控制策略。
DescribeNatFirewallControlPolicy获取所有NAT防火墙访问控制策略的信息获取所有NAT防火墙访问控制策略的信息。
DescribeNatFirewallPolicyPriorUsed查询NAT防火墙访问控制策略优先级使用范围查询NAT防火墙访问控制策略优先级生效范围。
ModifyNatFirewallControlPolicyPosition修改NAT防火墙访问控制策略的优先级修改NAT防火墙访问控制策略的优先级。
ModifyNatFirewallControlPolicy修改NAT防火墙访问控制策略的配置信息修改NAT防火墙安全访问控制策略的配置信息。
DeleteNatFirewallControlPolicy删除NAT防火墙访问控制策略删除NAT防火墙访问控制策略。
VPC边界VPC边界
CreateVpcFirewallControlPolicy为指定VPC防火墙策略组添加访问控制策略为指定VPC防火墙策略组添加访问控制策略。
BatchCopyVpcFirewallControlPolicy从源VPC边界防火墙策略组拷贝所有策略到目标VPC边界防火墙策略组从源VPC边界防火墙策略组拷贝所有策略到目标VPC边界防火墙策略组。
ResetVpcFirewallRuleHitCount将VPC防火墙问控制策略命中计数清零将指定的VPC防火墙策略组访问控制策略的命中计数清零。
DescribeVpcFirewallAclGroupList获取VPC防火墙所有访问控制策略组信息获取VPC防火墙所有访问控制策略组信息。
DescribeVpcFirewallPolicyPriorUsed查询VPC防火墙策略组访问控制策略优先级生效范围查询指定VPC防火墙策略组访问控制策略优先级生效范围。
DescribeVpcFirewallControlPolicy查询指定的VPC边界防火墙的所有访问控制策略信息查询指定的VPC边界防火墙的所有访问控制策略信息。
ModifyVpcFirewallControlPolicyPosition修改VPC防火墙策略组访问控制策略优先级修改指定VPC防火墙策略组访问控制策略的优先级。
ModifyVpcFirewallControlPolicy修改VPC防火墙策略组的访问控制策略修改指定VPC防火墙策略组的访问控制策略的配置信息。
DeleteVpcFirewallControlPolicy删除VPC防火墙策略组访问控制策略删除指定VPC防火墙策略组的访问控制策略。
互联网边界互联网边界
DescribeACLProtectTrend查询互联网访问控制拦截趋势图查询互联网访问控制拦截趋势图。
DescribePolicyAdvancedConfig查询访问控制策略严格模式的开启状态查询访问控制策略严格模式的开启状态。
ModifyPolicyAdvancedConfig开启或关闭访问控制策略严格模式开启或关闭访问控制策略严格模式。
DescribePolicyPriorUsed查询访问控制策略优先级使用范围查询访问控制策略优先级生效范围。
DescribeDomainResolve获取域名DNS的解析结果获取域名DNS的解析结果。
DescribeControlPolicy获取所有访问控制策略的信息获取所有访问控制策略的信息。
ModifyControlPolicyPosition修改访问控制策略的优先级修改互联网边界防火墙IPv4访问控制策略(表示访问控制策略中的访问源IP、目的IP使用IPv4格式)的优先级。
ModifyControlPolicy修改安全访问控制策略的配置信息修改安全访问控制策略的配置信息。
DeleteControlPolicy删除访问控制策略删除访问控制策略。
AddControlPolicy添加访问控制策略添加访问控制策略。

VPC边界防火墙

API标题API概述
入侵防御入侵防御
ModifyVpcFirewallDefaultIPSConfig修改VPC边界防火墙的入侵防御配置信息修改VPC边界防火墙的入侵防御配置信息。
DescribeVpcFirewallDefaultIPSConfig获取指定VPC边界防火墙的入侵防御配置信息获取指定VPC边界防火墙的入侵防御配置信息。
高速通道高速通道
DeleteVpcFirewallConfigure删除VPC边界防火墙删除VPC边界防火墙(防护通过高速通道连接的两个VPC之间流量)。
ModifyVpcFirewallConfigure修改VPC边界防火墙的配置信息修改VPC边界防火墙(防护通过高速通道连接的两个VPC之间的流量)的配置信息。
ModifyVpcFirewallSwitchStatus修改VPC边界防火墙的开关状态修改VPC边界防火墙(防护通过高速通道连接的两个VPC之间的流量)的开关状态。
DescribeVpcFirewallDetail查询VPC边界防火墙的详情查询VPC边界防火墙(防护通过高速通道连接的两个VPC之间的流量)的详细信息。
DescribeVpcFirewallList获取高速通道防火墙列表查询VPC边界防火墙(防护通过高速通道连接的两个VPC之间的流量)的信息。
CreateVpcFirewallConfigure创建VPC边界防火墙创建VPC边界防火墙(防护通过高速通道连接的两个VPC之间的流量)。
云企业网(基础版)云企业网(基础版)
CreateVpcFirewallCenConfigure创建VPC边界防火墙创建VPC边界防火墙(防护云企业网内的网络实例和指定VPC之间的互访流量)。
ModifyVpcFirewallCenSwitchStatus修改VPC边界防火墙的开关状态(云企业网)修改VPC边界防火墙(防护云企业网内的网络实例和指定VPC之间的互访流量)的开关状态。
ModifyVpcFirewallCenConfigure修改VPC边界防火墙的配置信息(云企业网)修改VPC边界防火墙(防护云企业网内的网络实例和指定VPC之间的互访流量)的配置信息。
DescribeVpcFirewallCenList查询云企业网(基础版)防火墙列表查询VPC边界防火墙(防护云企业网内的网络实例和指定VPC之间的互访流量)的信息。
DescribeVpcFirewallCenDetail查询VPC边界防火墙的详细信息查询VPC边界防火墙(防护云企业网内的网络实例和指定VPC之间的互访流量)的详细信息。
DeleteVpcFirewallCenConfigure删除VPC边界防火墙(云企业网)删除VPC边界防火墙(防护云企业网内的网络实例和指定VPC之间的互访流量)。
云企业网(企业版)云企业网(企业版)
DeleteFirewallV2RoutePolicies删除TR防火墙路由策略删除TR防火墙路由策略。
CreateTrFirewallV2创建TR防火墙创建TR防火墙。
CreateTrFirewallV2RoutePolicy创建TR防火墙路由规则创建TR防火墙路由规则。
DescribeTrFirewallsV2Detail获取TR防火墙详情获取TR防火墙详情。
DescribeTrFirewallsV2List获取云企业网(企业版)防火墙列表获取TR防火墙列表。
DescribeTrFirewallsV2RouteList获取TR防火墙路由表列表获取TR防火墙路由表列表。
DescribeTrFirewallV2RoutePolicyList获取TR防火墙路由策略列表获取TR防火墙路由策略列表。
DescribeTrFirewallPolicyBackUpAssociationList获取TR防火墙恢复路由表获取TR防火墙ACL备份。
ModifyTrFirewallV2Configuration修改TR防火墙配置修改TR防火墙配置。
ModifyFirewallV2RoutePolicySwitch修改路由策略开关修改路由策略开关。
ModifyTrFirewallV2RoutePolicyScope修改TR防火墙路由策略范围修改TR防火墙路由策略范围。
DeleteTrFirewallV2删除TR防火墙删除TR防火墙。

多账号管控

API标题API概述
AddInstanceMembers添加云防火墙成员账号添加云防火墙成员账号。
DeleteInstanceMembers删除云防火墙成员账号删除云防火墙成员账号。
ModifyInstanceMemberAttributes更新云防火墙成员账号信息更新云防火墙成员账号信息。
DescribeInstanceMembers获取云防火墙成员账号信息获取云防火墙成员账号信息。

攻击防护

API标题API概述
DescribeRiskEventPayload获取入侵防御事件的攻击payload获取入侵防御事件的攻击Payload。
DescribeVulnerabilityProtectedList获取漏洞防护列表获取云防火墙支持防护的漏洞列表。
DescribeRiskEventGroup获取入侵防御事件的详细数据获取入侵防御事件的详细数据。
DescribeUserAssetIPTrafficInfo查询用户指定资产的流量信息查询用户指定资产的流量信息。
DescribeInvadeEventList查询云防火墙失陷感知事件的信息查询云防火墙失陷感知事件的信息。
DescribeOutgoingDestinationIP查询主动外联的目的IP信息查询主动外联的目的IP信息。
DescribeOutgoingDomain查询主动外联的域名信息查询主动外联的域名信息。

地址簿

API标题API概述
AddAddressBook添加访问控制地址簿添加安全访问控制地址簿,包括IP地址簿、ECS标签地址簿、端口地址簿和域名地址簿。
DeleteAddressBook删除安全访问控制的地址簿删除访问控制地址簿。
ModifyAddressBook修改访问控制策略中设置的地址簿修改访问控制策略中设置的地址簿。
DescribeAddressBook查询访问控制策略地址簿查询云防火墙访问控制策略地址簿的详细信息。

流量分析

API标题API概述
DescribeInternetOpenIp获取防护资产暴露到互联网的IP获取防护资产暴露到互联网的IP。
DescribeInternetTrafficTrend获取互联网流量趋势获取互联网流量趋势。

其他

API标题API概述
ReleasePostInstance释放按量付费防火墙释放按量付费防火墙。
DescribeAssetRiskList获取资产风险等级列表获取资产风险等级列表。
DescribeVpcListLite获取VPC列表获取VPC列表。
ModifyVpcFirewallIPSWhitelist修改VPC防火墙IPS白名单修改VPC防火墙IPS白名单。
DescribeVpcFirewallIPSWhitelist获取VPC防火墙IPS白名单获取VPC防火墙IPS白名单。
DeleteControlPolicyTemplate删除ACL模板删除ACL模板。
DescribePrefixLists查询前缀列表查询前缀列表。
CreateDownloadTask创建文件下载任务创建文件下载任务。
DescribeDownloadTaskType查询文件下载任务类型查询下载任务类型。对应下载任务相关接口中的TaskType字段。
DeleteDownloadTask删除文件下载任务删除文件下载任务。
DescribeDownloadTask查询文件下载任务查询文件下载任务,包括任务信息以及下载地址。
DeleteNatFirewallControlPolicyBatch批量删除NAT防火墙策略批量删除NAT防火墙策略。
ResetNatFirewallRuleHitCount重置NAT防火墙命中数重置NAT防火墙命中数。
DescribeNatAclPageStatus查询NAT防火墙分页状态查询NAT防火墙分页状态。
DescribeInstanceRiskLevels查询实例风险等级查询实例风险等级。
DescribeCfwRiskLevelSummary查询防火墙风险等级查询防火墙风险等级。
DescribeVpcZone查询VPC zone查询VPC zone。
DescribeSignatureLibVersion查询特征库版本信息查询特征库版本信息。
DescribePostpayTrafficTotal查询后付费计费流量总计查询后付费计费流量总计,包括各个边界防火墙。
DescribePostpayTrafficDetail查询后付费计费流量明细查询后付费计费流量明细。
BatchDeleteVpcFirewallControlPolicy批量删除VPC防火墙访问控制策略批量删除VPC防火墙访问控制策略。