/** * ModifyFwGroupSwitch请求参数结构体 */ export interface ModifyFwGroupSwitchRequest { /** *
打开或关闭开关
0:关闭开关
1:打开开关
是否操作全部开关 0 不操作全部开关,1 操作全部开关
*/ AllSwitch: number; /** *开关列表
*/ SwitchList?: ArrayNAT CCN 开关配置 JSON 字符串,与 OpenClusterNatFwSwitch 的 NatCcnSwitch 完全一致。SwitchMode 必须为 1(自动接入),RoutingMode 必须为 1(策略路由)。
*/ NatCcnSwitch: NatCcnSwitchConfig; /** *预接入模式
枚举值:
nat网关ID
*/ NatInsId?: string; /** *nat网关名称
*/ NatInsName?: string; } /** * DescribeCfwSwitches请求参数结构体 */ export type DescribeCfwSwitchesRequest = null; /** * DescribeNDRAssetIdentificationList返回参数结构体 */ export interface DescribeNDRAssetIdentificationListResponse { /** * 符合查询条件的总条数 */ Total?: number; /** * 查询结果列表 */ Data?: ArrayAI操作来源
枚举值:
总条数
*/ Total?: number; /** *nat访问控制列表数据
*/ Data?: Array未过滤的总条数
*/ AllTotal?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeNatFwInstanceWithRegion返回参数结构体 */ export interface DescribeNatFwInstanceWithRegionResponse { /** *实例数组
*/ NatinsLst?: Array每页条数
*/ Limit: number; /** *偏移值
*/ Offset: number; /** *过滤条件组合
*/ Filters?: Array检索的起始时间,可不传
*/ StartTime?: string; /** *检索的截止时间,可不传
*/ EndTime?: string; /** *desc:降序;asc:升序。根据By字段的值进行排序,这里传参的话则By也必须有值
*/ Order?: string; /** *排序所用到的字段
*/ By?: string; } /** * DescribeCfwRules请求参数结构体 */ export interface DescribeCfwRulesRequest { /** *规则域。必填。枚举:border 互联网边界;nat NAT 边界;vpc VPC 间;enterprise_sg 企业安全组;intrusion_prevention 入侵防御。RuleType=intrusion_prevention 时还必须传 ListType。
*/ RuleType: string; /** *入侵防御列表类型。仅 RuleType=intrusion_prevention 时使用并必填。blocklist 表示封禁列表,whitelist 表示白名单策略,isolate 表示隔离列表。
*/ ListType?: string; /** *访问方向过滤。可选。0 表示出站,1 表示入站;不传则不过滤。RuleType=intrusion_prevention 时不支持。
*/ Direction?: number; /** *规则动作过滤。可选。0 表示观察,1 表示阻断,2 表示放行;不传则不过滤。
*/ RuleAction?: number; /** *启用状态过滤。可选。默认只返回启用规则;传 false 只查询禁用规则。
*/ Enabled?: boolean; /** *是否同时包含启用和禁用规则。可选。true 表示包含两类;不能和 Enabled 同时使用。
*/ IncludeDisabled?: boolean; /** *精确规则 ID 过滤。可选。用于按数值规则标识定位单条规则。
*/ RuleId?: number; /** *精确公开规则标识过滤。可选。推荐在用户提供规则标识时使用。
*/ RuleUuid?: string; /** *协议过滤。可选。例如 TCP、UDP、ICMP、HTTP、HTTPS、ANY;不传则不过滤。
*/ Protocol?: string; /** *源地址或源内容关键字过滤。可选,支持模糊匹配。
*/ SrcIp?: string; /** *目的地址、目的域名或目的内容关键字过滤。可选,支持模糊匹配。
*/ DstIp?: string; /** *规则描述关键字过滤。可选。
*/ Description?: string; /** *入侵防御列表关键字搜索。可选,最大 100 字符。blocklist 搜索 ioc/address/comment/rule_source;whitelist 搜索 rule_name/ioc/comment/src_ip/dst_ip;isolate 搜索实例、公网 IP、内网 IP、VPC、地域。
*/ Keyword?: string; /** *精确实例 ID 过滤。仅 RuleType=intrusion_prevention 且 ListType=isolate 时使用;写操作前后核验应使用该参数而不是 Keyword。
*/ InstanceId?: string; /** *是否展开模板、资产组、实例等名称。可选,默认 true;传 false 返回原始标识。
*/ ExpandNames?: boolean; /** *单页返回规则数。可选,默认 100,最大 1000。
*/ Limit?: number; /** *分页偏移。可选,默认 0。
*/ Offset?: number; } /** * DeleteNatFwInstance返回参数结构体 */ export interface DeleteNatFwInstanceResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * SearchLog返回参数结构体 */ export interface SearchLogResponse { /** *透传本次接口返回的Context值,可获取后续更多日志,过期时间1小时。
注意:
符合检索条件的日志是否已全部返回,如未全部返回可使用Context参数获取后续更多日志
注意:仅当检索分析语句(Query)不包含SQL时有效
返回的是否为统计分析(即SQL)结果
*/ Analysis?: boolean; /** *匹配检索条件的原始日志
注意:此字段可能返回 null,表示取不到有效值。 */ Results?: Array日志统计分析结果的列名
当UseNewAnalysis为false时生效
日志统计分析结果
当UseNewAnalysis为false时生效
日志统计分析结果
当UseNewAnalysis为true时生效
日志统计分析结果的列属性
当UseNewAnalysis为true时生效
本次统计分析使用的采样率
注意:此字段可能返回 null,表示取不到有效值。 */ SamplingRate?: number; /** *使用多日志主题检索时,各个日志主题的基本信息,例如报错信息。
注意:此字段可能返回 null,表示取不到有效值。 */ Topics?: SearchLogTopics; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifySecurityGroupRule请求参数结构体 */ export interface ModifySecurityGroupRuleRequest { /** * 方向,0:出站,1:入站,默认1 */ Direction: number; /** * 编辑后是否启用规则,0:不启用,1:启用,默认1 */ Enable: number; /** * 编辑的企业安全组规则数据 */ Data: Arraynatfw 防火墙实例id
*/ NatFwInsId: string; /** *natfw 过滤,以','分隔
*/ NatInsIdFilter?: string; /** *分页页数
*/ Offset?: number; /** *每页最多个数
*/ Limit?: number; } /** * DescribeCfwEips请求参数结构体 */ export interface DescribeCfwEipsRequest { /** *1:cfw接入模式,目前仅支持接入模式实例
*/ Mode: number; /** *ALL:查询所有弹性公网ip; nat-xxxxx:接入模式场景指定网关的弹性公网ip
*/ NatGatewayId: string; /** *防火墙实例id,当前仅支持接入模式的实例,该字段必填
*/ CfwInstance?: string; } /** * RemoveVpcAcRule请求参数结构体 */ export interface RemoveVpcAcRuleRequest { /** *待删除规则 ID 列表。具体规则 ID 通过 DescribeCfwRules 查询 RuleType=vpc 和目标 RuleUuid,并使用返回的 rules[].uuid。数组恰为 [-1] 时删除当前账号中 IpVersion 指定版本的全部可操作规则,风险极高;其它数组按 ID 批量删除。具体 ID 删除忽略 IpVersion;至少匹配一条即成功,全部未找到时返回 ResourceNotFound。成功响应回显请求中的 ID 列表。
*/ RuleUuids: ArrayAI操作来源
枚举值:
IP 版本,仅 RuleUuids 恰为 [-1] 时生效:1 表示 IPv6,0、省略或其它整数表示 IPv4。按具体规则 ID 删除时忽略。
*/ IpVersion?: number; } /** * CreateBlockIgnoreRuleList请求参数结构体 */ export interface CreateBlockIgnoreRuleListRequest { /** * 规则列表 */ Rules: Array每页条数
*/ Limit: number; /** *偏移值
*/ Offset: number; /** *需要查询的索引,特定场景使用,可不填
*/ Index?: string; /** *过滤条件组合
*/ Filters?: Array检索的起始时间,规则创建时间,可不传
参数格式:2022-07-27 16:00:00
*/ StartTime?: string; /** *检索的截止时间,规则创建时间,可不传
参数格式:2022-07-27 16:00:00
*/ EndTime?: string; /** *desc:降序;asc:升序。根据By字段的值进行排序,这里传参的话则By也必须有值,默认为asc
*/ Order?: string; /** *排序所用到的字段,默认为sequence
*/ By?: string; } /** * ModifyClusterVpcFwSwitch返回参数结构体 */ export interface ModifyClusterVpcFwSwitchResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeOfflineExportTemporaryCredentials请求参数结构体 */ export interface DescribeOfflineExportTemporaryCredentialsRequest { /** *任务ID
*/ TaskId: string; } /** * ExpandCfwVertical请求参数结构体 */ export interface ExpandCfwVerticalRequest { /** *nat:nat防火墙,ew:东西向防火墙
*/ FwType: string; /** *带宽值
*/ Width: number; /** *防火墙实例id
*/ CfwInstance?: string; /** *弹性开关 1打开 0 关闭
*/ ElasticSwitch?: number; /** *弹性带宽上限,单位Mbps
*/ ElasticBandwidth?: number; /** *按量计费标签
*/ Tags?: Array按流量弹性开关
取值范围:[0, 1]
默认值:0
*/ ElasticTrafficSwitch?: number; } /** * SyncFwOperate请求参数结构体 */ export interface SyncFwOperateRequest { /** *同步操作类型:Route,同步防火墙路由
*/ SyncType: string; /** *防火墙类型;nat,nat防火墙;ew,vpc间防火墙
*/ FwType?: string; } /** * AddEnterpriseSecurityGroupRules请求参数结构体 */ export interface AddEnterpriseSecurityGroupRulesRequest { /** * 待创建的规则数组,不能为空。每条规则必须提供访问源、访问目的、动作、非空描述和字符串 OrderIndex。未使用 ServiceTemplateId 时必须提供 Protocol 和 Port;使用 ServiceTemplateId 时二者可同时省略或留空,如填写非空值则必须为 Protocol=ANY、Port=-1/-1。Scope 可省略,默认使用 SG。 */ Data: ArrayAI操作来源
枚举值:
防火墙实例名称
*/ Name: string; /** *带宽
*/ Width: number; /** *模式 1:接入模式;0:新增模式
*/ Mode: number; /** *新增模式传递参数,其中NewModeItems和NatgwList至少传递一种。
*/ NewModeItems?: NewModeItems; /** *接入模式接入的nat网关列表,其中NewModeItems和NatgwList至少传递一种。
*/ NatGwList?: Array主可用区,为空则选择默认可用区
*/ Zone?: string; /** *备可用区,为空则选择默认可用区
*/ ZoneBak?: string; /** *异地灾备 1:使用异地灾备;0:不使用异地灾备;为空则默认不使用异地灾备
*/ CrossAZone?: number; /** *指定防火墙使用网段信息
*/ FwCidrInfo?: FwCidrInfo; } /** * 企业安全组规则摘要。 */ export interface SecurityGroupSimplifyRule { /** * 规则描述。 */ Description?: string; /** * 访问目的示例: net:IP/CIDR(192.168.0.2) template:参数模板(ipm-dyodhpby) instance:资产实例(ins-123456) resourcegroup:资产分组(/全部分组/分组1/子分组1) tag:资源标签({"Key":"标签key值","Value":"标签Value值"}) region:地域(ap-gaungzhou) */ DestContent?: string; /** * 写入规则的协议。普通 IPv4 规则返回 ANY、TCP、UDP 或 ICMP;使用服务模板时,Protocol 可省略或留空,此时返回空字符串;若仍显式填写 Protocol,则只接受 ANY 并返回 ANY。 */ Protocol?: string; /** * 规则 ID。 */ RuleUuid?: number; /** * 写入后的规则生效范围;SG 表示安全组,LH 表示轻量应用服务器,组合范围以逗号分隔。 */ Scope?: string; /** * 写入后的实际规则顺序。 */ Sequence?: number; /** * 访问源示例: net:IP/CIDR(192.168.0.2) template:参数模板(ipm-dyodhpby) instance:资产实例(ins-123456) resourcegroup:资产分组(/全部分组/分组1/子分组1) tag:资源标签({"Key":"标签key值","Value":"标签Value值"}) region:地域(ap-gaungzhou) */ SourceContent?: string; } /** * 预接入检查结果,序列化后写入 cfw_gwlb_lead_switch.check_result 列 */ export interface ClusterFwPreAccessCheckResult { /** * 检查状态,0:进行中,1:通过,2:失败 */ Status?: number; /** * 当前/最后所处检查项。Status=1(通过)时为 done,Status=2(失败)时为失败的检查项 key,Status=0(进行中)时为正在执行的检查项 key */ CurrentStage?: string; /** * 逐条检查项结果列表,按执行顺序追加 */ Stages?: Array要忽略的记录 ID 列表。TableType=AlertTable 时,使用 DescribeLogs(Index=rule_threatinfo)返回的 log_id;仅通过 HandleEventIdList 指定事件时传 [""]。TableType=InterceptionTable 时,使用 DescribeBlockList 返回的 Data[].UniqueId 或 TopData[].UniqueId。
*/ HandleIdList: Array必填的记录来源类型:AlertTable 表示告警中心,InterceptionTable 表示拦截列表。
*/ TableType: string; /** *AI操作来源
枚举值:
告警事件 ID 列表,可省略且仅用于 TableType=AlertTable。HandleEventIdList 与 HandleIdList 至少指定一种目标;仅按事件忽略时,HandleIdList 固定传 [""]。事件 ID 通过 DescribeCfwAlerts 获取,返回 alerts[].current_event_id 时使用该值,否则使用 alerts[].event_id。
*/ HandleEventIdList?: ArrayNAT CCN防火墙开关配置
*/ NatCcnSwitch: NatCcnSwitchConfig; } /** * SetNatFwEip返回参数结构体 */ export interface SetNatFwEipResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeClusterNatCcnFwSwitchList返回参数结构体 */ export interface DescribeClusterNatCcnFwSwitchListResponse { /** *符合条件的总记录数
*/ Total?: number; /** *NAT防火墙开关详情列表
*/ Data?: Array地域列表
*/ RegionList?: Array实例对象可以是ccnid类型:ccn-ad21xuds形式;nat网关类型:nat-da12daxd形式;ip类型:1.1.1.1形式等
*/ InsObj?: string; /** *实例对象名称
*/ ObjName?: string; /** *防火墙类型,ew:vpc间防火墙;nat:nat防火墙;border:互联网边界防火墙
*/ FwType?: string; /** *资产类型,ccn:ccn实例类型;nat:nat网关类型
*/ AssetType?: string; /** *地域
*/ Region?: string; /** *开关状态
0 : 关闭
1 : 开启
2 : 开启中
3 : 关闭中
4 : 异常
开关接入模式,1:自动接入;2,手动接入,0:未选择
*/ SwitchMode?: number; /** *实例对象是否处于非集群接入场景(主备模式)
*/ NonCluster?: number; /** *ip版本,0:ipv4;1:ipv6
*/ IpVersion?: number; /** *关联实例
注意:此字段可能返回 null,表示取不到有效值。 */ AttachIns?: Array引流私有网络端点信息
注意:此字段可能返回 null,表示取不到有效值。 */ Endpoints?: Array入侵防护模式,0:观察;1:拦截;2:严格;3:关闭
*/ Idpsaction?: number; /** *//透明模式开关,0:未开启,1:已开启
*/ TransEnable?: number; /** *开关状态 0关闭 1开启
*/ Enable?: number; /** *路由模式:0:多路由表,1:策略路由
*/ RoutingMode?: number; /** *是否跨租户开关 1是 0不是
*/ IsPeer?: number; /** *跨租户appid
*/ PeerAppid?: string; /** *跨租户操作状态 1不允许操作 0可以
*/ PeerStatus?: number; /** *Bypass状态
*/ Bypass?: number; /** *防火墙开关操作时的进度状态:
// 开启 — 自动模式(3步)
"AUTO_OPEN_ORCHESTRATING" // 步骤1: 预编排策略路由
"AUTO_OPEN_CREATING_RESOURCES" // 步骤2: 创建引流网络和资源
"AUTO_OPEN_PUSHING_ROUTES" // 步骤3: 创建策略路由
// 开启 — 手动模式(1步)
"MANUAL_OPEN_CREATING_RESOURCES" // 步骤1: 创建引流网络和资源
// 关闭 — 自动模式(2步)
"AUTO_CLOSE_DELETING_ROUTES" // 步骤1: 删除策略路由
"AUTO_CLOSE_DELETING_RESOURCES" // 步骤2: 删除引流网络和资源
// 关闭 — 手动模式(1步)
"MANUAL_CLOSE_DELETING_RESOURCES" // 步骤1: 删除引流网络和资源
// 修改 — 自动模式(3步)
"AUTO_MODIFY_ORCHESTRATING" // 步骤1: 预编排策略路由
"AUTO_MODIFY_DELETING_ROUTES" // 步骤2: 删除旧策略路由
"AUTO_MODIFY_PUSHING_ROUTES" // 步骤3: 创建新策略路由
// 修改 — 手动模式(1步,仅 VPC 防火墙存在手动模式修改)
"MANUAL_MODIFY_UPDATING_RESOURCES" // 步骤1: 更新引流网络和资源
预检查项的结果
*/ CheckResult?: ClusterFwPreAccessCheckResult; } /** * ModifyBlockIgnoreRuleNew返回参数结构体 */ export interface ModifyBlockIgnoreRuleNewResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyBlockIgnoreList请求参数结构体 */ export interface ModifyBlockIgnoreListRequest { /** *1封禁列表 2 放通列表
*/ RuleType: number; /** *IP、Domain二选一(注:封禁列表,只能填写IP),不能同时为空
*/ IOC: Array可选值:delete(删除)、edit(编辑)、add(添加) 其他值无效
*/ IocAction: string; /** *时间格式:yyyy-MM-dd HH:mm:ss,IocAction 为edit或add时必填
*/ StartTime?: string; /** *时间格式:yyyy-MM-dd HH:mm:ss,IocAction 为edit或add时必填,必须大于当前时间且大于StartTime
*/ EndTime?: string; /** *是否来自微信
取值范围:[0, 1]
*/ IsFromWeChat?: number; } /** * ModifyBlockIgnoreRule请求参数结构体 */ export interface ModifyBlockIgnoreRuleRequest { /** * 规则列表 */ Rule: IntrusionDefenseRule; /** * 规则类型,1封禁,2放通 */ RuleType: number; } /** * DescribeEnterpriseSGRuleProgress请求参数结构体 */ export type DescribeEnterpriseSGRuleProgressRequest = null; /** * DescribeCfwSwitches返回参数结构体 */ export interface DescribeCfwSwitchesResponse { /** * 查询结果。UTF-8 JSON object 字符串;调用方需解析 Response.Data。border_firewall 返回公网 IP 总数、已防护数、未防护数、操作中数量和防护率;nat_firewall、vpc_firewall 按 cluster/ha 返回实例及子开关汇总;ndr 返回已开启开关数;ips 返回当前防护模式。 */ Data?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeNatFwInstancesInfo请求参数结构体 */ export interface DescribeNatFwInstancesInfoRequest { /** *获取实例列表过滤字段
*/ Filter?: Array第几页
*/ Offset?: number; /** *每页长度
*/ Limit?: number; } /** * 安全组地域配置 */ export interface SecurityGroupRegion { /** *地域
*/ Region?: string; /** *地域Id
*/ RegionId?: string; /** *地域中文
*/ RegionName?: string; } /** * DescribeTableStatus请求参数结构体 */ export interface DescribeTableStatusRequest { /** * EdgeId值两个vpc间的边id vpc填Edgeid,不要填Area; */ EdgeId?: string; /** * 状态值,0:检查表的状态 确实只有一个默认值 */ Status?: number; /** * Nat所在地域 NAT填Area,不要填Edgeid; */ Area?: string; /** * 方向,0:出站,1:入站 默认值为 0 */ Direction?: number; } /** * IPS规则展示字段相关结构 */ export interface IpsRuleDetailNew { /** *规则ID
*/ RuleID?: string; /** *规则名称
*/ EventName?: string; /** *规则描述
*/ EventNameDesc?: string; /** *规则类型
*/ Category?: string; /** *置信度
*/ Confidence?: string; /** *自增id
*/ Id?: number; /** *漏洞对象
*/ VulTarget?: string; /** *漏洞编号
*/ Cve?: string; /** *状态 0 关闭 1打开
*/ Status?: number; /** *0观察, 1阻断
*/ Action?: number; /** *默认策略
*/ DefaultAction?: number; /** *基础防御/虚拟补丁
*/ RuleType?: number; /** *危险等级
*/ Level?: string; /** *FwType字段 1 border 2 nat 4 vpc
注意:此字段可能返回 null,表示取不到有效值。 */ FwType?: number; } /** * ModifyAddressTemplate返回参数结构体 */ export interface ModifyAddressTemplateResponse { /** * 创建结果,0成功 */ Status?: number; /** * 唯一Id */ Uuid?: string; /** * 规则数上限配置 */ RuleLimitNum?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 未处置事件信息汇总 */ export interface UnHandleEventDetail { /** * 安全事件名称 */ EventName: string; /** * 未处置事件数量 */ Total: number; } /** * 开启、关闭 防火墙互联网边界开关 */ export interface EdgeIpSwitch { /** * 公网IP */ PublicIp: string; /** * vpc 中第一个EIP开关打开,需要指定子网创建私有连接 */ SubnetId?: string; /** * 创建私有连接指定IP */ EndpointIp?: string; /** * 0 : 旁路 1 : 串行 */ SwitchMode?: number; } /** * ModifyIsolateTable请求参数结构体 */ export interface ModifyIsolateTableRequest { /** *操作动作,仅接受精确值 edit 或 delete。ButtonAction 为 edit 时修改该资产所有匹配隔离记录的有效期,需传 StartTime 和 EndTime;ButtonAction 为 delete 时解除该资产的全部匹配隔离,StartTime 和 EndTime 可省略。
*/ ButtonAction: string; /** *必填的资产实例 ID。调用 DescribeCfwRules,传 RuleType=intrusion_prevention、ListType=isolate 和目标 InstanceId,并使用完全匹配的 rules[].instance_id。edit 或 delete 作用于该实例的全部隔离记录。
*/ InstanceID: string; /** *AI操作来源
枚举值:
隔离结束时间。ButtonAction 为 edit 时必填,格式为 YYYY-MM-DD HH:MM:SS,且不得早于 StartTime;除永久隔离值 3000-01-01 00:00:00 外,必须晚于当前时间。ButtonAction 为 delete 时可省略。
*/ EndTime?: string; /** *隔离起始时间。ButtonAction 为 edit 时必填,格式为 YYYY-MM-DD HH:MM:SS,且不得晚于 EndTime;该时间将应用于该实例的全部匹配隔离记录。ButtonAction 为 delete 时可省略。
*/ StartTime?: string; } /** * CreateNatFwInstanceWithDomain返回参数结构体 */ export interface CreateNatFwInstanceWithDomainResponse { /** *nat实例信息
*/ CfwInsId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeAssetSync请求参数结构体 */ export type DescribeAssetSyncRequest = null; /** * ModifyAllRuleStatus请求参数结构体 */ export interface ModifyAllRuleStatusRequest { /** * 状态,0:全部停用,1:全部启用 */ Status: number; /** * 方向,0:出站,1:入站 */ Direction?: number; /** * Edge ID值 */ EdgeId?: string; /** * NAT地域 */ Area?: string; } /** * 规则输入对象 */ export interface RuleInfoData { /** * 执行顺序 */ OrderIndex: number; /** * 访问源 */ SourceIp: string; /** * 访问目的 */ TargetIp: string; /** * 协议 */ Protocol: string; /** * 策略, 0:观察,1:阻断,2:放行 */ Strategy: string; /** * 访问源类型,1是IP,3是域名,4是IP地址模板,5是域名地址模板 */ SourceType: number; /** * 方向,0:出站,1:入站 */ Direction: number; /** * 描述 */ Detail: string; /** * 访问目的类型,1是IP,3是域名,4是IP地址模板,5是域名地址模板 */ TargetType: number; /** * 端口 */ Port?: string; /** * id值 */ Id?: number; /** * 日志id,从告警处创建必传,其它为空 */ LogId?: string; /** * 城市Code */ City?: number; /** * 国家Code */ Country?: number; /** * 云厂商,支持多个,以逗号分隔, 1:腾讯云(仅中国香港及海外),2:阿里云,3:亚马逊云,4:华为云,5:微软云 */ CloudCode?: string; /** * 是否为地域 */ IsRegion?: number; /** * 城市名 */ CityName?: string; /** * 国家名 */ CountryName?: string; /** * 国家二位iso代码或者省份缩写代码 */ RegionIso?: string; } /** * DescribeNDRAssetIdentificationCursorList返回参数结构体 */ export interface DescribeNDRAssetIdentificationCursorListResponse { /** *查询结果列表
*/ Data?: Array下一页游标
*/ NextCursor?: string; /** *是否存在更多数据
*/ HasMore?: boolean; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifySequenceAclRules返回参数结构体 */ export interface ModifySequenceAclRulesResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateBlockIgnoreRuleNew返回参数结构体 */ export interface CreateBlockIgnoreRuleNewResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyWhiteRule请求参数结构体 */ export interface ModifyWhiteRuleRequest { /** * JSON object,提交完整策略。将 DescribeWhiteRule.Data[].WhiteId 写入 Rule.Info.WhiteId;RuleName、FwType、EndTime、Comment、Info 按本次请求整体保存,Id 和 IdsRuleName 由服务端管理。 */ Rule: IdsWhiteRule; /** * 使用 JSON integer,沿用 DescribeWhiteRule.Data[].RuleType: - 2 精确外部 IP:Rule.Info.SrcIP、Rule.Info.DstIP 两个字段中恰好填写一个。 - 3 域名。 - 4 威胁情报。 - 5 资产:Rule.Info.SrcIP、Rule.Info.DstIP 两个字段中恰好填写一个。 - 6 IPS 自定义:Rule.Info.IdsRuleId 必填,Rule.Info.SrcIP、Rule.Info.DstIP 至少一项为具体 IP;Rule.FwType=16 时目的 IPv4 可带端口;Rule.FwType 包含 1 时具体 IP 至少一项属于当前账号资产。 - 8 IP 扩展:在 Rule.Info 中填写 CIDR、端口或源/目的组合。 - 9 NDR 扩展:Rule.FwType=16,Rule.Info 至少包含一个 NDR 专属条件;搭配 IdsRuleId 时同时填写 Rule.Info.SrcIP 或 Rule.Info.DstIP。 */ RuleType: number; /** * 使用 JSON integer。仅 RuleType=2 使用:0 或省略表示保留冲突封禁;1 表示删除同 IP、同方向冲突封禁后保存,选择 1 前先确认该删除操作。其它 RuleType 省略本参数。 */ CoverDuplicate?: number; } /** * 新手引导扫描结果信息 */ export interface ScanResultInfo { /** * 是否禁封端口 */ BanStatus?: boolean; /** * 防护ip数量 */ IPNum?: number; /** * 是否开启防护 */ IPStatus?: boolean; /** * 是否拦截攻击 */ IdpStatus?: boolean; /** * 暴露漏洞数量 */ LeakNum?: number; /** * 暴露端口数量 */ PortNum?: number; } /** * DeleteBlockIgnoreRuleList请求参数结构体 */ export interface DeleteBlockIgnoreRuleListRequest { /** * 规则列表 */ Rules: Array查询结果。UTF-8 JSON object 字符串;调用方需解析 Response.Data。
*/ Data?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateNatFwDnatRule请求参数结构体 */ export interface CreateNatFwDnatRuleRequest { /** *0:cfw新增模式,1:cfw接入模式。
*/ Mode: number; /** *防火墙实例id,该字段必须传递。
*/ CfwInstance?: string; /** *添加或删除操作的Dnat规则列表。
*/ DnatRules?: Array必填的删除类型,只使用 0 或 1。0 表示删除 RuleUuid 指定的单条规则;1 表示删除当前账号的全部可操作企业安全组规则,风险极高。
*/ RemoveType: number; /** *必填的规则数值 ID。RemoveType=0 时,调用 DescribeCfwRules,传 RuleType=enterprise_sg、RuleId=<数值 RuleUuid>,并使用返回的 rules[].uuid;规则不存在时返回 ResourceNotFound。RemoveType=1 时传 0,删除当前账号的全部可操作企业安全组规则。成功响应回显请求中的 RuleUuid。
*/ RuleUuid: number; /** *AI操作来源
枚举值:
AI操作来源
枚举值:
开关,0:关闭,1:开启
*/ Enable: number; /** *集群模式vpc间防火墙ccn开关信息
*/ CcnSwitch?: Array总条数
*/ Total?: number; /** *内网间访问控制列表数据
*/ Data?: Array检测更新状态
"Checked":重新检测完成
"Checking": 正在重新检测中,请稍后刷新状态查看
查询的同步状态类型:Route,同步路由状态
*/ SyncType?: string; } /** * DeleteNatFwDnatRule返回参数结构体 */ export interface DeleteNatFwDnatRuleResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyVpcAcRule返回参数结构体 */ export interface ModifyVpcAcRuleResponse { /** * 修改后的规则 ID 列表,成功时包含请求规则的 Uuid。 */ RuleUuids?: Array自定义开始时间。可选,格式 YYYY-MM-DD HH:MM:SS;必须和 EndTime 同时传。
*/ StartTime?: string; /** *自定义结束时间。可选,格式 YYYY-MM-DD HH:MM:SS;必须和 StartTime 同时传。
*/ EndTime?: string; } /** * RemoveNatAcRule返回参数结构体 */ export interface RemoveNatAcRuleResponse { /** * 回显请求中的规则 ID 列表;全量删除返回 [-1]。 */ RuleUuid?: Arrayip 开关列表
*/ Data?: Arrayip 开关列表个数
*/ Total?: number; /** *地域列表
*/ RegionLst?: Array实例类型列表
*/ InstanceTypeLst?: Array串行模式开关个数
*/ SerilCount?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeCfwLogs请求参数结构体 */ export interface DescribeCfwLogsRequest { /** * 日志类型。首次查询必填;使用 NextToken 续查时不能传。cfw_netflow_border=互联网边界流量,cfw_netflow_vpc=VPC 东西向流量,cfw_netflow_nat=NAT 防火墙流量,cfw_netflow_nta=NDR/NTA 流量,cfw_netflow_dns=DNS 防火墙日志,cfw_rule_threatinfo=入侵防御/威胁情报告警,cfw_rule_acl=互联网边界访问控制日志,cfw_rule_vpc_acl=VPC 访问控制日志,cfw_rule_nat_acl=NAT 访问控制日志,cfw_ndr_subject_risk=NDR 专题风险,cfw_ndr_dataleak_entry=NDR 敏感数据泄露,cfw_ndr_ai_audit=NDR AI 应用识别与大模型调用审计,cfw_feature_collect=统计特征与基线异常,cfw_behavior_collect=Beacon/DNS/端口/证书/VPC 互访行为,operate_log_all=操作审计日志。 */ LogType?: string; /** * 日志过滤表达式。默认 * 表示不过滤;例如 src_ip:1.1.1.1。可查询字段随 LogType 变化,应优先使用对应 Items 中已返回的字段名,不要猜测不存在的字段;使用 NextToken 续查时不能传。 */ Query?: string; /** * 查询起始时间。支持 RFC3339、YYYY-MM-DD HH:MM:SS、YYYY-MM-DD 或 Unix 时间戳;传入后从该时间向后查询 TimeRange;使用 NextToken 续查时不能传。 */ StartTime?: string; /** * 查询时间范围。默认 1h;格式为正整数加单位 m/h/d,例如 5m、1h、24h、7d;使用 NextToken 续查时不能传。 */ TimeRange?: string; /** * 单页返回条数。首次查询可选,默认 100;取值 1 至 1000;使用 NextToken 续查时不能传。 */ Limit?: number; /** * 上一页 Response.Data 返回的不透明续查 token。首次查询不传;续查时只传 NextToken。无效、篡改或租户不匹配会被拒绝。 */ NextToken?: string; } /** * ccn实例开关信息 */ export interface CcnSwitchInfo { /** * ccn的id 注意:此字段可能返回 null,表示取不到有效值。 */ CcnId: string; /** * 开关接入模式,1:自动接入,2:手动接入 注意:此字段可能返回 null,表示取不到有效值。 */ SwitchMode: number; /** * 引流路由方法 0:多路由表, 1:策略路由 注意:此字段可能返回 null,表示取不到有效值。 */ RoutingMode?: number; /** * 地域级别CIDR配置 */ RegionCidrConfigs?: Arraybind:绑定eip;unbind:解绑eip;newAdd:新增防火墙弹性公网ip
*/ OperationType: string; /** *防火墙实例id
*/ CfwInstance: string; /** *当OperationType 为bind或unbind操作时,使用该字段。
*/ EipList?: Arraynat防火墙vpc dns 信息数组
*/ VpcDnsSwitchLst?: Array返回参数 success成功 failed 失败
*/ ReturnMsg?: string; /** *开关总条数
*/ Total?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeAclRegInfo返回参数结构体 */ export interface DescribeAclRegInfoResponse { /** * 规则支持的地域列表 */ Data?: Array需要查询的索引,特定场景使用,可不填
*/ Index?: string; /** *过滤条件组合
*/ Filters?: Array每页条数
*/ Limit?: number; /** *偏移值
*/ Offset?: number; /** *检索的起始时间,可不传
*/ StartTime?: string; /** *检索的截止时间,可不传
*/ EndTime?: string; /** *desc:降序;asc:升序。根据By字段的值进行排序,这里传参的话则By也必须有值
*/ Order?: string; /** *排序所用到的字段
*/ By?: string; } /** * DescribeFwGroupIdNames返回参数结构体 */ export interface DescribeFwGroupIdNamesResponse { /** *防火墙(组列表)
注意:此字段可能返回 null,表示取不到有效值。 */ Data?: Array告警开始时间。可选,格式 YYYY-MM-DD HH:MM:SS;默认查询最近 1 小时。
*/ StartTime?: string; /** *告警结束时间。可选,格式 YYYY-MM-DD HH:MM:SS;默认当前时间。
*/ EndTime?: string; /** *告警严重级别过滤。可选;枚举 low、middle、high。
*/ Level?: string; /** *流量方向过滤。可选;枚举 outbound 出站、inbound 入站、lateral 横向。
*/ Direction?: string; /** *处置状态过滤。可选;枚举 unhandled、handled、blocked、passed、isolated、ignored。
*/ ActionStatus?: string; /** *攻击链阶段过滤。可选;枚举 recon、brute_force、delivery、exploit、c2、lateral_movement、exfiltration。
*/ KillChain?: string; /** *攻击结果过滤。可选;枚举 attempt、success、fail、unknown。
*/ AttackResult?: string; /** *IPS 策略动作过滤。可选;枚举 observe、block。
*/ Strategy?: string; /** *攻击事件名称关键字过滤。可选,例如 SQL注入、暴力破解、恶意域名访问。
*/ EventName?: string; /** *精确告警事件 ID 过滤。用于指定事件的写操作前检查和写操作后核验;事件重新聚合时返回原请求 ID 和当前事件 ID。无匹配返回空结果,多匹配或定位过程异常时失败,不退化为宽查询。
*/ EventId?: string; /** *源 IP 过滤。可选。
*/ SrcIp?: string; /** *目的 IP 过滤。可选。
*/ DstIp?: string; /** *云资源实例 ID 过滤。可选,例如 ins-xxxxxxxx。
*/ InstanceId?: string; /** *单页返回告警数。可选,默认 10,最大 50。
*/ Limit?: number; /** *分页偏移。可选,默认 0。
*/ Offset?: number; /** *排序字段。可选,默认 EndTime;枚举 EndTime、StartTime、Count。排序字段。可选,默认 EndTime;枚举 EndTime、StartTime、Count;Count 表示按单个聚合告警事件的告警发生次数/命中次数排序,对应返回中的 occurrence_count
*/ OrderBy?: string; /** *排序方向。可选,默认 desc;枚举 desc、asc。
*/ Order?: string; } /** * DescribeSerialRegion返回参数结构体 */ export interface DescribeSerialRegionResponse { /** *串行地域带宽分配
注意:此字段可能返回 null,表示取不到有效值。 */ SerialRegionLst?: Array剩余可分配通用带宽 单位M
注意:此字段可能返回 null,表示取不到有效值。 */ UnUsedWidth?: number; /** *可配置实例个数
注意:此字段可能返回 null,表示取不到有效值。 */ UnUsedQuota?: number; /** *旁路带宽数据
注意:此字段可能返回 null,表示取不到有效值。 */ BypassWidth?: number; /** *赠送的旁路带宽数据
注意:此字段可能返回 null,表示取不到有效值。 */ SendBypassWidth?: number; /** *互联网边界防火墙总带宽
*/ EdgeWidth?: number; /** *互联网边界弹性开关
*/ EdgeElasticSwitch?: number; /** *互联网边界弹性带宽值
*/ EdgeElasticBandwidth?: number; /** *互联网边界弹性带宽上限
*/ EdgeElasticBandwidthLimit?: number; /** *互联网边界防火墙计量开关
枚举值:
返回值信息
*/ NatFwEipList?: Array修改成功
*/ ReturnMsg?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateBlockIgnoreRuleNew请求参数结构体 */ export interface CreateBlockIgnoreRuleNewRequest { /** * 规则类型:1 IP 封禁,2 IP 放通,3 域名放通,4 情报放通,5 资产放通,6 自定义放通。 */ RuleType: number; /** * 待新增规则列表;可为空,空数组返回成功且不新增规则。 */ Rules: ArrayAI操作来源
枚举值:
云联网ID
*/ CcnId: string; /** *要查询引流网络部署状态的云联网关联的实例ID列表
*/ InstanceIds?: Array引流路由方法 0:多路由表, 1:策略路由
*/ RoutingMode?: number; } /** * DescribeNatAcRule返回参数结构体 */ export interface DescribeNatAcRuleResponse { /** *总条数
*/ Total?: number; /** *nat访问控制列表数据
*/ Data?: Array未过滤的总条数
*/ AllTotal?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 离线导出任务 */ export interface OfflineExportTask { /** * 任务ID */ TaskId?: string; /** * 任务名称 */ TaskName?: string; /** * 创建时间 */ CreateTime?: string; /** * 日志总数 */ DataLength?: number; /** * 任务状态,0等待下载,1下载中,2下载完成,3下载失败,4文件过期 */ Status?: number; /** * 文件过期时间 */ ExpireTime?: string; /** * 下载进度 */ Progress?: number; /** * 导出失败信息 注意:此字段可能返回 null,表示取不到有效值。 */ ErrorInfo?: string; /** * 是否使用Cos 注意:此字段可能返回 null,表示取不到有效值。 */ UseUserCos?: number; } /** * AddAclRule请求参数结构体 */ export interface AddAclRuleRequest { /** * 待添加的互联网边界规则列表,不能为空。每条规则均须满足方向、访问源和目的、动作、范围、协议端口及模板限制;整个请求还须满足规则配额和可生效规则数量限制。账号相关值必须来自只读查询:地址模板调用 DescribeAddressTemplateList,请求用 TemplateType=1 或 5 过滤,并确认返回项 Data[].Type 为 1 或 5;将 Data[].Uuid(mb_ 前缀)写入对应 Content,不要使用 Data[].TemplateId(ip-/dm- 前缀)。协议端口模板请求用 TemplateType=6 过滤,并将 Data[].TemplateId(pp- 前缀)写入 ParamTemplateId。资产实例调用 DescribeCfwAssets,解析返回结果后使用 assets[].instance_id;资产分组调用 DescribeResourceGroupNew,传 QueryType=resource、GroupId="0"、ShowType=all,解析返回结果后使用 GroupId;资源标签传 QueryType=tag,跳过“全部资产”根节点,以一级节点 GroupName 为 Key、所选二级子节点 GroupName 为 Value 构造 JSON,不要写入 GroupId。地域调用 DescribeAclRegInfo:Scope=serial 传 FwType=["SERIAL"],Scope=side 传 FwType=["BYPASS"],Scope=all 同时传两项,并使用 Data[].RegionCode。不得使用展示名称或自行拼接。覆盖导入的范围仅由首条规则的 Direction 决定。 */ Rules: ArrayAI操作来源
枚举值:
每页条数
*/ Limit: number; /** *偏移值
*/ Offset: number; /** *过滤条件组合
*/ Filters?: Array检索的起始时间,可不传
*/ StartTime?: string; /** *检索的截止时间,可不传
*/ EndTime?: string; /** *desc:降序;asc:升序。根据By字段的值进行排序,这里传参的话则By也必须有值
*/ Order?: string; /** *排序所用到的字段
*/ By?: string; } /** * DescribeOfflineExportTemporaryCredentials返回参数结构体 */ export interface DescribeOfflineExportTemporaryCredentialsResponse { /** *返回状态码 0 成功 非0不成功
*/ ReturnCode?: number; /** *返回信息 success 成功 其他 不成功
*/ ReturnMsg?: string; /** *临时下载链接
*/ Link?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyAcRule返回参数结构体 */ export interface ModifyAcRuleResponse { /** * 状态值,0:操作成功,非0:操作失败 */ Status?: number; /** * 返回多余的信息 */ Info?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeTableStatus返回参数结构体 */ export interface DescribeTableStatusResponse { /** * 0:正常,其它:不正常 */ Status?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 入侵防御放通封禁规则 */ export interface BlockIgnoreRule { /** * 规则类型,取值:1 封禁,2外部IP,3域名,4情报,5assets,6自定义策略,7入侵防御规则id (2-7属于白名单类型) */ RuleType?: number; /** * 规则ip或白名单内容 */ Ioc?: string; /** * 资产实例名称、自定义策略名称等 */ IocName?: string; /** * 白名单信息 */ IocInfo?: string; /** * 域名 */ Domain?: string; /** * IP */ IP?: string; /** * 危险等级 */ Level?: string; /** * 来源事件名称 */ EventName?: string; /** * 方向:1入站,0出站 */ Direction?: number; /** * 所有方向聚合成字符串 */ DirectionList?: string; /** * 协议 */ Protocol?: string; /** * 地理位置 */ Address?: string; /** * 规则类型:1封禁,2放通 */ Action?: number; /** * 规则生效开始时间 */ StartTime?: string; /** * 规则生效结束时间 */ EndTime?: string; /** * 忽略原因 */ IgnoreReason?: string; /** * 安全事件来源 */ Source?: string; /** * 规则id */ UniqueId?: string; /** * 规则命中次数 */ MatchTimes?: number; /** * 国家 */ Country?: string; /** * 备注 */ Comment?: string; /** * 上次命中时间 */ LastHitTime?: string; /** * 自定义规则细节 */ CustomRule?: CustomWhiteRule; /** * 1 border 2 nat 4 vpc 8 border-serial */ FwType?: number; } /** * NAT集群防火墙地域部署状态查询 */ export interface NatClusterRegionStatusQuery { /** *云联网ID
*/ CcnId: string; /** *NAT网关ID
*/ NatInsId: string; /** *资产类型,取值:nat_ccn-CCN+NAT场景,nat-独立NAT场景
*/ AssetType: string; /** *引流路由方法,0-多路由表模式,1-策略路由模式
*/ RoutingMode?: number; } /** * 未处置事件详情 */ export interface UnHandleEvent { /** * 伪攻击链类型 */ EventTableListStruct?: Array查询结果。UTF-8 JSON object 字符串;调用方需解析 Response.Data。
*/ Data?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 企业安全组规则内容。新增和修改规则内容共用此结构;字段的校验、缺省、归一化及在两种操作中的处理行为见各字段说明。 */ export interface SecurityGroupRule { /** * 规则用途或使用场景的描述,不能为空,最多 100 个 Unicode 字符。 */ Description: string; /** * 访问目的内容,非空且最多 512 字节,格式由 DestType 决定:net 使用 IPv4 IP/CIDR,且不接受裸地址 0.0.0.0,表示全部 IPv4 地址时使用 0.0.0.0/0;template 使用通过 VPC DescribeAddressTemplates 或 DescribeAddressTemplateGroups 查询的广州地域(ap-guangzhou)地址模板 ID,即 AddressTemplateId(ipm-)或 AddressTemplateGroupId(ipmg-);instance 使用 DescribeCfwAssets 返回的 assets[].instance_id;resourcegroup 使用 DescribeResourceGroupNew(QueryType=resource)返回的 GroupId;tag 根据 DescribeResourceGroupNew(QueryType=tag)返回的 GroupName 构造 {\"Key\":\"标签键\",\"Value\":\"标签值\"};region 使用 DescribeSecurityGroupRegionList 返回的 Data[].Region;dnsparse 使用合法域名并按小写处理,同时受域名解析配额限制。 */ DestContent: string; /** * 访问目的类型,不区分大小写:net 表示 IP/CIDR,template 表示地址模板,instance 表示资产实例,resourcegroup 表示资产分组,tag 表示资源标签,region 表示资产地域,dnsparse 表示 DNS 解析匹配。内容必须与类型匹配,并且对当前账号有效。 */ DestType: string; /** * 规则顺序的十进制整数字符串;-1 转换为 uint32 最大值。新增时 Type=0 或 1 会按 Data 数组顺序重新计算最终 Sequence;Type=2 使用首条规则的 OrderIndex 作为插入位置,超过当前最大 Sequence 时按末尾新增处理。修改规则内容时 -1 会被拒绝,超过当前最大 Sequence 的值归一化为当前最大 Sequence。 */ OrderIndex: string; /** * 访问控制动作,不区分大小写:accept 表示放行,drop 表示拒绝,log 表示观察;isolateinaccept 表示放行访问隔离资产的白名单流量,isolateindrop 表示阻断访问隔离资产的其它流量,isolateoutaccept 表示放行隔离资产访问白名单目标,isolateoutdrop 表示阻断隔离资产访问其它目标。 */ RuleAction: string; /** * 访问源内容,非空且最多 512 字节,格式由 SourceType 决定:net 使用 IPv4 IP/CIDR,且不接受裸地址 0.0.0.0,表示全部 IPv4 地址时使用 0.0.0.0/0;template 使用通过 VPC DescribeAddressTemplates 或 DescribeAddressTemplateGroups 查询的广州地域(ap-guangzhou)地址模板 ID,即 AddressTemplateId(ipm-)或 AddressTemplateGroupId(ipmg-);instance 使用 DescribeCfwAssets 返回的 assets[].instance_id;resourcegroup 使用 DescribeResourceGroupNew(QueryType=resource)返回的 GroupId;tag 根据 DescribeResourceGroupNew(QueryType=tag)返回的 GroupName 构造 {\"Key\":\"标签键\",\"Value\":\"标签值\"};region 使用 DescribeSecurityGroupRegionList 返回的 Data[].Region。 */ SourceContent: string; /** * 访问源类型,不区分大小写:net 表示 IP/CIDR,template 表示地址模板,instance 表示资产实例,resourcegroup 表示资产分组,tag 表示资源标签,region 表示资产地域。内容必须与类型匹配,并且对当前账号有效;dnsparse 作为 SourceType 时仅按普通字符串保存,不提供 DNS 解析匹配,请勿使用;DNS 解析匹配仅用于 DestType。 */ SourceType: string; /** * 规则状态字符串,不区分大小写;true 表示启用,false 表示禁用,省略或空字符串在结构转换时按 true 解析。普通新增最终使用账号的新增规则默认状态;batch_import 和 batch_import_cover 新增保留 Data.Enable 的解析结果;修改规则内容时保留原规则状态,因此 Data.Enable 不改变该修改的启停结果。 */ Enable?: string; /** * 规则 ID,使用十进制数字字符串。普通新增由系统分配;仅 IsUseId=1 的新增请求采用 Data.Id。修改规则内容时忽略 Data.Id,并保留 RuleUuid 指定的规则 ID。 */ Id?: string; /** * 访问控制端口字符串,最多 200 字节。未使用服务模板时必填,可传 1..65535 的单端口、斜杠连接的端口范围、最多 15 个逗号分隔项,或 -1/-1 表示全部端口;Protocol 为 ANY 或 ICMP 时必须为 -1/-1。使用 ServiceTemplateId 时,Protocol 和 Port 可同时省略或留空;如填写非空值则必须为 Protocol=ANY、Port=-1/-1。 */ Port?: string; /** * IPv4 企业安全组协议,使用区分大小写的大写值 ANY、TCP、UDP 或 ICMP;ANY 表示所有 IPv4 协议。未使用服务模板时必填,ANY 和 ICMP 必须搭配 Port=-1/-1;使用 ServiceTemplateId 时,Protocol 和 Port 可同时省略或留空,如填写非空值则必须为 Protocol=ANY、Port=-1/-1。ICMPv6 使用独立的 IPv6 企业安全组接口。 */ Protocol?: string; /** * 规则生效范围,使用大写 SG、LH、NONE 或无空格的逗号分隔组合;SG 表示安全组,LH 表示轻量应用服务器,NONE 表示未设置范围。新增时省略默认为 SG;修改规则内容时省略或使用 NONE 均保留原范围。组合项会去重。范围包含 LH 时,SourceType、DestType 均不能为 template,且不能使用 ServiceTemplateId。 */ Scope?: string; /** * 协议端口模板 ID,最多 50 字节。仅支持通过 VPC DescribeServiceTemplates 或 DescribeServiceTemplateGroups 查询的广州地域(ap-guangzhou)服务模板,即 ServiceTemplateId(ppm-)或 ServiceTemplateGroupId(ppmg-)。非空时 Protocol 和 Port 可同时省略或留空;如填写非空值则必须为 Protocol=ANY、Port=-1/-1。Scope 包含 LH 时不能使用服务模板。 */ ServiceTemplateId?: string; /** * 保留字段。新增和修改请求均忽略 Uid,无法通过该字段指定或保留规则标识,建议省略。 */ Uid?: string; } /** * ModifySecurityGroupItemRuleStatus返回参数结构体 */ export interface ModifySecurityGroupItemRuleStatusResponse { /** * 状态值,0:修改成功,非0:修改失败 */ Status?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 日志结果信息 */ export interface LogInfo { /** * 日志时间,单位ms */ Time?: number; /** * 日志主题ID */ TopicId?: string; /** * 日志主题名称 */ TopicName?: string; /** * 日志来源IP */ Source?: string; /** * 日志文件名称 */ FileName?: string; /** * 日志上报请求包的ID */ PkgId?: string; /** * 请求包内日志的ID */ PkgLogId?: string; /** * 日志内容的Json序列化字符串 注意:此字段可能返回 null,表示取不到有效值。 */ LogJson?: string; /** * 日志来源主机名称 注意:此字段可能返回 null,表示取不到有效值。 */ HostName?: string; /** * 原始日志(仅在日志创建索引异常时有值) 注意:此字段可能返回 null,表示取不到有效值。 */ RawLog?: string; /** * 日志创建索引异常原因(仅在日志创建索引异常时有值) 注意:此字段可能返回 null,表示取不到有效值。 */ IndexStatus?: string; } /** * DeleteBlockIgnoreRuleList返回参数结构体 */ export interface DeleteBlockIgnoreRuleListResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeNDRAssetIdentificationList请求参数结构体 */ export interface DescribeNDRAssetIdentificationListRequest { /** * 每页条数 */ Limit: number; /** * 偏移量 */ Offset: number; /** * 排序方式,asc正序 desc倒序 */ Order?: string; /** * 排序字段 */ By?: string; /** * 查询过滤条件,多个条件之间为AND的关系 */ Filters?: ArrayNAT防火墙实例ID
*/ NatInsId: string; /** *云联网实例ID
*/ CcnId: string; } /** * DescribeCfwAnalysisData请求参数结构体 */ export interface DescribeCfwAnalysisDataRequest { /** * 分析场景。必填。full_traffic 表示全流量深度分析;east_west 表示东西向流量分析;alert_comprehensive 表示告警综合分析;asset_exposure 表示资产暴露面分析;access_troubleshoot 表示访问阻断排障分析。 */ Scenario: string; /** * 查询开始时间。可选,格式 YYYY-MM-DD HH:MM:SS;不传时默认查询最近 7 天。 */ StartTime?: string; /** * 查询结束时间。可选,格式 YYYY-MM-DD HH:MM:SS;不传时默认当前时间。 */ EndTime?: string; /** * 分析对象类型。可选,默认 user;user 表示租户全局,asset 表示资产上下文,vpc 表示 VPC 上下文,domain 表示域名上下文。选择非 user 时建议同时传 ObjectId 以限定具体对象;当前未传 ObjectId 时仍按该对象类型执行宽查询。 */ ObjectType?: string; /** * 分析对象标识。ObjectType 为 asset、vpc 或 domain 时可传,用于限定具体 IP、实例 ID、VPC ID 或域名;当前为可选参数,省略时不会按具体对象过滤。 */ ObjectId?: string; /** * 目标 IP 或域名过滤。可选,常用于 access_troubleshoot,也可用于其他 Scenario;传入后优先于 ObjectType/ObjectId,并对该场景全部分析段追加源 IP、目的 IP 或目的域名过滤。 */ Target?: string; /** * 需要跳过的分析段名称列表。可选;不传或传空数组时执行该场景全部分析段。full_traffic 支持 beacon、dns_large、dns_dga、dns_dga_fine、dns_tunnel、icmp_tunnel、mining、p2p、remote_tool、file_transfer、high_risk_outbound、lateral_baseline、vpc_sensitive、smb_write、outbound_baseline、inbound_high_risk、tls_expired、tls_self_signed、first_seen_ip、first_seen_country、first_seen_port;east_west 支持 vpc_inter_vpc、subnet_inter、service_port、lateral_baseline、vpc_sensitive、smb_write、database_lateral;alert_comprehensive 支持 outbound_baseline、lateral_baseline、beacon、inbound_high_risk、first_seen_ip、first_seen_country、first_seen_port;asset_exposure 支持 inbound_high_risk、tls_expired、tls_self_signed、high_risk_outbound;access_troubleshoot 支持 acl_border_block、acl_nat_block、acl_vpc_block、ips_block。传入当前 Scenario 不支持的名称会返回 InvalidParameter。 */ SkipSections?: ArrayEDGE_FW : 互联网边界防火墙 , NDR: 流量分析,VPC_FW:VPC边界防火墙
*/ FwType?: string; } /** * DescribeNDRDataLeakOutAlertDetail返回参数结构体 */ export interface DescribeNDRDataLeakOutAlertDetailResponse { /** * 风险事件ID */ RiskID?: string; /** * 资产实例ID */ InstanceId?: string; /** * 资产实例名称 */ InstanceName?: string; /** * 资产实例类型 */ InstanceType?: string; /** * 资产所在地域 */ Region?: string; /** * 源IP */ SrcIP?: string; /** * 目的IP端口 */ DstIPPort?: string; /** * 目的Host */ Hostname?: string; /** * 目的服务类型 */ DstServiceType?: string; /** * 目的服务名称 */ DstServiceName?: string; /** * 访问API */ ApiPattern?: string; /** * 目的IP地理信息 */ DstGeoLocation?: string; /** * 应用层协议 */ AppProto?: string; /** * 敏感类型集合 */ LeakTypeSet?: string; /** * 事件数量 */ EventCount?: number; /** * 敏感数据数量 */ LeakDataCount?: number; /** * 原始风险等级 */ Level?: number; /** * 处置状态 */ Status?: number; /** * 处置备注 */ Comment?: string; /** * 首次识别时间 */ FirstIdentificationTime?: string; /** * 最近识别时间 */ LatestIdentificationTime?: string; /** * AI任务分析状态 */ AnalysisStatus?: number; /** * AI任务失败原因 */ AnalysisFailReason?: string; /** * 最近一次AI分析时间 */ LastAnalysisTime?: string; /** * API业务类型 */ ApiBizType?: string; /** * API业务描述 */ ApiBizDescription?: string; /** * 风险场景(类型) */ RiskScenario?: string; /** * 风险场景(类型)描述 */ RiskScenarioDetail?: string; /** * 风险总结(概览) */ RiskSummary?: string; /** * 推断依据 */ RiskBasis?: string; /** * 风险影响范围 */ ImpactScope?: string; /** * AI建议风险等级 */ AiSuggestedLevel?: number; /** * 处置建议 */ DisposalSuggestions?: ArrayAI操作来源
枚举值:
每页条数
*/ Limit: number; /** *分页游标
前一页返回的NextCursor
*/ Cursor?: string; /** *查询过滤条件,多个条件之间为AND的关系
*/ Filters?: Array云联网ID
*/ CcnId: string; } /** * ModifyVpcAcRule请求参数结构体 */ export interface ModifyVpcAcRuleRequest { /** * 待修改的规则数组,必须恰好包含一条完整规则,不是局部更新。调用 DescribeCfwRules,传 RuleType=vpc、目标 RuleUuid、ExpandNames=false 获取原规则。字段转换:uuid→Uuid,sequence→OrderIndex,src_ip→SourceContent,src_type→SourceType,dst_content→DestContent,dst_type→DestType,dst_port→Port,detail→Description,edge_id→EdgeId,fwgroupid→FwGroupId,ip_version→IpVersion;action 的 0、1、2 分别转换为 log、drop、accept,enabled 的布尔值转换为字符串 true、false;protocol、param_template_id、dest_value_type 分别写入 Protocol、ParamTemplateId、DestValueType。src_type 和 dst_type 的 1、2、3、4/5、6、8、9、10、100 分别对应 net、url、domain、template、instance、tag、dnsparse、domainiptwoverify、group;仅当转换结果属于对应 SourceType 或 DestType 的有效取值时才能提交。省略的可写字段不会继承旧值,IpVersion=0 也必须传入。不修改生效范围时,将原规则的 edge_id 和 fwgroupid 原样写入 EdgeId 和 FwGroupId;主动更换时,EdgeId 通过 DescribeVpcAclEdgeRange 查询,FwGroupId 通过 DescribeFwGroupIdNames 查询。 */ Rules: ArrayAI操作来源
枚举值:
要添加的 NAT 访问控制规则列表,至少一项。Direction、地址类型与内容、Protocol、RuleAction 和 Scope 会逐项校验;Description、Enable、OrderIndex 和 Scope 的缺省或归一化行为见对应字段说明。Scope 调用无业务参数的 DescribeNatRuleScopes,使用 ScopeItems[].Scope,不要使用 ScopeDesc。地址模板调用 DescribeAddressTemplateList,请求用 TemplateType=1 或 5 过滤,并确认返回项 Data[].Type 为 1 或 5;将 Data[].Uuid(mb_ 前缀)写入对应 Content,不要使用 Data[].TemplateId(ip-/dm- 前缀)。协议端口模板请求用 TemplateType=6 过滤,并将 Data[].TemplateId(pp- 前缀)写入 ParamTemplateId。资产实例调用 DescribeCfwAssets,解析返回结果后使用 assets[].instance_id;资产分组调用 DescribeResourceGroupNew,传 QueryType=resource、GroupId="0"、ShowType=all,解析返回结果后使用 GroupId;资源标签传 QueryType=tag,跳过“全部资产”根节点,以一级节点 GroupName 为 Key、所选二级子节点 GroupName 为 Value 构造 JSON 字符串 {"Key":"标签键","Value":"标签值"},不要写入 GroupId;地域调用 DescribeAclRegInfo,传 FwType=["NAT"] 并使用 Data[].RegionCode。不得使用展示名称或自行拼接。
*/ Rules: ArrayAI操作来源
枚举值:
添加方式。省略或为空表示普通新增;insert_rule 表示指定位置新增;batch_import 表示非覆盖批量导入;batch_import_cover 表示覆盖导入,会删除当前账号中与首条规则同方向的全部可操作 NAT边界规则后再添加 Rules,添加失败时已删除的规则不会恢复,风险极高。仅支持上述取值。
*/ From?: string; } /** * NDR出站数据泄露-告警事件 */ export interface DataLeakOutAlertEvent { /** * 风险ID */ RiskID?: string; /** * 实例ID */ InstanceId?: string; /** * 实例名称 */ InstanceName?: string; /** * 实例类型 */ InstanceType?: string; /** * 地域 */ Region?: string; /** * 源IP */ SrcIP?: string; /** * 目的IP端口,多个以逗号连接:1.1.1.1:80,1.1.1.1:8080 */ DstIPPort?: string; /** * hostname */ Hostname?: string; /** * 目的服务类型 */ DstServiceType?: string; /** * 目的服务名称 */ DstServiceName?: string; /** * 以逗号连接的敏感类型ID集合: 10001,10002,10003 */ LeakTypeSet?: string; /** * 事件数量 */ EventCount?: number; /** * 首次识别时间 */ FirstIdentificationTime?: string; /** * 最近识别时间 */ LatestIdentificationTime?: string; /** * 风险等级 */ Level?: number; /** * 处置状态 */ Status?: number; /** * 备注 */ Comment?: string; /** * API */ ApiPattern?: string; /** * AI分析状态 */ AnalysisStatus?: number; /** * AI分析失败原因(失败时) */ AnalysisFailReason?: string; /** * API业务类型 */ ApiBizType?: string; /** * 风险类型(风险场景) */ RiskScenario?: string; /** * AI建议风险等级 */ AiSuggestedLevel?: number; /** * 目的IP地理信息 */ DstGeoLocation?: string; /** * 最高敏感等级 */ HighestLevel?: string; } /** * 新手引导扫描信息 */ export interface ScanInfo { /** * 进度 */ ScanPercent?: number; /** * 扫描结果信息 */ ScanResultInfo?: ScanResultInfo; /** * 扫描状态 0扫描中 1完成 2未勾选自动扫描 */ ScanStatus?: number; /** * 预计完成时间 */ ScanTime?: string; } /** * DeleteVpcFwGroup返回参数结构体 */ export interface DeleteVpcFwGroupResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * nat fw 实例展示的过滤列表 */ export interface NatFwFilter { /** * 过滤的类型,例如实例id */ FilterType: string; /** * 过滤的内容,以',' 分隔 */ FilterContent: string; } /** * 统计折线图通用结构体 */ export interface IpStatic { /** * 值 */ Num?: number; /** * 折线图横坐标时间 */ StatTime?: string; } /** * AddEnterpriseSecurityGroupRules返回参数结构体 */ export interface AddEnterpriseSecurityGroupRulesResponse { /** * 新增规则的摘要列表。 */ Rules?: Array防火墙实例运行状态
注意:此字段可能返回 null,表示取不到有效值。 */ CfwInsStatus?: Array0
*/ TotalCount?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteResourceGroup请求参数结构体 */ export interface DeleteResourceGroupRequest { /** * 组id */ GroupId: string; } /** * CreateAddressTemplate返回参数结构体 */ export interface CreateAddressTemplateResponse { /** * 创建结果,0成功 */ Status?: number; /** * 唯一Id */ Uuid?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeAclRegInfo请求参数结构体 */ export interface DescribeAclRegInfoRequest { /** * 防火墙类型 SERIAL:串行、NAT:NAT防火墙,BYPASS:旁路防火墙 */ FwType?: ArrayNAT集群防火墙地域状态查询列表
*/ NatClusterRegionStatusQueryList: Array偏移量,分页用
*/ Offset?: number; /** *条数,分页用
*/ Limit?: number; /** *排序字段,取值:UpdateTime最近更新时间,RulesNum关联规则数
*/ By?: string; /** *排序,取值 :asc正序,desc逆序
*/ Order?: string; /** *搜索值
*/ SearchValue?: string; /** *检索地址模板唯一id
*/ Uuid?: string; /** *模板类型,取值:1:ip模板,5:域名模板,6:协议端口模板
*/ TemplateType?: string; /** *模板Id
*/ TemplateId?: string; /** *模板来源
*/ SourceType?: string; } /** * RemoveAclRule请求参数结构体 */ export interface RemoveAclRuleRequest { /** *必填的规则 ID 列表。具体规则 ID 通过 DescribeCfwRules 查询 RuleType=border 和目标 RuleUuid,并使用返回的 rules[].uuid。列表恰为 [-1] 时删除 Direction 指定方向下当前账号的全部可操作规则,风险极高;其它列表按 ID 删除匹配规则。空列表返回 InternalError,不删除规则。成功响应回显请求中的 ID 列表。
*/ RuleUuid: ArrayAI操作来源
枚举值:
规则方向,JSON 整数:1 表示入站,0 表示出站。
RuleUuid 恰为 [-1] 时,本字段决定全量删除的方向;RuleUuid 为具体 ID 列表时,仅按 ID 匹配,不使用 Direction 筛选。字段省略时取值为 -1,不会按出站处理。
*/ Direction?: number; } /** * ModifyIpsModeSwitch返回参数结构体 */ export interface ModifyIpsModeSwitchResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeIPStatusList请求参数结构体 */ export interface DescribeIPStatusListRequest { /** * 资产Id */ IPList: Array同步状态:1,同步中;0,同步完成
*/ SyncStatus?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeNDRDataLeakOutAlertList返回参数结构体 */ export interface DescribeNDRDataLeakOutAlertListResponse { /** * 符合查询条件的总条数 */ Total?: number; /** * 查询结果列表 */ Data?: Array开关列表
*/ SwitchList?: Array开关总个数
*/ Total?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyBlockIgnoreRule返回参数结构体 */ export interface ModifyBlockIgnoreRuleResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeCcnAssociatedInstances返回参数结构体 */ export interface DescribeCcnAssociatedInstancesResponse { /** *实例总数
*/ Total?: number; /** *云联网关联的实例信息
*/ CcnAssociatedInstances?: Array模式 1:接入模式;0:新增模式
*/ Mode: number; /** *防火墙实例id
*/ CfwInstance: string; /** *接入模式重新接入的nat网关列表,其中NatGwList和VpcList只能传递一个。
*/ NatGwList?: Array新增模式重新接入的vpc列表,其中NatGwList和NatgwList只能传递一个。
*/ VpcList?: Array指定防火墙使用网段信息
*/ FwCidrInfo?: FwCidrInfo; } /** * DescribeVpcAclEdgeRange请求参数结构体 */ export interface DescribeVpcAclEdgeRangeRequest { /** * 规则列表来源:rules,来源于当前已配置的规则;switchs,来源于开关列表 */ FromList: string; /** * 需要查询的索引,特定场景使用,可不填 */ Index?: string; /** * 过滤条件组合 */ Filters?: Array每页条数
*/ Limit: number; /** *偏移值
*/ Offset: number; /** *需要查询的索引,特定场景使用,可不填
*/ Index?: string; /** *过滤条件组合,Direction 为0时表述查询出向规则,为1时表示查询入向规则
*/ Filters?: Array检索的起始时间,规则创建时间,可不传
参数格式:2022-07-27 16:00:00
*/ StartTime?: string; /** *检索的截止时间,规则创建时间,可不传
参数格式:2022-07-27 16:00:00
*/ EndTime?: string; /** *desc:降序;asc:升序。根据By字段的值进行排序,这里传参的话则By也必须有值,默认为asc
*/ Order?: string; /** *排序所用到的字段,默认为sequence
*/ By?: string; } /** * 标签信息 */ export interface TagInfo { /** * 目标key */ TagKey?: string; /** * 目标值 */ TagValue?: string; } /** * DescribeResourceGroup返回参数结构体 */ export interface DescribeResourceGroupResponse { /** * 返回树形结构 */ Data?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteSecurityGroupRule请求参数结构体 */ export interface DeleteSecurityGroupRuleRequest { /** * 所需要删除规则的ID */ Id: number; /** * 腾讯云地域的英文简写 */ Area: string; /** * 方向,0:出站,1:入站 */ Direction: number; /** * 是否删除反向规则,0:否,1:是 */ IsDelReverse?: number; } /** * 查询过滤条件 */ export interface OperatorFilter { /** * 过滤字段 */ Name: string; /** * 匹配的值 */ Values: Array地域总数量
*/ Total?: number; /** *地域防火墙引流网络状态列表
*/ RegionFwStatus?: Array错误信息列表
注意:此字段可能返回 null,表示取不到有效值。 */ Data?: Array偏移量,分页用
*/ Offset: number; /** *条数,分页用
*/ Limit: number; /** *过滤条件组合
*/ Filters?: Arraydesc:降序;asc:升序。根据By字段的值进行排序,这里传参的话则By也必须有值
*/ Order?: string; /** *排序所用到的字段
*/ By?: string; } /** * 日志存储统计柱形图 */ export interface StorageHistogram { /** * 访问控制日志存储量,单位B 注意:此字段可能返回 null,表示取不到有效值。 */ AclSize?: number; /** * 入侵防御日志存储量,单位B 注意:此字段可能返回 null,表示取不到有效值。 */ IdsSize?: number; /** * 流量日志存储量,单位B 注意:此字段可能返回 null,表示取不到有效值。 */ NetFlowSize?: number; /** * 操作日志存储量,单位B 注意:此字段可能返回 null,表示取不到有效值。 */ OperateSize?: number; /** * 统计时间 注意:此字段可能返回 null,表示取不到有效值。 */ Time?: string; /** * NDR流量日志存储量,单位B */ NDRNetflowSize?: number; /** * NDR风险日志存储量,单位B */ NDRRiskSize?: number; } /** * DescribeAddressTemplateList返回参数结构体 */ export interface DescribeAddressTemplateListResponse { /** *模板总数
*/ Total?: number; /** *模板列表数据
*/ Data?: Array模板名称列表
*/ NameList?: ArrayIp地址模板数量
*/ IpTemplateCount?: number; /** *域名地址模板数量
*/ DomainTemplateCount?: number; /** *协议端口模板数量
*/ PortTemplateCount?: number; /** *已使用的地址模板数
*/ UsedTemplateCount?: number; /** *地址模板配额数量
*/ TemplateQuotaCount?: number; /** *容器服务地址模板数量
*/ TkeTemplateCount?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 状态监控过滤条件。 */ export interface CfwStatusMonitorFilter { /** * 过滤字段名。 注意:此字段可能返回 null,表示取不到有效值。 */ Name: string; /** * 过滤值列表,最多 10 个。 注意:此字段可能返回 null,表示取不到有效值。 */ Values: Array返回状态
0 请求成功
2 请求失败
3 请求失败-频率限制
success 成功
其他失败
0 成功
非0 失败
查询结果。UTF-8 JSON object 字符串;调用方需解析 Response.Data。
*/ Data?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyClusterNatFwSwitch返回参数结构体 */ export interface ModifyClusterNatFwSwitchResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeRuleOverview返回参数结构体 */ export interface DescribeRuleOverviewResponse { /** * 规则总数 */ AllTotal?: number; /** * 阻断策略规则数量 */ StrategyNum?: number; /** * 启用规则数量 */ StartRuleNum?: number; /** * 停用规则数量 */ StopRuleNum?: number; /** * 剩余配额 */ RemainingNum?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateAlertCenterRuleAsync请求参数结构体 */ export interface CreateAlertCenterRuleAsyncRequest { /** *必填的告警方向:0 出向,1 入向,3 内网。用于 HandleIpList 中 IP 目标的处置方向;其它目标也必须传上述有效值。从 DescribeCfwAlerts 复制方向时,将 alerts[].direction 的 outbound、inbound、lateral 分别转换为 JSON 整数 0、1、3。
*/ AlertDirection: number; /** *必填的处置生效方向。支持空字符串、0(互联网出向)、1(互联网入向)、0,1/1,0(互联网双向)、3(内网访问)、5(内网访问源)、6(内网访问目的)及 5,6/6,5。空字符串表示按告警原方向处置;同一 IP 的已有规则方向会与本次方向合并。
*/ HandleDirection: string; /** *处置有效期:1 表示 1 天,7 表示 7 天,-2 表示永久。
*/ HandleTime: number; /** *必填的处置类型:1 按 HandleIdList 或 HandleEventIdList 封禁,2 按 HandleIdList、HandleEventIdList 或 BlockDomain 加白,3 按 HandleIpList 加白 IP,4 按 HandleIpList 封禁 IP,5 将 HandleIdList 或 HandleEventIdList 对应的安全基线告警地址加入指定方向的安全基线列表,8 按 HandleEventIdList 关联资产或 AssetIdList 新增隔离。五类目标至少提供一类;HandleType=8 未能从事件解析出资产时必须提供 AssetIdList。IsolateType 和 WhiteIpList 仅用于类型 8。
*/ HandleType: number; /** *资产隔离目标列表,可省略;仅 HandleType=8 使用。直接按资产隔离时,调用 DescribeCfwAssets,传 AssetType=host 和目标 InstanceId,解析返回结果;仅在唯一 assets[].instance_id 与目标完全相等时将其写入本字段,不使用资产名称。
*/ AssetIdList?: Array域名加白目标,传合法域名;HandleType 必须为 2,并同时传 TargetEventIdList。
*/ BlockDomain?: string; /** *AI操作来源
枚举值:
可选处置说明,最多 50 个 Unicode 字符。
*/ HandleComment?: string; /** *告警事件 ID 列表,可省略。通过 DescribeCfwAlerts 获取,返回 alerts[].current_event_id 时使用该值,否则使用 alerts[].event_id。事件对应的告警日志会与 HandleIdList 合并后参与处置。
*/ HandleEventIdList?: Array告警日志 ID 列表,可省略;可与 HandleEventIdList 同时使用。调用 DescribeLogs,传 Index=rule_threatinfo 和目标日志的查询条件,解析返回结果,仅使用目标记录的 log_id。告警事件 ID 使用 HandleEventIdList。
*/ HandleIdList?: ArrayIP 处置目标列表,每项必须是有效 IP 地址。HandleType=3 表示加白,HandleType=4 表示封禁;可使用 DescribeCfwAlerts 返回的 alerts[].src_ip_list 或 alerts[].dst_ip_list。
*/ HandleIpList?: Array处置原因,可省略:0 未指定原因,1 重复,2 误报,3 紧急加白;主要用于加白记录。
*/ IgnoreReason?: number; /** *隔离范围数组,可省略:1 互联网入站,2 互联网出站,4 内网访问。仅 HandleType=8 使用;组合多个范围时传入对应值且不要重复,重复值会改变最终隔离范围。
*/ IsolateType?: Array处置关联的来源事件 ID 列表,仅用于 HandleIpList 或 BlockDomain。BlockDomain 处置时必填,HandleIpList 处置时可省略;通过 DescribeCfwAlerts 获取,返回 alerts[].current_event_id 时使用该值,否则使用 alerts[].event_id。
*/ TargetEventIdList?: Array隔离后仍允许通信的 IPv4 地址列表,仅 HandleType=8 使用。可省略或传空数组;非空时每项必须是有效 IPv4 地址。
*/ WhiteIpList?: ArrayVPC防火墙实例名称
*/ FwInsName: string; /** *VPC防火墙实例ID
*/ FwInsId: string; /** *VPC防火墙实例模式 0: 旧VPC模式防火墙 1: CCN模式防火墙
*/ FwMode: number; /** *VPC防火墙接入网络实例个数
*/ JoinInsNum: number; /** *VPC防火墙开关个数
*/ FwSwitchNum: number; /** *VPC防火墙状态 0:正常 , 1:创建中 2: 变更中
*/ Status: number; /** *VPC防火墙创建时间
*/ Time: string; /** *VPC 相关云联网ID列表
*/ CcnId?: ArrayVPC 相关云联网名称列表
*/ CcnName?: ArrayVPC 相关对等连接ID列表
*/ PeerConnectionId?: ArrayVPC 相关对等连接名称列表
*/ PeerConnectionName?: ArrayVPC防火墙CVM的列表
*/ FwCvmLst?: ArrayVPC防火墙接入网络实例类型列表
*/ JoinInsLst?: Array防火墙网关信息
*/ FwGateway?: Array防火墙(组)ID
*/ FwGroupId?: string; /** *已使用规则数
*/ RuleUsed?: number; /** *最大规则数
*/ RuleMax?: number; /** *防火墙实例带宽
*/ Width?: number; /** *用户VPC墙总带宽
*/ UserVpcWidth?: number; /** *接入的vpc列表
*/ JoinInsIdLst?: Array内网间峰值带宽 (单位 bps )
*/ FlowMax?: number; /** *实例引擎版本
*/ EngineVersion?: string; /** *引擎是否可升级:0,不可升级;1,可升级
*/ UpdateEnable?: number; /** *引擎运行模式,Normal:正常, OnlyRoute:透明模式
*/ TrafficMode?: string; /** *引擎预约升级时间
*/ ReserveTime?: string; /** *预约引擎升级版本
*/ ReserveVersion?: string; /** *引擎预约升级版本状态
*/ ReserveVersionState?: string; /** *弹性开关 1打开 0关闭
*/ ElasticSwitch?: number; /** *弹性带宽,单位Mbps
*/ ElasticBandwidth?: number; /** *是否首次开通按量付费
1 是
0 不是
按流量弹性开关
取值范围:[0, 1]
默认值:0
*/ ElasticTrafficSwitch?: number; } /** * ModifyNatAcRule请求参数结构体 */ export interface ModifyNatAcRuleRequest { /** *待修改的规则数组,必须恰好包含一条完整规则,不是局部更新。调用 DescribeCfwRules,传 RuleType=nat、目标 RuleUuid、ExpandNames=false 获取原规则。字段转换:uuid→Uuid,sequence→OrderIndex,src_ip→SourceContent,src_type→SourceType,dst_content→TargetContent,dst_type→TargetType,dst_port→Port,detail→Description;action 的 0、1、2 分别转换为 log、drop、accept,enabled 的布尔值转换为字符串 true、false;protocol、direction、scope、param_template_id 分别写入 Protocol、Direction、Scope、ParamTemplateId。src_type 和 dst_type 的 1、2、3、4/5、6、8、9、10、100、101、102 分别对应 net、url、domain、template、instance、tag、dnsparse、domainiptwoverify、group、location、vendor;仅当转换结果属于对应 SourceType 或 TargetType 的有效取值时才能提交。用户要求改为某地域时,调用 DescribeAclRegInfo,传 FwType=["NAT"],按用户地域名称匹配 Data[].RegionName,并将对应 Data[].RegionCode 写入 location 类型的 Content;不得使用 ap-guangzhou 等云资源地域、中文地域名称或自行拼接代码。vendor 类型的 Content 仅使用 tencent、aliyun、aws、huawei、azure 或 all,不使用“腾讯云”等展示名称。省略字段使用对应参数的默认值或空值,不继承旧值。地址模板和协议端口模板通过 DescribeAddressTemplateList 查询,资产实例通过 DescribeCfwAssets 查询,资源组和标签通过 DescribeResourceGroupNew 查询。
*/ Rules: ArrayAI操作来源
枚举值:
nat 防火墙 id
*/ NatFwInsId: string; /** *DNS 开关切换列表
*/ DnsVpcSwitchLst: Array0 关闭开关
1 打开开关
2 不操作开关,此次切换模式
操作开关详情
*/ EdgeIpSwitchLst?: Array0 不自动选择子网
1 自动选择子网创建私有连接
0 切换为旁路
1 切换为串行
2 不切换模式,此次操作开关
实例ID
*/ InstanceId: string; /** *实例名称
*/ InstanceName: string; /** *实例类型,3是cvm实例,4是clb实例,5是eni实例,6是云数据库
*/ Type: number; /** *私有网络ID
*/ VpcId: string; /** *私有网络名称
*/ VpcName: string; /** *公网IP
*/ PublicIp: string; /** *内网IP
*/ Ip: string; /** *关联安全组数量
*/ SecurityGroupCount: number; /** *关联安全组规则数量
*/ SecurityGroupRuleCount?: number; /** *关联数据库代理Id
*/ CdbId?: string; /** *容器服务集群ID
*/ TkeClusterId?: string; } /** * ModifyNatAcRule返回参数结构体 */ export interface ModifyNatAcRuleResponse { /** * 修改后的规则 ID 列表,成功时包含请求规则的 Uuid。 */ RuleUuid?: Array返回状态码 0 成功 非0不成功
*/ ReturnCode?: number; /** *返回信息 success 成功 其他 不成功
*/ ReturnMsg?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyAssetScan请求参数结构体 */ export interface ModifyAssetScanRequest { /** * 扫描范围:1端口, 2端口+漏扫 */ ScanRange: number; /** * 扫描深度:'heavy', 'medium', 'light' */ ScanDeep: string; /** * 扫描类型:1立即扫描 2 周期任务 */ RangeType: number; /** * RangeType为2 是必须添加,定时任务时间 */ ScanPeriod?: string; /** * 立即扫描这个字段传过滤的扫描集合 */ ScanFilterIp?: Array防火墙组ID
*/ FwGroupId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 企业安全组域名解析的IP统计 */ export interface SgDnsParseCount { /** * 有效下发的IP个数,离散数据 */ ValidCount?: number; /** * 未下发的IP个数,离散数据 */ InvalidCount?: number; } /** * DescribeClusterNatCcnFwSwitchList请求参数结构体 */ export interface DescribeClusterNatCcnFwSwitchListRequest { /** *NAT防火墙类型筛选,取值:nat-VPC内防护类型,nat_ccn-CCN集群模式类型,不传则同时查询两种类型
*/ NatType?: string; /** *每页条数,默认100
*/ Limit?: number; /** *偏移量,默认0
*/ Offset?: number; /** *过滤条件列表,支持按Common(通用搜索)、InsObj(实例ID)、ObjName(实例名称)等字段过滤
*/ Filters?: Array支持自动接入和策略路由的CCN列表
注意:此字段可能返回 null,表示取不到有效值。 */ SupportCcnPolicy?: Array自动接入中支持自定义cidr的CCN列表
注意:此字段可能返回 null,表示取不到有效值。 */ SupportCcnPolicyCidr?: ArrayNAT防火墙实例ID
*/ NatInsId: string; /** *云联网实例ID
*/ CcnId: string; /** *开关接入模式,1:自动接入,2:手动接入
*/ SwitchMode: number; /** *引流路由方法,0:多路由表,1:策略路由。自动接入模式仅支持策略路由(1);手动接入模式支持多路由表(0)和策略路由(1)
*/ RoutingMode: number; /** *接入的实例列表
*/ AccessInstanceList?: Array引流VPC的CIDR网段
*/ LeadVpcCidr?: string; } /** * DeleteRemoteAccessDomain请求参数结构体 */ export interface DeleteRemoteAccessDomainRequest { /** * 域名列表 */ AccessDomainList: Array返回状态码 0 成功 非0不成功
*/ ReturnCode?: number; /** *返回信息 success 成功 其他 不成功
*/ ReturnMsg?: string; /** *已使用存储量,单位B
*/ UsedSize?: number; /** *配额存储总量,单位B
*/ TotalSize?: number; /** *存储天数
*/ StorageDay?: number; /** *访问控制日志存储量,单位B
*/ AclSize?: number; /** *入侵防御日志存储量,单位B
*/ IdsSize?: number; /** *流量日志存储量,单位B
*/ NetFlowSize?: number; /** *操作日志存储量,单位B
*/ OperateSize?: number; /** *剩余存储量,单位B
*/ LeftSize?: number; /** *计费模式,0后付费,1预付费
*/ PayMode?: number; /** *每日增加日志存储量柱状图
*/ TimeHistogram?: Array柱形图格式数据
*/ TimeHistogramShow?: StorageHistogramShow; /** *后付费模式存储状态,0正常,1欠费停止写入
*/ ArrearsStopWriting?: number; /** *NDR流量日志存储量,单位B
*/ NDRNetFlowSize?: number; /** *NDR风险日志存储量,单位B
*/ NDRRiskSize?: number; /** *NDR日志存储天数
*/ NDRStorageDay?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeOfflineExportTask请求参数结构体 */ export interface DescribeOfflineExportTaskRequest { /** *分页参数
*/ Limit: number; /** *分页参数
*/ Offset: number; /** *任务ID/任务名称
*/ TaskName?: string; } /** * DescribeSourceAsset请求参数结构体 */ export interface DescribeSourceAssetRequest { /** * ChooseType为1,查询已经分组的资产;ChooseType不为1查询没有分组的资产 */ ChooseType?: string; /** * 模糊查询 */ FuzzySearch?: string; /** * 资产类型 1公网 2内网 */ InsType?: string; /** * 查询单页的最大值;eg:10;则最多返回10条结果 */ Limit?: number; /** * 查询结果的偏移量 */ Offset?: number; /** * 地域 */ Zone?: string; } /** * DescribeCfwInsStatus请求参数结构体 */ export type DescribeCfwInsStatusRequest = null; /** * 日志中的KV对 */ export interface LogItem { /** * 日志Key */ Key?: string; /** * 日志Value */ Value?: string; } /** * 开关切换错误 */ export interface SwitchError { /** * 开关唯一标识 注意:此字段可能返回 null,表示取不到有效值。 */ ErrIns?: string; /** * 错误信息 注意:此字段可能返回 null,表示取不到有效值。 */ ErrMsg?: string; /** * 错误类型区分 注意:此字段可能返回 null,表示取不到有效值。 */ ErrKey?: string; /** * 错误时间 注意:此字段可能返回 null,表示取不到有效值。 */ InsertTime?: string; } /** * DescribeNatRuleScopes请求参数结构体 */ export type DescribeNatRuleScopesRequest = null; /** * DescribeCfwRuleOptimization请求参数结构体 */ export interface DescribeCfwRuleOptimizationRequest { /** *防火墙规则类型。必填。枚举:border 互联网边界;nat NAT 边界;vpc VPC 间;enterprise_sg 企业安全组。
*/ RuleType: string; /** *要执行的优化维度白名单。可选,例如 D1、D2、D8;不传默认执行全部支持维度。
*/ Dimensions?: Array长期零命中规则阈值天数。可选,默认 180。
*/ IdleDays?: number; /** *单 IP 离散过多聚合建议的最小数量。可选,默认 10。
*/ IpAggMin?: number; /** *可迁移 IOC 建议中返回的样例 IOC 数量上限。可选,默认 50。
*/ IocSample?: number; } /** * 前端图表使用日志存储统计柱形图数据 */ export interface StorageHistogramShow { /** * 存储类型 注意:此字段可能返回 null,表示取不到有效值。 */ StorageType?: Array开始时间
参数格式:2026-07-01 15:02:01
*/ StartTime?: string; /** *结束时间
参数格式:2026-07-01 15:02:01
*/ EndTime?: string; } /** * DescribeFwGroupInstanceInfo返回参数结构体 */ export interface DescribeFwGroupInstanceInfoResponse { /** *防火墙(组)详细信息
*/ VpcFwGroupLst?: Array防火墙(组)个数
*/ Total?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeAssetSync返回参数结构体 */ export interface DescribeAssetSyncResponse { /** *返回状态
1 更新中
2 更新完成
3 更新失败
4 更新失败
success 成功
其他失败
0 成功
非0 失败
已有CVM数量
*/ CVMCount?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyNatSequenceRules返回参数结构体 */ export interface ModifyNatSequenceRulesResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 私有连接端点信息 */ export interface EndpointInfo { /** * 引流私有连接端点id */ EndpointId?: string; /** * 引流VpcId */ VpcId?: string; /** * 所属地域 */ Region?: string; /** * 引流Vpc的Cidr */ VpcCidr?: string; } /** * 查询下拉选择选项数据 */ export interface FilterDataObject { /** * 显示名称 注意:此字段可能返回 null,表示取不到有效值。 */ Text?: string; /** * 实际值 注意:此字段可能返回 null,表示取不到有效值。 */ Value?: string; } /** * DescribeNatFwInfoCount返回参数结构体 */ export interface DescribeNatFwInfoCountResponse { /** *返回参数 success 成功 failed 失败
*/ ReturnMsg?: string; /** *当前租户的nat防火墙实例个数
*/ NatFwInsCount?: number; /** *当前租户接入防火墙的子网个数
*/ SubnetCount?: number; /** *打开NAT防火墙开关个数
*/ OpenSwitchCount?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 规则生效范围信息 */ export interface RuleScopeInfo { /** * NAT边界防火墙:ALL,全局生效;ap-guangzhou,生效的地域;cfwnat-xxx,生效基于实例维度 注意:此字段可能返回 null,表示取不到有效值。 */ Scope?: string; /** * 生效范围描述 注意:此字段可能返回 null,表示取不到有效值。 */ ScopeDesc?: string; } /** * ModifyVpcFwGroup请求参数结构体 */ export interface ModifyVpcFwGroupRequest { /** *编辑的防火墙(组)ID
*/ FwGroupId: string; /** *修改防火墙(组)名称
*/ Name?: string; /** *编辑的防火墙实例列表
*/ VpcFwInstances?: Array指定防火墙使用网段信息
*/ FwCidrInfo?: FwCidrInfo; } /** * ModifyEnterpriseSecurityDispatchStatus返回参数结构体 */ export interface ModifyEnterpriseSecurityDispatchStatusResponse { /** * 0: 修改成功, 其他: 修改失败 */ Status?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 接入防火墙的互联集合对 */ export interface InterconnectPair { /** * 集合A */ GroupA: Array开关接入模式,1-自动接入,2-手动接入
枚举值:
引流路由方法,0-多路由表,1-策略路由
枚举值:
Bypass状态,0-关闭,1-开启
枚举值:
云联网实例ID
*/ CcnId?: string; /** *接入的实例列表
*/ AccessInstanceList?: Array0:同步成功,1:资产更新中,2:后台同步调用失败
*/ Status?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateWhiteRule请求参数结构体 */ export interface CreateWhiteRuleRequest { /** * 使用 JSON integer 表示白名单类型,一次请求使用一种: - 2 精确外部 IP:Rules[].Info.SrcIP、Rules[].Info.DstIP 两个字段中恰好填写一个。 - 3 域名:填写 Rules[].Info.Ioc。 - 4 威胁情报:填写 Rules[].Info.Ioc,FwType=1。 - 5 资产:Rules[].Info.SrcIP、Rules[].Info.DstIP 两个字段中恰好填写一个,值取 DescribeCfwAssets 的 instance_id。 - 6 IPS 自定义:Rules[].Info.IdsRuleId 必填,Rules[].Info.SrcIP、Rules[].Info.DstIP 至少一项为具体 IP;FwType=16 时目的 IPv4 可带端口;FwType 包含 1 时具体 IP 至少一项属于当前账号资产。 - 8 IP 扩展:在 Rules[].Info 中填写 CIDR、端口或源/目的组合。 - 9 NDR 扩展:FwType=16,Rules[].Info 至少填写一个 UserAgent、Url、XForwardedFor、HostName、FileName、FileMd5;可组合 SrcIP、DstIP,搭配 IdsRuleId 时同时填写 SrcIP 或 DstIP。 */ RuleType: number; /** * JSON object 数组,至少一项;每项填写 1–50 个字符的 RuleName,且同一请求内名称唯一。列表内共用一个 RuleType,不同类型分次调用。Rules[].Info 多值字段按笛卡尔积展开,一次请求展开后最多 100 条。WhiteId 由服务端生成,Id 和 IdsRuleName 由服务端管理。 */ Rules: Array云联网ID
*/ CcnId: string; } /** * DescribeSecurityGroupRegionList返回参数结构体 */ export interface DescribeSecurityGroupRegionListResponse { /** *配置信息
*/ Data?: Array总数
*/ Total?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeIPStatusList返回参数结构体 */ export interface DescribeIPStatusListResponse { /** * IP状态信息 */ StatusList?: Array模板ID
*/ Uuid?: string; /** *模板名称
*/ Name?: string; /** *描述
*/ Detail?: string; /** *IP模板
*/ IpString?: string; /** *插入时间
*/ InsertTime?: string; /** *修改时间
*/ UpdateTime?: string; /** *模板类型
*/ Type?: number; /** *关联规则条数
*/ RulesNum?: number; /** *模板Id
*/ TemplateId?: string; /** *协议端口模板,协议类型,4:4层协议,7:7层协议
*/ ProtocolType?: string; /** *模板包含地址数量
*/ IPNum?: number; /** *IP版本,0,IPv4;1,IPv6
*/ IpVersion?: number; } /** * 封禁或放通规则条目;各字段的校验、归一化和实际用途由 RuleType 决定。 */ export interface BanAndAllowRule { /** * 规则备注,最多 200 个字符。 */ Comment?: string; /** * 自定义放通规则详情。RuleType=6 时使用;其它规则类型不读取此字段。 */ CustomRule?: CustomWhiteRule; /** * 生效方向,多个取值以逗号分隔:0 互联网出向、1 互联网入向、5 内网访问源、6 内网访问目的。互联网双向传 "1,0",内网双向传 "5,6"。RuleType=1 时传 0、1 或 "1,0";RuleType=2 时,公网 IP 传 0、1 或 "1,0",私网 IP 传 5、6 或 "5,6";RuleType=3 时传 0、6 或 "0,6";RuleType=4 时传 "1,0";RuleType=5 时传 5、6 或 "5,6";RuleType=6 时按规则适用方向组合 0、1、5、6,并在创建后查询最终方向。所有 RuleType 均须显式传入非空值。 */ DirectionList?: string; /** * 规则截止时间,使用北京时间(UTC+8)的 YYYY-MM-DD HH:MM:SS 格式,且不得早于服务器处理时刻;3000-01-01 00:00:00 表示长期有效。 */ EndTime?: string; /** * RuleType=6 的生效引擎位图:1 互联网边界旁路、2 NAT 防火墙、4 VPC 防火墙、8 互联网边界串行、16 NDR;组合值按位相加,取值范围为 0 至 31。非零值会与源、目的地址适用的引擎取交集,并保留 NDR 位;结果为 0 时,IPv6 或私网 IPv4 地址使用 6,其它地址使用 15。其它 RuleType 不使用该字段。 */ FwType?: number; /** * 规则对象。RuleType=1 或 2 时传 IP 地址,RuleType=3 时传域名,RuleType=4 时传情报标识,RuleType=5 时使用 DescribeCfwAssets 返回的 assets[].instance_id。RuleType=6 新建时必须显式传空字符串,由服务生成规则 ID,不可省略。更新既有自定义规则时传入该规则的现有 ID。 */ Ioc?: string; } /** * NDR资产服务统计结果 */ export interface NDRAssetServiceStats { /** * 服务名称 */ Name?: string; /** * 服务计数 */ Count?: number; } /** * 多日志主题检索topic信息 */ export interface SearchLogInfos { /** * 日志主题ID */ TopicId?: string; /** * 日志存储生命周期 */ Period?: number; /** * 透传本次接口返回的Context值,可获取后续更多日志,过期时间1小时 注意:此字段可能返回 null,表示取不到有效值。 */ Context?: string; } /** * ModifyStorageSetting请求参数结构体 */ export type ModifyStorageSettingRequest = null; /** * DescribeEdgeIpSimple返回参数结构体 */ export interface DescribeEdgeIpSimpleResponse { /** * ip 开关列表 */ Data?: Array需要查询的索引,特定场景使用,可不填
*/ Index?: string; /** *过滤条件组合
*/ Filters?: Array每页条数
*/ Limit?: number; /** *偏移值
*/ Offset?: number; /** *检索的起始时间,可不传
*/ StartTime?: string; /** *检索的截止时间,可不传
*/ EndTime?: string; /** *desc:降序;asc:升序。根据By字段的值进行排序,这里传参的话则By也必须有值,可不传
*/ Order?: string; /** *排序所用到的字段,可不传
*/ By?: string; } /** * DescribeBlockStaticList请求参数结构体 */ export interface DescribeBlockStaticListRequest { /** * 结束时间 */ EndTime: string; /** * 列表类型,只能是下面三种之一:port、address、ip */ QueryType: string; /** * 开始时间 */ StartTime: string; /** * top数 */ Top: number; /** * 查询条件 */ SearchValue?: string; } /** * 防火墙引流网关信息 */ export interface FwGateway { /** * 防火墙网关id */ GatewayId: string; /** * 网关所属vpc id */ VpcId: string; /** * 网关ip地址 */ IpAddress: string; } /** * 设置nat防火墙的vpc dns 接入开关 */ export interface DnsVpcSwitch { /** * vpc id */ VpcId: string; /** * 0:设置为关闭 1:设置为打开 */ Status: number; } /** * ModifyClusterFwBypass请求参数结构体 */ export interface ModifyClusterFwBypassRequest { /** *防火墙类型,"VPC_FW"-VPC防火墙,"NAT_FW"-NAT防火墙
*/ FwType: string; /** *云联网实例ID
*/ CcnId: string; /** *Bypass开关,true-开启Bypass(禁用正常下一跳,流量绕过防火墙),false-关闭Bypass(启用正常下一跳,流量经过防火墙)
*/ Enable: boolean; /** *NAT防火墙实例ID,FwType为nat时必填
*/ NatInsId?: string; } /** * NAT防火墙开关详情 */ export interface NatFwSwitchDetailS { /** *NAT实例ID
*/ InsObj?: string; /** *实例名称
*/ ObjName?: string; /** *防火墙类型
*/ FwType?: string; /** *资产类型,nat-VPC内防护,nat_ccn-CCN集群模式
*/ AssetType?: string; /** *地域
*/ Region?: string; /** *开关接入模式,1-自动接入,2-手动接入
*/ SwitchMode?: number; /** *引流路由方法,0-多路由表,1-策略路由
*/ RoutingMode?: number; /** *开关状态,0-未开启,1-已开启,2-开启中,3-关闭中
*/ Status?: number; /** *ip版本,0:ipv4;1:ipv6
*/ IpVersion?: number; /** *是否非集群模式,0-集群模式,1-非集群模式
*/ NonCluster?: number; /** *入侵防御动作
*/ IpsAction?: number; /** *流量监控开关
*/ TransEnable?: number; /** *Bypass状态,0-关闭,1-开启
*/ Bypass?: number; /** *关联ID,nat_ccn资产类型时为云联网实例ID, nat资产类型时为空
*/ AttachId?: string; /** *关联ID的实例名称,nat_ccn资产类型时为云联网名称
*/ AttachName?: string; /** *NAT防火墙所在VPC ID
*/ NatVpcId?: string; /** *NAT防火墙所在VPC的VPC名称
*/ NatVpcName?: string; /** *CCN关联实例列表
注意:此字段可能返回 null,表示取不到有效值。 */ AttachIns?: Array终端节点列表
注意:此字段可能返回 null,表示取不到有效值。 */ Endpoints?: Array防火墙开关操作时的进度状态:
// 开启 — 自动模式(3步)
"AUTO_OPEN_ORCHESTRATING" // 步骤1: 预编排策略路由
"AUTO_OPEN_CREATING_RESOURCES" // 步骤2: 创建引流网络和资源
"AUTO_OPEN_PUSHING_ROUTES" // 步骤3: 创建策略路由
// 开启 — 手动模式(1步)
"MANUAL_OPEN_CREATING_RESOURCES" // 步骤1: 创建引流网络和资源
// 关闭 — 自动模式(2步)
"AUTO_CLOSE_DELETING_ROUTES" // 步骤1: 删除策略路由
"AUTO_CLOSE_DELETING_RESOURCES" // 步骤2: 删除引流网络和资源
// 关闭 — 手动模式(1步)
"MANUAL_CLOSE_DELETING_RESOURCES" // 步骤1: 删除引流网络和资源
// 修改 — 自动模式(3步)
"AUTO_MODIFY_ORCHESTRATING" // 步骤1: 预编排策略路由
"AUTO_MODIFY_DELETING_ROUTES" // 步骤2: 删除旧策略路由
"AUTO_MODIFY_PUSHING_ROUTES" // 步骤3: 创建新策略路由
// 修改 — 手动模式(1步,仅 VPC 防火墙存在手动模式修改)
"MANUAL_MODIFY_UPDATING_RESOURCES" // 步骤1: 更新引流网络和资源
预接入检查结果
*/ CheckResult?: ClusterFwPreAccessCheckResult; } /** * DescribeCfwAssets请求参数结构体 */ export interface DescribeCfwAssetsRequest { /** *资产类型。可选,默认 host;枚举 host 主机资产、vpc VPC 网络、subnet 子网。
*/ AssetType?: string; /** *IP 地址过滤。可选,支持部分匹配;适用于 host。
*/ Ip?: string; /** *实例 ID 过滤。可选,适用于 host。
*/ InstanceId?: string; /** *VPC ID 过滤。可选,适用于 host、vpc、subnet。
*/ VpcId?: string; /** *子网 ID 过滤。可选,适用于 host、subnet。
*/ SubnetId?: string; /** *实例类型过滤。可选,适用于 host;常见值包括 CVM、CLB、ENI、POD、MYSQL、REDIS、MARIADB、NAT、VPN、HAVIP、NATFW、GAAP、DC。
*/ InstanceType?: string; /** *最大返回资产数。可选,默认 100,最大 1000。
*/ Limit?: number; /** *上一页 Response.Data 返回的不透明资产或指纹续查 token。首次查询不传;续查时只传 NextToken,不能同时传 AssetType、过滤条件或 Limit。调用方无需区分 token 类型;无效、篡改或租户不匹配会被拒绝。
*/ NextToken?: string; } /** * DescribeNatFwSwitch返回参数结构体 */ export interface DescribeNatFwSwitchResponse { /** *总数
注意:此字段可能返回 null,表示取不到有效值。 */ Total?: number; /** *NAT边界防火墙开关列表数据
注意:此字段可能返回 null,表示取不到有效值。 */ Data?: Array开关相关VPC列表
注意:此字段可能返回 null,表示取不到有效值。 */ VpcList?: Array开关相关NAT列表
注意:此字段可能返回 null,表示取不到有效值。 */ NatList?: Array开关相关ROUTE列表
注意:此字段可能返回 null,表示取不到有效值。 */ RouteList?: Array开启开关个数
注意:此字段可能返回 null,表示取不到有效值。 */ OnNum?: number; /** *关闭开关个数
注意:此字段可能返回 null,表示取不到有效值。 */ OffNum?: number; /** *失败开关状态
注意:此字段可能返回 null,表示取不到有效值。 */ FailData?: Array防火墙(组)Id
*/ FwGroupId?: string; /** *是否删除整个防火墙(组)
0:不删除防火墙(组),只删除单独实例
1:删除整个防火墙(组)
待删除的防火墙实例数组
*/ VpcFwInsList?: Array0: 互联网防火墙开关,1:vpc 防火墙开关
*/ Type?: number; } /** * CreateAcRules返回参数结构体 */ export interface CreateAcRulesResponse { /** * 状态值,0:操作成功 */ Status?: number; /** * 返回多余的信息 */ Info?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyAssetScan返回参数结构体 */ export interface ModifyAssetScanResponse { /** * 接口返回信息 */ ReturnMsg?: string; /** * 接口返回错误码,0请求成功 非0失败 */ ReturnCode?: number; /** * 状态值 0:成功,1 执行扫描中,其他:失败 */ Status?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyAllPublicIPSwitchStatus请求参数结构体 */ export interface ModifyAllPublicIPSwitchStatusRequest { /** * 状态,0:关闭,1:开启 */ Status: number; /** * 选中的防火墙开关Id */ FireWallPublicIPs?: ArrayNAT 边界访问控制规则 ID 列表。具体规则 ID 通过 DescribeCfwRules 查询 RuleType=nat 和目标 RuleUuid,并使用返回的 rules[].uuid。数组仅含 -1 时删除 Direction 指定方向下当前账号的全部可操作规则,风险极高;其它数组按 ID 删除。至少匹配一条即成功;具体 ID 删除不按 Direction 筛选。成功响应回显请求中的 ID 列表。
*/ RuleUuid: ArrayAI操作来源
枚举值:
规则方向:1 表示入站,0 表示出站。仅 RuleUuid 恰好为 [-1] 时用于选择全删方向;按具体 ID 删除时可省略,Direction 不参与 ID 筛选。全删时必须使用 0 或 1。
*/ Direction?: number; } /** * DescribeNatFwInstance返回参数结构体 */ export interface DescribeNatFwInstanceResponse { /** *实例数组
*/ NatinsLst?: Arraynat ccn集群防火墙列表
*/ NatClusterLst?: Array过滤条件组合
*/ Filters?: Array每页条数
*/ Limit?: number; /** *偏移值
*/ Offset?: number; /** *检索的起始时间,可不传
*/ StartTime?: string; /** *检索的截止时间,可不传
*/ EndTime?: string; /** *desc:降序;asc:升序。根据By字段的值进行排序,这里传参的话则By也必须有值
*/ Order?: string; /** *排序所用到的字段
*/ By?: string; } /** * ModifyEWRuleStatus返回参数结构体 */ export interface ModifyEWRuleStatusResponse { /** * 状态值,0:修改成功,非0:修改失败 */ ReturnCode?: number; /** * 状态信息,success:查询成功,fail:查询失败 */ ReturnMsg?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 互联网边界访问控制规则的完整内容,供新增和修改共用。新增时缺省值按各字段说明处理;修改时完整替换可写内容,省略的可写字段不继承旧值,系统管理字段不受影响。 */ export interface CreateRuleItem { /** *规则方向:1 表示入站,0 表示出站;其它整数或省略会校验失败。方向还决定 SourceType、TargetType、Scope 与 Protocol 的可用组合。
*/ Direction: number; /** *规则顺序。不传默认为-1,传 -1 时追加到当前方向末尾;正序号表示在对应位置插入并顺延后续规则;0 按 1 处理,其他负数及超范围值不应使用。新增请求包含多条规则时,Direction 必须相同;追加时全部传 -1,插入时按请求顺序传连续递增的正序号。修改请求只接受一条规则。
*/ OrderIndex: number; /** *目的端口。Protocol 为 ICMP 时忽略本字段并置为空字符串;其它协议必须提供可解析字符串,可按逗号分隔填写正整数单端口或“起始/结束”范围,起始值不得大于结束值,-1/-1 表示全部端口。FTP 只接受单个正整数。domain 或域名模板目的在 side 或 all 范围下仅接受 -1/-1 或 0/65535。
*/ Port: string; /** *协议,解析不区分大小写。四层值 TCP、UDP、ICMP、ICMPV6、ANY 归一化为大写;应用层值 HTTP、HTTPS、HTTP/HTTPS、SMTP、SMTPS、SMTP/SMTPS、FTP、DNS、TLS/SSL 及别名 domain、TLS、SSL 归一化为对应标准值。ANY 表示不限定协议,不表示省略 Protocol;它同时属于可解析的四层协议和应用协议,domain、TLS、SSL 均归一化为 TLS/SSL。domain 或域名模板目的接受上述应用层协议及 ANY,但不接受 FTP 和其它四层协议;dnsparse、domainiptwoverify 仅接受 TCP 或 UDP 且仅支持 serial;其它目的在公有云环境不接受 FTP、ANY 之外的应用层协议。side 或 all 范围下,入站仅接受 TCP,出站仅接受 TCP、HTTP/HTTPS 或 TLS/SSL。DNS 用于非 domain 目的且目的不是 * 时,目的内容还必须是非 IP 的合法域名规则列表。使用协议端口模板时,模板中的每组协议和端口也执行这些联动校验。
*/ Protocol: string; /** *流量处理动作,解析不区分大小写。accept 表示放行,drop 表示拒绝,log 表示观察;isolateinaccept 表示放行访问隔离资产的白名单流量,isolateindrop 表示阻断访问隔离资产的其它流量,isolateoutaccept 表示放行隔离资产访问白名单目标,isolateoutdrop 表示阻断隔离资产访问其它目标。drop 及其拒绝别名还会校验当前账号是否具备互联网边界阻断能力。
*/ RuleAction: string; /** *访问源内容。ip 或 net 使用合法 IP/CIDR 列表,普通列表最多 10 项;template 使用当前账号可解析的地址模板标识;Direction=0 时,instance、group、tag 使用相应资源标识,其中 instance 必须能解析到公网 IP,tag 必须存在且格式为 {"Key":"标签键","Value":"标签值"};Direction=1 时,location 使用地域 code CSV 并须通过当前账号的新地域规则能力校验,vendor 使用 tencent、aliyun、aws、huawei、azure 或 all 的 CSV。location、vendor 保存时会转换为地域或厂商匹配信息。
*/ SourceContent: string; /** *访问源类型,解析不区分大小写。net、ip 均表示 IP/CIDR,template 表示地址模板,instance 表示资产实例,group 表示资产分组,tag 表示资源标签,location 表示地域,vendor 表示云厂商。Direction=1 接受 ip、net、template、location、vendor;Direction=0 接受 ip、net、template、instance、group、tag。ip 与 net 按同一类型处理。
*/ SourceType: string; /** *访问目的内容。ip 或 net 使用合法 IP/CIDR 列表;domain 使用合法的 IP、普通域名或通配域名列表,也接受单独的 *;普通列表最多 10 项,通配域名最多 5 级。domain 配合 DNS 协议时不接受 IP。dnsparse 使用单个合法域名、泛域名或当前账号可解析的 mb_ 域名模板,domainiptwoverify 使用单个不含通配符的合法域名或此类模板;两者均不接受单独的 *、IP、逗号列表或段内通配域名。串行 domain 段内通配和 domainiptwoverify 模板要求当前环境支持对应能力。template 使用当前账号可解析的地址模板标识;Direction=1 时,instance、group、tag 使用相应资源标识,其中 instance 必须能解析到公网 IP,tag 必须存在且格式为 {"Key":"标签键","Value":"标签值"};Direction=0 时,location 使用地域 code CSV,vendor 使用 tencent、aliyun、aws、huawei、azure 或 all 的 CSV。规范化后的内容最长 1023。
*/ TargetContent: string; /** *访问目的类型,解析不区分大小写。net、ip 均表示 IP/CIDR,template 表示地址模板,instance 表示资产实例,group 表示资产分组,tag 表示资源标签,location 表示地域,vendor 表示云厂商,domain 表示 FQDN 匹配(内容也可传 IP 或 *),dnsparse 表示宽松匹配:Host/SNI 与域名匹配,或目的 IP 属于该域名当前 DNS 解析结果,满足任一条件即命中;domainiptwoverify 表示严格匹配:上述两个条件必须同时满足。Direction=1 接受 ip、net、template、domain、instance、group、tag;Direction=0 接受 ip、net、template、domain、dnsparse、domainiptwoverify、location、vendor。
*/ TargetType: string; /** *规则描述,不超过 100 个字符。新增时按请求值保存;修改时完整替换,不继承旧值。
*/ Description?: string; /** *启用状态。非空值不区分大小写接受字符串 true 或 false,并归一化为启用或停用;省略或传空字符串时读取当前账号的访问控制默认启用配置,该配置不可用时默认启用。替换现有规则时不继承旧值。
*/ Enable?: string; /** *关联告警或来源事件 ID。新增时省略或传空字符串表示不关联;修改时应将 DescribeCfwRules 返回的 rules[].log_id 原样传入,未返回时省略或传空字符串。替换时不会自动继承旧值;From=batch_import_cover 时,非空值还会作为覆盖导入后规则的字符串标识复用。
*/ LogId?: string; /** *协议端口模板 ID。省略或传空字符串表示不使用模板;非空时必须指向当前账号已有且内容格式为“协议:端口”的模板,否则请求失败。模板中的协议和端口须满足 Direction、TargetType 与 Scope 的联动限制。Protocol 和 Port 仍须符合各自字段规则,但不要求固定填写 ANY、-1/-1 或 serial。
*/ ParamTemplateId?: string; /** *规则来源:0 表示普通规则,2 表示隔离资产出向访问规则。新增时可以省略,省略按 0 处理;显式传值及修改时仅接受 0 或 2,修改时应传入原规则值。
*/ RuleSource?: number; /** *生效范围,必填,解析不区分大小写:serial 表示仅互联网边界串行防火墙,side 表示仅互联网边界旁路防火墙,all 表示同时作用于串行和旁路防火墙;省略、空字符串或其它值会校验失败。国际站环境会将有效输入统一归一化为 serial。协议、端口、目的类型及协议端口模板的联动限制见 Protocol、Port 和 ParamTemplateId。
*/ Scope?: string; /** *规则数值 ID。普通新增、指定位置新增和批量导入会忽略该字段;From=batch_import_cover 时可使用正整数 ID;修改时必须提供当前账号已有且可修改的正整数 ID,用于定位并完整替换原规则,省略、非正整数或不存在的 ID 会导致请求失败。
*/ Uuid?: number; } /** * CloseClusterNatFwSwitch请求参数结构体 */ export interface CloseClusterNatFwSwitchRequest { /** *NAT防火墙实例ID
*/ NatInsId: string; /** *云联网实例ID
*/ CcnId: string; } /** * ModifyClusterNatFwSwitch请求参数结构体 */ export interface ModifyClusterNatFwSwitchRequest { /** *NAT CCN防火墙开关配置
*/ NatCcnSwitch: NatCcnSwitchConfig; } /** * ModifyNatInstance返回参数结构体 */ export interface ModifyNatInstanceResponse { /** *0 正常
-1 异常
nat实例唯一ID
*/ NatInstanceId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeBlockStaticList返回参数结构体 */ export interface DescribeBlockStaticListResponse { /** * 查询结果 */ Data?: Array总条数
*/ Total?: number; /** *规则详情
*/ Data?: Array返回状态码 0 成功 非0不成功
*/ ReturnCode?: number; /** *返回信息 success 成功 其他 不成功
*/ ReturnMsg?: string; /** *字段类型
注意:此字段可能返回 null,表示取不到有效值。 */ Category?: Array每页条数
*/ Limit: number; /** *偏移值
*/ Offset: number; /** *需要查询的索引,特定场景使用,可不填
*/ Index?: string; /** *过滤条件组合
*/ Filters?: Arraydesc:降序;asc:升序。根据By字段的值进行排序,这里传参的话则By也必须有值
*/ Order?: string; /** *排序所用到的字段
*/ By?: string; } /** * CloseClusterNatFwSwitch返回参数结构体 */ export interface CloseClusterNatFwSwitchResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeNatFwInstanceWithRegion请求参数结构体 */ export type DescribeNatFwInstanceWithRegionRequest = null; /** * ModifyAddressTemplate请求参数结构体 */ export interface ModifyAddressTemplateRequest { /** * 地址模板唯一Id */ Uuid: string; /** * 模板名称 */ Name: string; /** * 模板描述 */ Detail: string; /** * Type为1,ip模板eg:1.1.1.1,2.2.2.2; Type为5,域名模板eg:www.qq.com,www.tencent.com */ IpString: string; /** * 1 ip模板 5 域名模板 */ Type: number; /** * 协议端口模板,协议类型,4:4层协议,7:7层协议。Type=6时必填。 */ ProtocolType?: string; } /** * Nat实例类型 */ export interface NatFwInstance { /** * nat实例id */ NatinsId?: string; /** * nat实例名称 */ NatinsName?: string; /** * 实例所在地域 */ Region?: string; /** * 0:新增模式,1:接入模式 */ FwMode?: number; /** * 0:正常状态, 1: 正在创建 */ Status?: number; /** * nat公网ip */ NatIp?: string; } /** * NAT防火墙Dnat规则 */ export interface CfwNatDnatRule { /** * 网络协议,可选值:TCP、UDP。 */ IpProtocol: string; /** * 弹性IP。 */ PublicIpAddress: string; /** * 公网端口。 */ PublicPort: number; /** * 内网地址。 */ PrivateIpAddress: string; /** * 内网端口。 */ PrivatePort: number; /** * NAT防火墙转发规则描述。 */ Description: string; } /** * UpdateClusterVpcFw请求参数结构体 */ export interface UpdateClusterVpcFwRequest { /** *ccn防火墙开关配置信息
*/ CcnSwitch: CcnSwitchInfo; } /** * DescribeNDRDataLeakOutAlertDetail请求参数结构体 */ export interface DescribeNDRDataLeakOutAlertDetailRequest { /** * 风险事件ID */ RiskId: string; } /** * DescribeBlockList返回参数结构体 */ export interface DescribeBlockListResponse { /** * 阻断记录集合 */ Data: Array检查项清单,按执行顺序返回。前端据此渲染检查项骨架,描述文案已按请求的 Language 返回对应语言(中文/英文)。检查通过轮询 DescribeClusterNatCcnFwSwitchList 接口读取 CheckResult 获取每个阶段的通过/失败状态。
*/ CheckItems?: Array0:cfw新增模式,1:cfw接入模式。
*/ Mode: number; /** *防火墙实例id,该字段必须传递。
*/ CfwInstance?: string; /** *添加或删除操作的Dnat规则列表。
*/ DnatRules?: ArrayNAT防火墙实例名称
*/ InstanceName: string; /** *NAT防火墙实例ID
*/ NatInstanceId?: string; } /** * ModifyBlockIgnoreList返回参数结构体 */ export interface ModifyBlockIgnoreListResponse { /** *接口返回信息
*/ ReturnMsg?: string; /** *接口返回错误码,0请求成功 非0失败
*/ ReturnCode?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * RemoveAcRule返回参数结构体 */ export interface RemoveAcRuleResponse { /** * 删除成功后返回被删除策略的uuid */ RuleUuid?: number; /** * 0代表成功,-1代表失败 */ ReturnCode?: number; /** * success代表成功,failed代表失败 */ ReturnMsg?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeCcnVpcFwPolicyLimit返回参数结构体 */ export interface DescribeCcnVpcFwPolicyLimitResponse { /** *支持的引流策略数量(最外层总条数)
*/ CcnPolicyInterconnectPairLenLimit?: number; /** *单条引流策略中单组的最大配置数量(内层单组总条数)
*/ CcnPolicyGroupLenLimit?: number; /** *接入的实例网段长度(网段数量)限制
*/ CcnPolicyCidrLenLimit?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * AddVpcAcRule返回参数结构体 */ export interface AddVpcAcRuleResponse { /** * 新增规则的 ID 列表,顺序与 Rules 一致。 */ RuleUuids?: Array检查项清单,按执行顺序返回。前端据此渲染检查项骨架,描述文案已按请求的 Language 返回对应语言(中文/英文)。检查通过轮询 DescribeClusterVpcFwSwitchs 接口读取 CheckResult 获取每个阶段的通过/失败状态。
*/ CheckItems?: Array查询结果。UTF-8 JSON object 字符串;调用方需解析 Response.Data。
*/ Data?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeVpcAcRule请求参数结构体 */ export interface DescribeVpcAcRuleRequest { /** *每页条数
*/ Limit: number; /** *偏移值
*/ Offset: number; /** *需要查询的索引,特定场景使用,可不填
*/ Index?: string; /** *过滤条件组合
*/ Filters?: Array检索的起始时间,规则创建时间,可不传
参数格式:2022-07-27 16:00:00
*/ StartTime?: string; /** *检索的截止时间,规则创建时间,可不传
参数格式:2022-07-27 16:00:00
*/ EndTime?: string; /** *desc:降序;asc:升序。根据By字段的值进行排序,这里传参的话则By也必须有值
*/ Order?: string; /** *排序所用到的字段
*/ By?: string; } /** * AddAclRule返回参数结构体 */ export interface AddAclRuleResponse { /** * 新增规则的 ID 列表,顺序与 Rules 一致。 */ RuleUuid?: ArrayNAT网关ID
*/ NatInsId?: string; /** *云联网ID
*/ CcnId?: string; /** *地域,如 ap-guangzhou
*/ Region?: string; /** *地域集群状态,取值:
NotDeployed-未部署集群,
Deployed-已部署集群但未创建引流网络,
DeployedCustomOnly-已部署集群但内网段被覆盖,无法自动选择引流网段,需自定义设置引流网段
Auto-已创建引流网络(自动分配CIDR),
Custom-已创建引流网络(自定义CIDR)
引流网络 CIDR,仅当 Status 为 Auto 或 Custom 时有值
*/ Cidr?: string; /** *引流路由方法,0-多路由表模式,1-策略路由模式
*/ RoutingMode?: number; } /** * NAT 访问控制规则参数结构。新增和修改使用相同的字段解析;字段组合按 Direction、源和目的类型与内容、Protocol、Port、ParamTemplateId、RuleAction 和 Scope 校验。 */ export interface CreateNatRuleItem { /** *规则方向,JSON 整数:0 表示出站,1 表示入站;其他值被拒绝。方向决定可用的源和目的类型及协议组合。
*/ Direction: number; /** *规则顺序。使用 -1 追加到当前方向末尾,使用正序号在对应位置插入并顺延后续规则;0 按 1 处理,其他负数及超范围值不应使用。批量新增时按 Rules 顺序依次处理。
*/ OrderIndex: number; /** *目的端口字符串。支持逗号分隔的单端口或以斜杠分隔的起止范围,例如 80、80,443、80/443;-1/-1 表示全部端口。单端口必须是大于 0 的整数;范围只要求两个端点均为整数且起点不大于终点。Protocol 归一化为 ICMP 时忽略该字段并保存为空字符串;FTP 只接受单端口,不接受逗号列表或斜杠范围。
*/ Port: string; /** *协议,大小写不敏感并归一化为大写。四层值为 TCP、UDP、ICMP、ICMPV6、ANY;应用层值为 HTTP、HTTPS、HTTP/HTTPS、TLS/SSL、SMTP、SMTPS、SMTP/SMTPS、FTP、DNS,其中 domain、tls、ssl 也归一化为 TLS/SSL;ANY 表示不限定协议,不表示省略 Protocol;它同时可按四层协议和应用协议解析。入站仅允许 ANY、TCP、UDP;domain 目的及解析为域名模板的 template 目的接受上述应用层协议及 ANY,但不接受 FTP;dnsparse 和 domainiptwoverify 目的仅允许 TCP 或 UDP;其他目的不接受 FTP 和 ANY 之外的应用层协议。Protocol=DNS 且目的不是域名模板或单独的 * 时,目的列表只能包含域名,不能包含 IP。
*/ Protocol: string; /** *流量处理方式,大小写不敏感:accept 表示放行,drop 表示拒绝,log 表示观察;isolateinaccept 表示放行访问隔离资产的白名单流量,isolateindrop 表示阻断访问隔离资产的其它流量,isolateoutaccept 表示放行隔离资产访问白名单目标,isolateoutdrop 表示阻断隔离资产访问其它目标。
*/ RuleAction: string; /** *访问源内容,格式由 SourceType 和 Direction 决定。net/ip 使用合法 IP 或 CIDR 的逗号列表,最多 10 项;location 使用地域 code,空字符串表示全部地域;vendor 使用 tencent、aliyun、aws、huawei、azure 或 all,可用逗号分隔;template 使用地址模板 ID;instance 使用资产实例 ID;group 使用资源组 ID;tag 使用 JSON 字符串 {"Key":"标签键","Value":"标签值"},Key 和 Value 大小写固定。
*/ SourceContent: string; /** *访问源类型,大小写不敏感。net、ip 均表示 IP/CIDR,template 表示地址模板,instance 表示资产实例,group 表示资产分组,tag 表示资源标签,location 表示地域,vendor 表示云厂商。入站支持 net、ip、template、location、vendor;出站支持 net、ip、template、instance、group、tag。
*/ SourceType: string; /** *访问目的内容,格式由 TargetType 和 Direction 决定。net/ip 使用合法 IP 或 CIDR 的逗号列表;domain 使用合法域名或 IP 的逗号列表,也接受单独的 *,泛域名最多 5 级,段内通配域名要求当前环境支持对应能力;dnsparse 使用单个精确域名、最多 5 级的标准泛域名或相应域名模板,不接受单独的 *、段内通配域名、IP 或逗号列表;domainiptwoverify 使用单个精确域名或不含通配符的相应域名模板,不接受单独的 *、任何通配域名、IP 或逗号列表;location 使用地域 code,空字符串表示全部地域;vendor 使用 tencent、aliyun、aws、huawei、azure 或 all,可用逗号分隔;template 使用地址模板 ID;instance 使用资产实例 ID;group 使用资源组 ID;tag 使用 JSON 字符串 {"Key":"标签键","Value":"标签值"},Key 和 Value 大小写固定。规范化后的目的内容最长 1023 字节;IP 或 domain 目的最多包含 10 项。
*/ TargetContent: string; /** *访问目的类型,大小写不敏感。net、ip 均表示 IP/CIDR,template 表示地址模板,instance 表示资产实例,group 表示资产分组,tag 表示资源标签,location 表示地域,vendor 表示云厂商,domain 表示 FQDN 匹配(内容也可传 IP 或 *),dnsparse 表示宽松匹配:Host/SNI 与域名匹配,或目的 IP 属于该域名当前 DNS 解析结果,满足任一条件即命中;domainiptwoverify 表示严格匹配:上述两个条件必须同时满足。入站支持 net、ip、template、instance、group、tag;出站支持 net、ip、template、domain、dnsparse、domainiptwoverify、location、vendor。template 按模板实际类型处理,入站不接受域名模板;部分域名模式要求当前环境支持对应能力。
*/ TargetType: string; /** *规则描述,不超过 100 个字符。新增时按请求值保存;修改时完整替换,不继承旧值。
*/ Description?: string; /** *规则状态。字符串 true 表示启用,false 表示禁用,大小写不敏感。省略或传空字符串时读取当前账号的访问控制规则默认状态;配置不存在或无法解析时默认为启用。
*/ Enable?: string; /** *覆盖导入规则标识。仅 From=batch_import_cover 接受正整数值;其它新增方式和修改请求忽略该字段。
*/ InternalUuid?: number; /** *端口协议模板 ID。省略或传空字符串时使用 Protocol 和 Port;非空时必须指向当前账号已有的模板,模板条目须满足协议与目的类型的联动限制。使用模板时,Protocol 仍须有效;Protocol 不是 ICMP 时,Port 也须有效,但二者不要求固定为 ANY 和 -1/-1。
*/ ParamTemplateId?: string; /** *规则生效范围,值中不能含空白字符。ALL 表示全部 NAT 实例;地域 ID(如 ap-guangzhou)表示地域范围;cfwnat- 或 nat- 开头的实例 ID 表示实例范围。非空值必须是已知地域或当前账号已有的 NAT 实例。省略或传空字符串时,有请求 Region 则使用 Region,否则归一化为 ALL。
*/ Scope?: string; /** *规则 ID。普通新增、insert_rule 和 batch_import 忽略该字段;batch_import_cover 可使用正整数 ID。修改时必须提供当前账号已有且可修改的正整数 ID,并以请求中的完整字段替换该规则,同时保留并返回同一 Uuid;省略、0 或负值无法定位修改目标。
*/ Uuid?: number; } /** * 企业安全组规则执行顺序修改对象 */ export interface SecurityGroupOrderIndexData { /** * 企业安全组规则当前执行顺序 */ OrderIndex: number; /** * 企业安全组规则更新目标执行顺序 */ NewOrderIndex: number; } /** * DescribeTLogInfo请求参数结构体 */ export interface DescribeTLogInfoRequest { /** * 结束时间 */ EndTime: string; /** * 类型 1 告警 2阻断 */ QueryType: string; /** * 开始时间 */ StartTime: string; /** * 查询条件 */ SearchValue?: string; } /** * 边界防火墙公网IP开关列表 */ export interface EdgeIpInfo { /** * 公网IP */ PublicIp?: string; /** * 公网 IP 类型 1 公网,2 弹性,3 弹性ipv6,4 anycastIP, 6 HighQualityEIP */ PublicIpType?: number; /** * 实例ID */ InstanceId?: string; /** * 实例名 */ InstanceName?: string; /** * 内网IP */ IntranetIp?: string; /** * 资产类型 */ AssetType?: string; /** * 地域 */ Region?: string; /** * 风险端口数 */ PortRiskCount?: number; /** * 最近扫描时间 */ LastScanTime?: string; /** * 是否为region eip 0 不为region eip,不能选择串行 1 为region eip 可以选择串行 */ IsRegionEip?: number; /** * EIP 所关联的VPC */ VpcId?: string; /** * 0: 该地域暂未支持串行 1: 该用户未在该地域配置串行带宽 2: 该用户已在该地域配置串行带宽,可以开启串行开关 3. 该地域可以支持串行,但是未部署公共集群 */ IsSerialRegion?: number; /** * 0: 不是公网CLB 可以开启串行开关 1: 是公网CLB 不可以开启串行开关 */ IsPublicClb?: number; /** * 0: 开启开关时提示要创建私有连接。 1: 关闭该开关时提示删除私有连接。 如果大于 1: 关闭开关 、开启开关不需提示创建删除私有连接。 */ EndpointBindEipNum?: number; /** * 扫描深度 */ ScanMode?: string; /** * 扫描状态 */ ScanStatus?: number; /** * 开关状态 0 : 关闭 1 : 开启 2 : 开启中 3 : 关闭中 4 : 异常 */ Status?: number; /** * 私有连接ID */ EndpointId?: string; /** * 私有连接IP */ EndpointIp?: string; /** * 0 : 旁路 1 : 串行 2 : 正在模式切换 */ SwitchMode?: number; /** * 开关权重 */ SwitchWeight?: number; /** * 域名化CLB的域名 */ Domain?: string; /** * IP超量状态 */ OverUsedStatus?: number; /** * 0 都不支持 1 支持旁路 2 支持串行 3 旁路串行都支持 */ SwitchSupportType?: number; } /** * AssetZone */ export interface AssetZone { /** * 地域 */ Zone?: string; /** * 地域英文 */ ZoneEng?: string; } /** * 接入防火墙实例信息 */ export interface AccessInstanceInfo { /** * 实例ID */ InstanceId: string; /** * 实例类型VPC or DIRECTCONNECT等类型 */ InstanceType: string; /** * 实例所在地域 */ InstanceRegion: string; /** * 接入防火墙的网段模式:0-不接入,1-接入实例关联的所有网段,2-接入用户自定义的网段 */ AccessCidrMode: number; /** * 接入防火墙的网段列表 */ AccessCidrList: Array防火墙实例id
*/ CfwInsId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 入侵防御防护模式相关 */ export interface ModeInfo { /** * 0-观察模式, 1-拦截模式, 2-严格模式 */ Mode?: number; } /** * DescribeCcnVpcFwPolicyLimit请求参数结构体 */ export type DescribeCcnVpcFwPolicyLimitRequest = null; /** * DescribeDefenseSwitch请求参数结构体 */ export type DescribeDefenseSwitchRequest = null; /** * 安全组列表数据 */ export interface SecurityGroupListData { /** * 执行顺序 */ OrderIndex: number; /** * 访问源 */ SourceId: string; /** * 访问源类型,默认为0,1: VPC, 2: SUBNET, 3: CVM, 4: CLB, 5: ENI, 6: CDB, 7: 参数模板, 100: 资源组 */ SourceType: number; /** * 访问目的 */ TargetId: string; /** * 访问目的类型,默认为0,1: VPC, 2: SUBNET, 3: CVM, 4: CLB, 5: ENI, 6: CDB, 7: 参数模板, 100:资源组 */ TargetType: number; /** * 协议 */ Protocol: string; /** * 目的端口 */ Port: string; /** * 策略, 1:阻断,2:放行 */ Strategy: number; /** * 描述 */ Detail: string; /** * 单/双向下发,0:单向下发,1:双向下发 */ BothWay: number; /** * 规则ID */ Id?: number; /** * 是否开关开启,0:未开启,1:开启 */ Status?: number; /** * 是否是正常规则,0:正常,1:异常 */ IsNew?: number; /** * 私有网络ID */ VpcId?: string; /** * 子网ID */ SubnetId?: string; /** * 实例名称 */ InstanceName?: string; /** * 公网IP,多个以英文逗号分隔 */ PublicIp?: string; /** * 内网IP,多个以英文逗号分隔 */ PrivateIp?: string; /** * 掩码地址,多个以英文逗号分隔 */ Cidr?: string; /** * 端口协议类型参数模板id */ ServiceTemplateId?: string; /** * 生成双向下发规则 */ BothWayInfo?: Array互联对配置
注意:此字段可能返回 null,表示取不到有效值。 */ InterconnectPairs?: Array日志类型标识
枚举值:
筛选开始时间
*/ StartTime: string; /** *筛选结束时间
*/ EndTime: string; /** *任务名称
*/ TaskName: string; /** *数据格式
枚举值:
压缩方式,.zip、.tar.gz、.tar.zst、.tar.lz4、传空不压缩
*/ CompressionFormat: string; /** *日志排序,desc时间降序,asc时间升序
*/ Order: string; /** *日志数量,传0按单次上限导出
*/ Length: number; /** *过滤条件组合
*/ Filters?: ArrayCOS存储桶名称
*/ BucketName?: string; /** *COS存储桶地域
*/ BucketRegion?: string; /** *文件过期时长,1一天,7七天,-1永久
*/ StorageDays?: number; /** *日志分析查询语句,Query和Filters不能同时使用,在一次请求中有且只能选择一个
*/ Query?: string; /** *导出任务类型,LogAnalysis日志分析导出,LogSearch日志审计导出
*/ TaskType?: string; } /** * DescribeUnHandleEventTabList返回参数结构体 */ export interface DescribeUnHandleEventTabListResponse { /** * 租户伪攻击链未处置事件 */ Data?: UnHandleEvent; /** * 错误码,0成功 非0错误 */ ReturnCode?: number; /** * 返回信息 success成功 */ ReturnMsg?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 防火墙串行地域带宽分配情况 */ export interface SerialRegionInfo { /** *地域
注意:此字段可能返回 null,表示取不到有效值。 */ Region: string; /** *分配带宽值 单位Mbps
注意:此字段可能返回 null,表示取不到有效值。 */ Width?: number; /** *弹性开关
注意:此字段可能返回 null,表示取不到有效值。 */ ElasticSwitch?: number; /** *弹性带宽上限,单位Mbps
注意:此字段可能返回 null,表示取不到有效值。 */ ElasticBandwidth?: number; /** *七天入向峰值带宽,单位bps
*/ InFlowMax?: number; /** *七天出向峰值带宽,单位bps
*/ OutFlowMax?: number; /** *边界按流量弹性开关
取值范围:[0, 1]
默认值:0
*/ ElasticTrafficSwitch?: number; } /** * ModifyEnterpriseSecurityGroupRule返回参数结构体 */ export interface ModifyEnterpriseSecurityGroupRuleResponse { /** * ModifyType=0/1 返回规则 ID;ModifyType=2 回显请求中的 RuleUuid。 */ NewRuleUuid?: number; /** * 处理状态:0 表示成功。 */ Status?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifySecurityGroupSequenceRules返回参数结构体 */ export interface ModifySecurityGroupSequenceRulesResponse { /** * 状态值,0:修改成功,非0:修改失败 */ Status?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeBlockByIpTimesList请求参数结构体 */ export interface DescribeBlockByIpTimesListRequest { /** * 结束时间 */ EndTime: string; /** * ip查询条件 */ Ip: string; /** * 开始时间 */ StartTime: string; /** * 方向 */ Direction?: string; /** * vpc间防火墙开关边id */ EdgeId?: string; /** * 日志来源 move:vpc间防火墙 */ LogSource?: string; /** * 来源 */ Source?: string; /** * 地域 */ Zone?: string; } /** * RemoveEnterpriseSecurityGroupRule返回参数结构体 */ export interface RemoveEnterpriseSecurityGroupRuleResponse { /** * 回显请求中的 RuleUuid。 */ RuleUuid?: number; /** * 处理状态:0 表示成功。 */ Status?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeEnterpriseSecurityGroupRuleList请求参数结构体 */ export interface DescribeEnterpriseSecurityGroupRuleListRequest { /** * 分页每页数量 */ Limit: number; /** * 分页当前页 */ Offset: number; /** * 启用状态 1启用 0 未启用 */ Status?: string; /** * 地域 */ Area?: string; /** * 规则下发方式筛选 1 新规则和延迟下发 2 仅看新规则 */ Filter?: number; /** * 查询条件 */ SearchValue?: string; /** * 查询条件新 */ SearchFilters?: Array返回状态码 0 成功 非0不成功
*/ ReturnCode?: number; /** *返回信息 success 成功 其他 不成功
*/ ReturnMsg?: string; /** *离线导出任务列表
*/ Data?: Array任务数量
*/ Total?: number; /** *剩余导出文件配额,单位B
*/ ExportRemainQuota?: number; /** *导出文件配额,单位B
*/ ExportQuota?: number; /** *导出数据限制
*/ ExportLimit?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 封禁放通IOC列表 */ export interface IocListData { /** * 待处置IP地址,IP/Domain字段二选一 */ IP: string; /** * 只能为0或者1 0代表出站 1代表入站 */ Direction: number; /** * 待处置域名,IP/Domain字段二选一 */ Domain?: string; } /** * ModifyEdgeIpSwitch返回参数结构体 */ export interface ModifyEdgeIpSwitchResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * UpdateCheckCcnNonDirectFlag请求参数结构体 */ export interface UpdateCheckCcnNonDirectFlagRequest { /** *云联网ID
*/ CcnId: string; } /** * DeleteNatFwInstance请求参数结构体 */ export interface DeleteNatFwInstanceRequest { /** *防火墙实例id
*/ CfwInstance: string; } /** * DescribeCfwRules返回参数结构体 */ export interface DescribeCfwRulesResponse { /** *查询结果。UTF-8 JSON object 字符串;调用方需解析 Response.Data。
*/ Data?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * SetNatFwDnatRule返回参数结构体 */ export interface SetNatFwDnatRuleResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * VPC防火墙实例信息 */ export interface VpcFwInstanceShow { /** * VPC防火墙实例ID */ FwInsId?: string; /** * VPC防火墙实例名称 */ FwInsName?: string; /** * 网络经过VPC防火墙CVM所在地域 */ FwInsRegion?: string; } /** * 日志分析的列属性 */ export interface Column { /** * 列的名字 */ Name?: string; /** * 列的属性 */ Type?: string; } /** * DescribeDefenseSwitch返回参数结构体 */ export interface DescribeDefenseSwitchResponse { /** *基础防御开关
*/ BasicRuleSwitch?: number; /** *安全基线开关
*/ BaselineAllSwitch?: number; /** *威胁情报开关
*/ TiSwitch?: number; /** *虚拟补丁开关
*/ VirtualPatchSwitch?: number; /** *是否历史开启
*/ HistoryOpen?: number; /** *状态值,0:查询成功,非0:查询失败
*/ ReturnCode?: number; /** *状态信息,success:查询成功,fail:查询失败
*/ ReturnMsg?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeAcLists请求参数结构体 */ export interface DescribeAcListsRequest { /** * 协议 */ Protocol?: string; /** * 策略 */ Strategy?: string; /** * 搜索值 */ SearchValue?: string; /** * 每页条数 */ Limit?: number; /** * 偏移值 */ Offset?: number; /** * 出站还是入站,1:入站,0:出站 */ Direction?: number; /** * EdgeId值 */ EdgeId?: string; /** * 规则是否开启,'0': 未开启,'1': 开启, 默认为'0' */ Status?: string; /** * 地域 */ Area?: string; /** * 实例ID */ InstanceId?: string; } /** * CCN关联的实例信息 */ export interface CcnAssociatedInstance { /** *实例ID
*/ InstanceId?: string; /** *实例名称
*/ InstanceName?: string; /** *实例类型
*/ InsType?: string; /** *实例的网段列表
注意:此字段可能返回 null,表示取不到有效值。 */ CidrLst?: Array实例所属地域
*/ InstanceRegion?: string; /** *是否跨账号
*/ IsCrossInstance?: number; } /** * DeleteAcRule请求参数结构体 */ export interface DeleteAcRuleRequest { /** * 删除规则对应的id值, 对应获取规则列表接口的Id 值 */ Id: number; /** * 方向,0:出站,1:入站 */ Direction: number; /** * EdgeId值两个vpc间的边id */ EdgeId?: string; /** * NAT地域, 如ap-shanghai/ap-guangzhou/ap-chongqing等 */ Area?: string; } /** * ModifyNatFwSwitch请求参数结构体 */ export interface ModifyNatFwSwitchRequest { /** *开关,0:关闭,1:开启
*/ Enable: number; /** *防火墙实例id列表,其中CfwInsIdList,SubnetIdList和RouteTableIdList只能传递一种。
*/ CfwInsIdList?: Array子网id列表,其中CfwInsIdList,SubnetIdList和RouteTableIdList只能传递一种。
*/ SubnetIdList?: Array路由表id列表,其中CfwInsIdList,SubnetIdList和RouteTableIdList只能传递一种。
*/ RouteTableIdList?: ArrayAI操作来源
枚举值:
防火墙实例id
*/ CfwInsId?: string; /** *防火墙类型,nat:nat防火墙;ew:vpc间防火墙
*/ FwType?: string; /** *实例所属地域
*/ Region?: string; /** *实例运行状态,Running:正常运行;BypassAutoFix:bypass修复;Updating:升级中;Expand:扩容中;BypassManual:手动触发bypass中;BypassAuto:自动触发bypass中;BypassTcDrop:丢包触发bypass中
枚举值:
事件时间
*/ EventTime?: string; /** *恢复时间
*/ RecoverTime?: string; /** *实例名称
*/ CfwInsName?: string; /** *Normal: 正常模式
OnlyRoute: 透明模式
地域
*/ Region?: string; /** *引流网络部署状态
引流网络的cidr,如果没有部署引流网络则为空
*/ Cidr?: string; } /** * Nat实例卡片详细信息 */ export interface NatInstanceInfo { /** *nat实例id
*/ NatinsId?: string; /** *nat实例名称
*/ NatinsName?: string; /** *实例所在地域
*/ Region?: string; /** *0: 新增模式,1:接入模式
*/ FwMode?: number; /** *实例带宽大小 Mbps
*/ BandWidth?: number; /** *入向带宽峰值 bps
*/ InFlowMax?: number; /** *出向带宽峰值 bps
*/ OutFlowMax?: number; /** *地域中文信息
*/ RegionZh?: string; /** *公网ip数组
*/ EipAddress?: Array内外使用ip数组
*/ VpcIp?: Array实例关联子网数组
*/ Subnets?: Array0 :正常 1:正在初始化
*/ Status?: number; /** *地域区域信息
*/ RegionDetail?: string; /** *实例所在可用区
*/ ZoneZh?: string; /** *实例所在可用区
*/ ZoneZhBak?: string; /** *已使用规则数
*/ RuleUsed?: number; /** *实例的规则限制最大规格数
*/ RuleMax?: number; /** *实例引擎版本
*/ EngineVersion?: string; /** *引擎是否可升级:0,不可升级;1,可升级
*/ UpdateEnable?: number; /** *是的需要升级引擎 支持 nat拨测 1需要 0不需要
*/ NeedProbeEngineUpdate?: number; /** *引擎运行模式,Normal:正常, OnlyRoute:透明模式
*/ TrafficMode?: string; /** *实例主所在可用区
*/ Zone?: string; /** *实例备所在可用区
*/ ZoneBak?: string; /** *引擎预约升级时间
*/ ReserveTime?: string; /** *引擎预约升级版本
*/ ReserveVersion?: string; /** *引擎预约升级版本状态 stable:稳定版;previewed:预览版
*/ ReserveVersionState?: string; /** *弹性开关
1 打开
0 关闭
弹性带宽,单位Mbps
*/ ElasticBandwidth?: number; /** *是否首次开通按量付费
1 是
0 不是
按流量弹性开关
默认值:0
*/ ElasticTrafficSwitch?: number; } /** * Nat防火墙弹性公网ip列表 */ export interface NatFwEipsInfo { /** * 弹性公网ip */ Eip?: string; /** * 所属的Nat网关Id */ NatGatewayId?: string; /** * Nat网关名称 */ NatGatewayName?: string; } /** * NDR资产识别服务类型统计结果 */ export interface NDRAssetCategoryStats { /** * 服务类型 */ Name?: string; /** * 服务统计结果 */ Services?: ArrayDnat规则列表
*/ Data?: Array列表总数
*/ Total?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeGuideScanInfo请求参数结构体 */ export type DescribeGuideScanInfoRequest = null; /** * DescribeClusterVpcFwSwitchs返回参数结构体 */ export interface DescribeClusterVpcFwSwitchsResponse { /** *总条数
*/ Total?: number; /** *防火墙开关列表
注意:此字段可能返回 null,表示取不到有效值。 */ Data?: Array开关开启失败列表
*/ FailData?: ArrayCCN 开关配置,长度为 1 的数组 JSON 字符串,结构与 ModifyClusterVpcFwSwitch 的 CcnSwitch 完全一致。SwitchMode 必须为 1(自动接入),RoutingMode 必须为 1(策略路由)。
*/ CcnSwitch: Array预接入检查模式
枚举值:
VPC防火墙(组)名称
*/ Name: string; /** *模式 1:CCN云联网模式;0:私有网络模式 2: sase 模式 3:ccn 高级模式 4: 私有网络(跨租户单边模式)
*/ Mode: number; /** *防火墙(组)下的防火墙实例列表
*/ VpcFwInstances: Array防火墙实例的开关模式
1: 单点互通
2: 多点互通
3: 全互通
4: 自定义路由
auto 自动选择防火墙网段
10.10.10.0/24 用户输入的防火墙网段
云联网id ,适用于云联网模式
*/ CcnId?: string; /** *指定防火墙使用网段信息
*/ FwCidrInfo?: FwCidrInfo; /** *跨租户管理员模式 1管理员 2多账号
*/ CrossUserMode?: string; } /** * CreateNatFwInstanceWithDomain请求参数结构体 */ export interface CreateNatFwInstanceWithDomainRequest { /** *防火墙实例名称
*/ Name: string; /** *带宽
*/ Width: number; /** *模式 1:接入模式;0:新增模式
*/ Mode: number; /** *新增模式传递参数,其中NewModeItems和NatgwList至少传递一种。
*/ NewModeItems?: NewModeItems; /** *接入模式接入的nat网关列表,其中NewModeItems和NatgwList至少传递一种。
*/ NatGwList?: Array主可用区,为空则选择默认可用区
*/ Zone?: string; /** *备可用区,为空则选择默认可用区
*/ ZoneBak?: string; /** *异地灾备 1:使用异地灾备;0:不使用异地灾备;为空则默认不使用异地灾备
*/ CrossAZone?: number; /** *0不创建域名,1创建域名
*/ IsCreateDomain?: number; /** *如果要创建域名则必填
*/ Domain?: string; /** *指定防火墙使用网段信息
*/ FwCidrInfo?: FwCidrInfo; } /** * 引流地域CIDR配置 */ export interface RegionCidrConfig { /** * 引流地域 注意:此字段可能返回 null,表示取不到有效值。 */ Region: string; /** * CIDR模式:0-跳过,1-自动,2-自定义 注意:此字段可能返回 null,表示取不到有效值。 */ CidrMode: number; /** * 自定义CIDR(CidrMode=2时必填),其它时候为空字符串 注意:此字段可能返回 null,表示取不到有效值。 */ CustomCidr: string; } /** * DescribeSwitchLists返回参数结构体 */ export interface DescribeSwitchListsResponse { /** * 总条数 */ Total?: number; /** * 列表数据 */ Data?: Array要检索分析的日志的起始时间,Unix时间戳(毫秒)
*/ From: number; /** *要检索分析的日志的结束时间,Unix时间戳(毫秒)
*/ To: number; /** *检索分析语句,最大长度为12KB
语句由 [检索条件] | [SQL语句]构成,无需对日志进行统计分析时,可省略其中的管道符 | 及SQL语句
使用*或空字符串可查询所有日志
检索语法规则,默认值为0,推荐使用1 。
详细说明参见检索条件语法规则
*/ SyntaxRule?: number; /** *原始日志是否按时间排序返回;可选值:asc(升序)、desc(降序),默认为 desc
注意:
表示单次查询返回的原始日志条数,默认为100,最大值为1000。
注意:
可通过两种方式获取后续更多日志:
查询原始日志的偏移量,表示从第几行开始返回原始日志,默认为0。
注意:
透传上次接口返回的Context值,可获取后续更多日志,总计最多可获取1万条原始日志,过期时间1小时。
注意:
执行统计分析(Query中包含SQL)时,是否对原始日志先进行采样,再进行统计分析。
0:自动采样;
0~1:按指定采样率采样,例如0.02;
1:不采样,即精确分析
默认值为1
为true代表使用新的检索结果返回方式,输出参数AnalysisRecords和Columns有效
为false时代表使用老的检索结果返回方式, 输出AnalysisResults和ColNames有效
两种返回方式在编码格式上有少量区别,建议使用true
返回地域数量
*/ Total?: number; /** *地域防火墙集群状态列表
注意:此字段可能返回 null,表示取不到有效值。 */ RegionFwStatus?: ArrayIp版本,0:IPv4,1:IPv6,默认为IPv4
*/ IpVersion?: number; } /** * ModifyAcRule请求参数结构体 */ export interface ModifyAcRuleRequest { /** * 规则数组 */ Data: Array实例卡片信息数组
*/ NatinsLst?: Arraynat 防火墙个数
*/ Total?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * AddNatAcRule返回参数结构体 */ export interface AddNatAcRuleResponse { /** * 新增规则的 ID 列表,顺序与 Rules 一致。 */ RuleUuid?: Array扫描信息
*/ Data?: ScanInfo; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * vpc 防火墙下单防火墙实例结构体 */ export interface VpcFwInstance { /** * 防火墙实例名称 */ Name: string; /** * 私有网络模式下接入的VpcId列表;仅私有网络模式使用 */ VpcIds: Array