@nocobase/plugin-verification
Version:
User identity verification management, including SMS, TOTP authenticator, with extensibility.
2,923 lines (2,910 loc) • 163 kB
TypeScript
/**
* ModifyEWRuleStatus返回参数结构体
*/
export interface ModifyEWRuleStatusResponse {
/**
* 状态值,0:修改成功,非0:修改失败
*/
ReturnCode: number;
/**
* 状态信息,success:查询成功,fail:查询失败
*/
ReturnMsg: string;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeNatFwInstance请求参数结构体
*/
export declare type DescribeNatFwInstanceRequest = null;
/**
* DescribeLogs请求参数结构体
*/
export interface DescribeLogsRequest {
/**
* 日志类型标识
流量日志:互联网边界防火墙netflow_border,NAT边界防火墙netflow_nat,VPC间防火墙vpcnetflow,内网流量日志netflow_fl
入侵防御日志rule_threatinfo
访问控制日志:互联网边界规则rule_acl,NAT边界规则rule_acl,内网间规则rule_vpcacl,企业安全组rule_sg
操作日志:防火墙开关-开关操作operate_switch,防火墙开关-实例配置operate_instance,资产中心操作operate_assetgroup,访问控制操作operate_acl,零信任防护操作operate_identity,入侵防御操作-入侵防御operate_ids,入侵防御操作-安全基线operate_baseline,常用工具操作operate_tool,网络蜜罐操作operate_honeypot,日志投递操作operate_logdelivery,通用设置操作operate_logstorage,登录日志operate_login
*/
Index: string;
/**
* 每页条数,最大支持2000
*/
Limit: number;
/**
* 偏移值,最大支持60000
*/
Offset: number;
/**
* 筛选开始时间
*/
StartTime: string;
/**
* 筛选结束时间
*/
EndTime: string;
/**
* 过滤条件组合,各数组元素间为AND关系,查询字段名Name参考文档https://cloud.tencent.com/document/product/1132/87894,数值类型字段不支持模糊匹配
*/
Filters?: Array<CommonFilter>;
}
/**
* ModifyFwGroupSwitch请求参数结构体
*/
export interface ModifyFwGroupSwitchRequest {
/**
* 打开或关闭开关
0:关闭开关
1:打开开关
*/
Enable: number;
/**
* 是否操作全部开关 0 不操作全部开关,1 操作全部开关
*/
AllSwitch: number;
/**
* 开关列表
*/
SwitchList?: Array<FwGroupSwitch>;
}
/**
* ModifySecurityGroupRule请求参数结构体
*/
export interface ModifySecurityGroupRuleRequest {
/**
* 方向,0:出站,1:入站,默认1
*/
Direction: number;
/**
* 编辑后是否启用规则,0:不启用,1:启用,默认1
*/
Enable: number;
/**
* 编辑的企业安全组规则数据
*/
Data: Array<SecurityGroupListData>;
/**
* 编辑的企业安全组规则的原始执行顺序
*/
SgRuleOriginSequence: number;
}
/**
* ModifyAssetSync返回参数结构体
*/
export interface ModifyAssetSyncResponse {
/**
* 返回状态
0 请求成功
2 请求失败
3 请求失败-频率限制
*/
Status?: number;
/**
* success 成功
其他失败
*/
ReturnMsg?: string;
/**
* 0 成功
非0 失败
*/
ReturnCode?: number;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyNatFwVpcDnsSwitch返回参数结构体
*/
export interface ModifyNatFwVpcDnsSwitchResponse {
/**
* 修改成功
注意:此字段可能返回 null,表示取不到有效值。
*/
ReturnMsg: string;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeNatFwInstanceWithRegion请求参数结构体
*/
export declare 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;
}
/**
* DescribeRuleOverview返回参数结构体
*/
export interface DescribeRuleOverviewResponse {
/**
* 规则总数
注意:此字段可能返回 null,表示取不到有效值。
*/
AllTotal: number;
/**
* 阻断策略规则数量
注意:此字段可能返回 null,表示取不到有效值。
*/
StrategyNum: number;
/**
* 启用规则数量
注意:此字段可能返回 null,表示取不到有效值。
*/
StartRuleNum: number;
/**
* 停用规则数量
注意:此字段可能返回 null,表示取不到有效值。
*/
StopRuleNum: number;
/**
* 剩余配额
注意:此字段可能返回 null,表示取不到有效值。
*/
RemainingNum: number;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* NAT防火墙Dnat规则
*/
export interface CfwNatDnatRule {
/**
* 网络协议,可选值:TCP、UDP。
*/
IpProtocol: string;
/**
* 弹性IP。
*/
PublicIpAddress: string;
/**
* 公网端口。
*/
PublicPort: number;
/**
* 内网地址。
*/
PrivateIpAddress: string;
/**
* 内网端口。
*/
PrivatePort: number;
/**
* NAT防火墙转发规则描述。
*/
Description: string;
}
/**
* 新手引导扫描信息
*/
export interface ScanInfo {
/**
* 扫描结果信息
*/
ScanResultInfo: ScanResultInfo;
/**
* 扫描状态 0扫描中 1完成 2未勾选自动扫描
*/
ScanStatus: number;
/**
* 进度
*/
ScanPercent: number;
/**
* 预计完成时间
*/
ScanTime: string;
}
/**
* ModifyEnterpriseSecurityGroupRule返回参数结构体
*/
export interface ModifyEnterpriseSecurityGroupRuleResponse {
/**
* 状态值,0:编辑成功,非0:编辑失败
*/
Status: number;
/**
* 编辑后新生成规则的Id
*/
NewRuleUuid: number;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 防火墙网段信息
*/
export interface FwCidrInfo {
/**
* 防火墙使用的网段类型,值VpcSelf/Assis/Custom分别代表自有网段优先/扩展网段优先/自定义
*/
FwCidrType: string;
/**
* 为每个vpc指定防火墙的网段
*/
FwCidrLst?: Array<FwVpcCidr>;
/**
* 其他防火墙占用网段,一般是防火墙需要独占vpc时指定的网段
*/
ComFwCidr?: string;
}
/**
* StaticInfo 告警柱形图统计信息
*/
export interface StaticInfo {
/**
* 数
*/
Num: number;
/**
* 端口
*/
Port: string;
/**
* ip信息
*/
Ip: string;
/**
* 地址
*/
Address: string;
/**
* 资产id
*/
InsID: string;
/**
* 资产名称
*/
InsName: string;
}
/**
* SyncFwOperate返回参数结构体
*/
export interface SyncFwOperateResponse {
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeNatAcRule返回参数结构体
*/
export interface DescribeNatAcRuleResponse {
/**
* 总条数
*/
Total?: number;
/**
* nat访问控制列表数据
注意:此字段可能返回 null,表示取不到有效值。
*/
Data?: Array<DescAcItem>;
/**
* 未过滤的总条数
*/
AllTotal?: number;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyBlockTop请求参数结构体
*/
export interface ModifyBlockTopRequest {
/**
* 记录id
*/
UniqueId: string;
/**
* 操作类型 1 置顶 0取消
*/
OpeType: string;
}
/**
* ModifyPublicIPSwitchStatus返回参数结构体
*/
export interface ModifyPublicIPSwitchStatusResponse {
/**
* 接口返回信息
注意:此字段可能返回 null,表示取不到有效值。
*/
ReturnMsg: string;
/**
* 接口返回错误码,0请求成功 非0失败
*/
ReturnCode: number;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* AddAclRule请求参数结构体
*/
export interface AddAclRuleRequest {
/**
* 需要添加的访问控制规则列表
*/
Rules: Array<CreateRuleItem>;
/**
* 添加规则的来源,一般不需要使用,值insert_rule 表示插入指定位置的规则;值batch_import 表示批量导入规则;为空时表示添加规则
*/
From?: string;
}
/**
* DescribeVpcFwGroupSwitch请求参数结构体
*/
export interface DescribeVpcFwGroupSwitchRequest {
/**
* 每页条数
*/
Limit: number;
/**
* 偏移值
*/
Offset: number;
/**
* 过滤条件组合
*/
Filters?: Array<CommonFilter>;
/**
* 检索的起始时间,可不传
*/
StartTime?: string;
/**
* 检索的截止时间,可不传
*/
EndTime?: string;
/**
* desc:降序;asc:升序。根据By字段的值进行排序,这里传参的话则By也必须有值
*/
Order?: string;
/**
* 排序所用到的字段
*/
By?: string;
}
/**
* 防火墙部署输入参数列表
*/
export interface FwDeploy {
/**
* 防火墙部署地域
*/
DeployRegion: string;
/**
* 带宽,单位:Mbps
*/
Width: number;
/**
* 异地灾备 1:使用异地灾备;0:不使用异地灾备;为空则默认不使用异地灾备
*/
CrossAZone?: number;
/**
* 主可用区,为空则选择默认可用区
*/
Zone?: string;
/**
* 备可用区,为空则选择默认可用区
*/
ZoneBak?: string;
/**
* 若为cdc防火墙时填充该id
*/
CdcId?: string;
}
/**
* CreateAlertCenterIsolate返回参数结构体
*/
export interface CreateAlertCenterIsolateResponse {
/**
* 返回状态码:
0 成功
非0 失败
*/
ReturnCode?: number;
/**
* 返回信息:
success 成功
其他
*/
ReturnMsg?: string;
/**
* 处置状态码:
0 处置成功
-1 通用错误,不用处理
-3 表示重复,需重新刷新列表
其他
*/
Status?: number;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyNatAcRule请求参数结构体
*/
export interface ModifyNatAcRuleRequest {
/**
* 需要编辑的规则数组
*/
Rules: Array<CreateNatRuleItem>;
}
/**
* ModifyAclRule请求参数结构体
*/
export interface ModifyAclRuleRequest {
/**
* 需要编辑的规则数组
*/
Rules: Array<CreateRuleItem>;
}
/**
* ModifyAcRule返回参数结构体
*/
export interface ModifyAcRuleResponse {
/**
* 状态值,0:操作成功,非0:操作失败
*/
Status: number;
/**
* 返回多余的信息
注意:此字段可能返回 null,表示取不到有效值。
*/
Info: string;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyAssetScan返回参数结构体
*/
export interface ModifyAssetScanResponse {
/**
* 接口返回信息
注意:此字段可能返回 null,表示取不到有效值。
*/
ReturnMsg: string;
/**
* 接口返回错误码,0请求成功 非0失败
注意:此字段可能返回 null,表示取不到有效值。
*/
ReturnCode: number;
/**
* 状态值 0:成功,1 执行扫描中,其他:失败
*/
Status: number;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyNatSequenceRules请求参数结构体
*/
export interface ModifyNatSequenceRulesRequest {
/**
* 规则快速排序:OrderIndex,原始序号;NewOrderIndex:新序号
*/
RuleChangeItems: Array<RuleChangeItem>;
/**
* 规则方向:1,入站;0,出站
*/
Direction: number;
}
/**
* DescribeAclRule返回参数结构体
*/
export interface DescribeAclRuleResponse {
/**
* 总条数
*/
Total?: number;
/**
* nat访问控制列表数据
注意:此字段可能返回 null,表示取不到有效值。
*/
Data?: Array<DescAcItem>;
/**
* 未过滤的总条数
*/
AllTotal?: number;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* AddAcRule请求参数结构体
*/
export interface AddAcRuleRequest {
/**
* -1表示优先级最低,1表示优先级最高
*/
OrderIndex: string;
/**
* 访问控制策略中设置的流量通过云防火墙的方式。取值:
accept:放行
drop:拒绝
log:观察
*/
RuleAction: string;
/**
* 访问控制策略的流量方向。取值:
in:外对内流量访问控制
out:内对外流量访问控制
*/
Direction: string;
/**
* 访问控制策略的描述信息
*/
Description: string;
/**
* 访问控制策略中的源地址类型。取值:
net:源IP或网段(IP或者CIDR)
location:源区域
template:云防火墙地址模板
instance:实例id
vendor:云厂商
*/
SourceType: string;
/**
* 访问控制策略中的源地址。取值:
当SourceType为net时,SourceContent为源IP地址或者CIDR地址。
例如:1.1.1.0/24
当SourceType为template时,SourceContent为源地址模板id。
当SourceType为location时,SourceContent为源区域。
例如["BJ11", "ZB"]
当SourceType为instance时,SourceContent为该实例id对应的公网ip。
例如ins-xxxxx
当SourceType为vendor时,SourceContent为所选择厂商的公网ip列表。
例如:aws,huawei,tencent,aliyun,azure,all代表以上五个
*/
SourceContent: string;
/**
* 访问控制策略中的目的地址类型。取值:
net:目的IP或者网段(IP或者CIDR)
location:源区域
template:云防火墙地址模板
instance:实例id
vendor:云厂商
domain: 域名或者ip
*/
DestType: string;
/**
* 访问控制策略中的目的地址。取值:
当DestType为net时,DestContent为源IP地址或者CIDR地址。
例如:1.1.1.0/24
当DestType为template时,DestContent为源地址模板id。
当DestType为location时,DestContent为源区域。
例如["BJ11", "ZB"]
当DestType为instance时,DestContent为该实例id对应的公网ip。
例如ins-xxxxx
当DestType为domain时,DestContent为该实例id对应的域名规则。
例如*.qq.com
当DestType为vendor时,DestContent为所选择厂商的公网ip列表。
例如:aws,huawei,tencent,aliyun,azure,all代表以上五个
*/
DestContent: string;
/**
* 访问控制策略的端口。取值:
-1/-1:全部端口
80,443:80或者443
*/
Port: string;
/**
* 访问控制策略中流量访问的协议类型。取值:TCP,目前互联网边界规则只能支持TCP,不传参数默认就是TCP
*/
Protocol?: string;
/**
* 七层协议,取值:
HTTP/HTTPS
TLS/SSL
*/
ApplicationName?: string;
/**
* 是否启用规则,默认为启用,取值:
true为启用,false为不启用
*/
Enable?: string;
}
/**
* DescribeTLogInfo请求参数结构体
*/
export interface DescribeTLogInfoRequest {
/**
* 开始时间
*/
StartTime: string;
/**
* 结束时间
*/
EndTime: string;
/**
* 类型 1 告警 2阻断
*/
QueryType: string;
/**
* 查询条件
*/
SearchValue?: string;
}
/**
* 入侵防御放通封禁规则
*/
export interface BlockIgnoreRule {
/**
* 域名
注意:此字段可能返回 null,表示取不到有效值。
*/
Domain?: string;
/**
* IP
注意:此字段可能返回 null,表示取不到有效值。
*/
IP?: string;
/**
* 规则ip
注意:此字段可能返回 null,表示取不到有效值。
*/
Ioc?: string;
/**
* 危险等级
注意:此字段可能返回 null,表示取不到有效值。
*/
Level?: string;
/**
* 来源事件名称
注意:此字段可能返回 null,表示取不到有效值。
*/
EventName?: string;
/**
* 方向:1入站,0出站
注意:此字段可能返回 null,表示取不到有效值。
*/
Direction?: number;
/**
* 协议
注意:此字段可能返回 null,表示取不到有效值。
*/
Protocol?: string;
/**
* 地理位置
注意:此字段可能返回 null,表示取不到有效值。
*/
Address?: string;
/**
* 规则类型:1封禁,2放通
注意:此字段可能返回 null,表示取不到有效值。
*/
Action?: number;
/**
* 规则生效开始时间
注意:此字段可能返回 null,表示取不到有效值。
*/
StartTime?: string;
/**
* 规则生效结束时间
注意:此字段可能返回 null,表示取不到有效值。
*/
EndTime?: string;
/**
* 忽略原因
注意:此字段可能返回 null,表示取不到有效值。
*/
IgnoreReason?: string;
/**
* 安全事件来源
注意:此字段可能返回 null,表示取不到有效值。
*/
Source?: string;
/**
* 规则id
注意:此字段可能返回 null,表示取不到有效值。
*/
UniqueId?: string;
/**
* 规则命中次数
注意:此字段可能返回 null,表示取不到有效值。
*/
MatchTimes?: number;
/**
* 国家
注意:此字段可能返回 null,表示取不到有效值。
*/
Country?: string;
/**
* 备注
注意:此字段可能返回 null,表示取不到有效值。
*/
Comment?: string;
}
/**
* ModifyNatFwVpcDnsSwitch请求参数结构体
*/
export interface ModifyNatFwVpcDnsSwitchRequest {
/**
* nat 防火墙 id
*/
NatFwInsId: string;
/**
* DNS 开关切换列表
*/
DnsVpcSwitchLst: Array<DnsVpcSwitch>;
}
/**
* DeleteNatFwInstance返回参数结构体
*/
export interface DeleteNatFwInstanceResponse {
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeNatSwitchList请求参数结构体
*/
export interface DescribeNatSwitchListRequest {
/**
* 偏移量,分页用
*/
Offset: number;
/**
* 条数,分页用
*/
Limit: number;
/**
* 搜索值
*/
SearchValue?: string;
/**
* 开关,1打开,0关闭
*/
Status?: number;
/**
* 筛选NAT防火墙子网开关所属VPC
*/
VpcId?: string;
/**
* 筛选NAT防火墙子网开关所属NAT网关
*/
NatId?: string;
/**
* 筛选NAT防火墙子网开关所属NAT防火墙实例
*/
NatInsId?: string;
/**
* 筛选NAT防火墙子网开关所属地域
*/
Area?: string;
}
/**
* DeleteAllAccessControlRule请求参数结构体
*/
export interface DeleteAllAccessControlRuleRequest {
/**
* 方向,0:出站,1:入站 默认值是 0
*/
Direction?: number;
/**
* VPC间防火墙开关ID 全部删除 EdgeId和Area只填写一个,不填写则不删除vpc间防火墙开关 ,默认值为‘’
*/
EdgeId?: string;
/**
* nat地域 全部删除 EdgeId和Area只填写一个,不填写则不删除nat防火墙开关 默认值为‘’
*/
Area?: string;
}
/**
* ModifyBlockIgnoreList请求参数结构体
*/
export interface ModifyBlockIgnoreListRequest {
/**
* 1封禁列表 2 放通列表
*/
RuleType: number;
/**
* IP、Domain二选一(注:封禁列表,只能填写IP),不能同时为空
*/
IOC: Array<IocListData>;
/**
* 可选值: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;
}
/**
* ModifyAllVPCSwitchStatus返回参数结构体
*/
export interface ModifyAllVPCSwitchStatusResponse {
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* vpc区域数据详情
*/
export interface VpcZoneData {
/**
* 可用区
*/
Zone: string;
/**
* vpc节点地域
*/
Region: string;
}
/**
* 数据库白名单规则数据
*/
export interface DatabaseWhiteListRuleData {
/**
* 访问源
*/
SourceIp: string;
/**
* 访问源类型,1 ip;6 实例;100 资源分组
*/
SourceType: number;
/**
* 访问目的
*/
TargetIp: string;
/**
* 访问目的类型,1 ip;6 实例;100 资源分组
*/
TargetType: number;
/**
* 规则描述
*/
Detail: string;
/**
* 是否地域规则,0不是 1是
*/
IsRegionRule: number;
/**
* 是否云厂商规则,0不是 1 时
*/
IsCloudRule: number;
/**
* 是否启用,0 不启用,1启用
*/
Enable: number;
/**
* 地域码1
*/
FirstLevelRegionCode?: number;
/**
* 地域码2
*/
SecondLevelRegionCode?: number;
/**
* 地域名称1
*/
FirstLevelRegionName?: string;
/**
* 地域名称2
*/
SecondLevelRegionName?: string;
/**
* 云厂商码
*/
CloudCode?: string;
}
/**
* DescribeNatFwVpcDnsLst请求参数结构体
*/
export interface DescribeNatFwVpcDnsLstRequest {
/**
* natfw 防火墙实例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;
}
/**
* DescribeTLogInfo返回参数结构体
*/
export interface DescribeTLogInfoResponse {
/**
* "NetworkNum":网络扫描探测
"HandleNum": 待处理事件
"BanNum":
"VulNum": 漏洞利用
"OutNum": 失陷主机
"BruteForceNum": 0
*/
Data: TLogInfo;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeUnHandleEventTabList请求参数结构体
*/
export interface DescribeUnHandleEventTabListRequest {
/**
* 开始时间
*/
StartTime: string;
/**
* 结束时间
*/
EndTime: string;
/**
* 查询示例ID
*/
AssetID?: string;
}
/**
* ModifyNatInstance请求参数结构体
*/
export interface ModifyNatInstanceRequest {
/**
* NAT防火墙实例名称
*/
InstanceName: string;
/**
* NAT防火墙实例ID
*/
NatInstanceId?: string;
}
/**
* DescribeAssociatedInstanceList返回参数结构体
*/
export interface DescribeAssociatedInstanceListResponse {
/**
* 实例数量
注意:此字段可能返回 null,表示取不到有效值。
*/
Total: number;
/**
* 实例列表
注意:此字段可能返回 null,表示取不到有效值。
*/
Data: Array<AssociatedInstanceInfo>;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 企业安全组关联实例信息
*/
export interface AssociatedInstanceInfo {
/**
* 实例ID
注意:此字段可能返回 null,表示取不到有效值。
*/
InstanceId: string;
/**
* 实例名称
注意:此字段可能返回 null,表示取不到有效值。
*/
InstanceName: string;
/**
* 实例类型,3是cvm实例,4是clb实例,5是eni实例,6是云数据库
注意:此字段可能返回 null,表示取不到有效值。
*/
Type: number;
/**
* 私有网络ID
注意:此字段可能返回 null,表示取不到有效值。
*/
VpcId: string;
/**
* 私有网络名称
注意:此字段可能返回 null,表示取不到有效值。
*/
VpcName: string;
/**
* 公网IP
注意:此字段可能返回 null,表示取不到有效值。
*/
PublicIp: string;
/**
* 内网IP
注意:此字段可能返回 null,表示取不到有效值。
*/
Ip: string;
/**
* 关联安全组数量
注意:此字段可能返回 null,表示取不到有效值。
*/
SecurityGroupCount: number;
/**
* 关联安全组规则数量
注意:此字段可能返回 null,表示取不到有效值。
*/
SecurityGroupRuleCount?: number;
/**
* 关联数据库代理Id
注意:此字段可能返回 null,表示取不到有效值。
*/
CdbId?: string;
}
/**
* CreateBlockIgnoreRuleList请求参数结构体
*/
export interface CreateBlockIgnoreRuleListRequest {
/**
* 规则列表
*/
Rules: Array<IntrusionDefenseRule>;
/**
* 规则类型,1封禁,2放通,不支持域名封禁
*/
RuleType: number;
/**
* 是否覆盖重复数据,1覆盖,非1不覆盖,跳过重复数据
*/
CoverDuplicate?: number;
}
/**
* RemoveAcRule返回参数结构体
*/
export interface RemoveAcRuleResponse {
/**
* 删除成功后返回被删除策略的uuid
*/
RuleUuid: number;
/**
* 0代表成功,-1代表失败
注意:此字段可能返回 null,表示取不到有效值。
*/
ReturnCode: number;
/**
* success代表成功,failed代表失败
注意:此字段可能返回 null,表示取不到有效值。
*/
ReturnMsg: string;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* Nat实例类型
*/
export interface NatFwInstance {
/**
* nat实例id
*/
NatinsId: string;
/**
* nat实例名称
*/
NatinsName: string;
/**
* 实例所在地域
注意:此字段可能返回 null,表示取不到有效值。
*/
Region: string;
/**
* 0:新增模式,1:接入模式
注意:此字段可能返回 null,表示取不到有效值。
*/
FwMode: number;
/**
* 0:正常状态, 1: 正在创建
注意:此字段可能返回 null,表示取不到有效值。
*/
Status: number;
/**
* nat公网ip
注意:此字段可能返回 null,表示取不到有效值。
*/
NatIp: string;
}
/**
* ModifyNatAcRule返回参数结构体
*/
export interface ModifyNatAcRuleResponse {
/**
* 编辑成功后返回新策略ID列表
*/
RuleUuid?: Array<number | bigint>;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeAclRule请求参数结构体
*/
export interface DescribeAclRuleRequest {
/**
* 每页条数
*/
Limit: number;
/**
* 偏移值
*/
Offset: number;
/**
* 需要查询的索引,特定场景使用,可不填
*/
Index?: string;
/**
* 过滤条件组合
*/
Filters?: Array<CommonFilter>;
/**
* 检索的起始时间,可不传
*/
StartTime?: string;
/**
* 检索的截止时间,可不传
*/
EndTime?: string;
/**
* desc:降序;asc:升序。根据By字段的值进行排序,这里传参的话则By也必须有值
*/
Order?: string;
/**
* 排序所用到的字段
*/
By?: string;
}
/**
* CreateSecurityGroupRules返回参数结构体
*/
export interface CreateSecurityGroupRulesResponse {
/**
* 状态值,0:添加成功,非0:添加失败
*/
Status: number;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ExpandCfwVertical请求参数结构体
*/
export interface ExpandCfwVerticalRequest {
/**
* nat:nat防火墙,ew:东西向防火墙
*/
FwType: string;
/**
* 带宽值
*/
Width: number;
/**
* 防火墙实例id
*/
CfwInstance?: string;
}
/**
* ModifyAllPublicIPSwitchStatus返回参数结构体
*/
export interface ModifyAllPublicIPSwitchStatusResponse {
/**
* 接口返回信息
注意:此字段可能返回 null,表示取不到有效值。
*/
ReturnMsg: string;
/**
* 接口返回错误码,0请求成功 非0失败
注意:此字段可能返回 null,表示取不到有效值。
*/
ReturnCode: number;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteVpcInstance返回参数结构体
*/
export interface DeleteVpcInstanceResponse {
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 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<string>;
/**
* 1全量2单个
*/
ScanType?: number;
}
/**
* 设置nat防火墙的vpc dns 接入开关
*/
export interface DnsVpcSwitch {
/**
* vpc id
*/
VpcId: string;
/**
* 0:设置为关闭 1:设置为打开
*/
Status: number;
}
/**
* AddEnterpriseSecurityGroupRules请求参数结构体
*/
export interface AddEnterpriseSecurityGroupRulesRequest {
/**
* 创建规则数据
*/
Data: Array<SecurityGroupRule>;
/**
* 添加类型,0:添加到最后,1:添加到最前;2:中间插入;默认0添加到最后
*/
Type?: number;
/**
* 保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符,且不能超过64个字符。
*/
ClientToken?: string;
/**
* 是否延迟下发,1则延迟下发,否则立即下发
*/
IsDelay?: number;
}
/**
* 防火墙引流网关信息
*/
export interface FwGateway {
/**
* 防火墙网关id
*/
GatewayId: string;
/**
* 网关所属vpc id
注意:此字段可能返回 null,表示取不到有效值。
*/
VpcId: string;
/**
* 网关ip地址
注意:此字段可能返回 null,表示取不到有效值。
*/
IpAddress: string;
}
/**
* ModifySecurityGroupSequenceRules返回参数结构体
*/
export interface ModifySecurityGroupSequenceRulesResponse {
/**
* 状态值,0:修改成功,非0:修改失败
*/
Status: number;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 安全组规则
*/
export interface SecurityGroupRule {
/**
* 访问源示例:
net:IP/CIDR(192.168.0.2)
template:参数模板id(ipm-dyodhpby)
instance:资产实例id(ins-123456)
resourcegroup:资产分组id(cfwrg-xxxx)
tag:资源标签({\"Key\":\"标签key值\",\"Value\":\"标签Value值\"})
region:地域(ap-gaungzhou)
*/
SourceContent: string;
/**
* 访问源类型,类型可以为以下6种:net|template|instance|resourcegroup|tag|region
*/
SourceType: string;
/**
* 访问目的示例:
net:IP/CIDR(192.168.0.2)
template:参数模板id(ipm-dyodhpby)
instance:资产实例id(ins-123456)
resourcegroup:资产分组id(cfwrg-xxxx)
tag:资源标签({\"Key\":\"标签key值\",\"Value\":\"标签Value值\"})
region:地域(ap-gaungzhou)
*/
DestContent: string;
/**
* 访问目的类型,类型可以为以下6种:net|template|instance|resourcegroup|tag|region
*/
DestType: string;
/**
* 访问控制策略中设置的流量通过云防火墙的方式。取值:
accept:放行
drop:拒绝
*/
RuleAction: string;
/**
* 描述
*/
Description: string;
/**
* 规则顺序,-1表示最低,1表示最高,请勿和外层Type冲突(和外层的Type配合使用,当中间插入时,指定添加位置)
*/
OrderIndex: string;
/**
* 协议;TCP/UDP/ICMP/ANY
注意:此字段可能返回 null,表示取不到有效值。
*/
Protocol?: string;
/**
* 访问控制策略的端口。取值:
-1/-1:全部端口
80:80端口
注意:此字段可能返回 null,表示取不到有效值。
*/
Port?: string;
/**
* 端口协议类型参数模板id;协议端口模板id;与Protocol,Port互斥
注意:此字段可能返回 null,表示取不到有效值。
*/
ServiceTemplateId?: string;
/**
* (入参时无需填写,自动生成)规则对应的唯一id
*/
Id?: string;
/**
* (入参时、Enable已弃用;由通用配置中新增规则启用状态控制)
规则状态,true表示启用,false表示禁用
*/
Enable?: string;
}
/**
* DeleteIdsWhiteRule请求参数结构体
*/
export interface DeleteIdsWhiteRuleRequest {
/**
* 入侵防御白名单id
参考DescribeIdsWhiteRule接口返回的Id字段
*/
Id: number;
}
/**
* ModifySequenceRules请求参数结构体
*/
export interface ModifySequenceRulesRequest {
/**
* 边Id值
*/
EdgeId?: string;
/**
* 修改数据
*/
Data?: Array<SequenceData>;
/**
* NAT地域
*/
Area?: string;
/**
* 方向,0:出向,1:入向
*/
Direction?: number;
}
/**
* ModifyAclRule返回参数结构体
*/
export interface ModifyAclRuleResponse {
/**
* 编辑成功后返回新策略ID列表
*/
RuleUuid?: Array<number | bigint>;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 执行顺序对象
*/
export interface SequenceData {
/**
* 规则Id值
*/
Id: number;
/**
* 修改前执行顺序
*/
OrderIndex: number;
/**
* 修改后执行顺序
*/
NewOrderIndex: number;
}
/**
* CreateNatFwInstance请求参数结构体
*/
export interface CreateNatFwInstanceRequest {
/**
* 防火墙实例名称
*/
Name: string;
/**
* 带宽
*/
Width: number;
/**
* 模式 1:接入模式;0:新增模式
*/
Mode: number;
/**
* 新增模式传递参数,其中NewModeItems和NatgwList至少传递一种。
*/
NewModeItems?: NewModeItems;
/**
* 接入模式接入的nat网关列表,其中NewModeItems和NatgwList至少传递一种。
*/
NatGwList?: Array<string>;
/**
* 主可用区,为空则选择默认可用区
*/
Zone?: string;
/**
* 备可用区,为空则选择默认可用区
*/
ZoneBak?: string;
/**
* 异地灾备 1:使用异地灾备;0:不使用异地灾备;为空则默认不使用异地灾备
*/
CrossAZone?: number;
/**
* 指定防火墙使用网段信息
*/
FwCidrInfo?: FwCidrInfo;
}
/**
* ModifySecurityGroupItemRuleStatus返回参数结构体
*/
export interface ModifySecurityGroupItemRuleStatusResponse {
/**
* 状态值,0:修改成功,非0:修改失败
*/
Status: number;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeEnterpriseSecurityGroupRule返回参数结构体
*/
export interface DescribeEnterpriseSecurityGroupRuleResponse {
/**
* 分页查询时,显示的当前页的页码。
*/
PageNo?: string;
/**
* 分页查询时,显示的每页数据的最大条数。
*/
PageSize?: string;
/**
* 访问控制策略列表
*/
Rules?: Array<SecurityGroupRule>;
/**
* 访问控制策略的总数量。
*/
TotalCount?: string;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* VPC防火墙(组)及防火墙实例详情信息
*/
export interface VpcFwGroupInfo {
/**
* 防火墙(组)ID
注意:此字段可能返回 null,表示取不到有效值。
*/
FwGroupId?: string;
/**
* 防火墙(组)名称
注意:此字段可能返回 null,表示取不到有效值。
*/
FwGroupName?: string;
/**
* 防火墙组涉及到的开关个数
注意:此字段可能返回 null,表示取不到有效值。
*/
FwSwitchNum?: number;
/**
* 防火墙(组)部署的地域
注意:此字段可能返回 null,表示取不到有效值。
*/
RegionLst?: Array<string>;
/**
* 模式 1:CCN云联网模式;0:私有网络模式 2: sase 模式 3:ccn 高级模式 4: 私有网络(跨租户单边模式)
注意:此字段可能返回 null,表示取不到有效值。
*/
Mode?: number;
/**
* 防火墙实例的开关模式 1: 单点互通 2: 多点互通 3: 全互通 4: 自定义路由
注意:此字段可能返回 null,表示取不到有效值。
*/
SwitchMode?: number;
/**
* VPC防火墙实例卡片信息数组
注意:此字段可能返回 null,表示取不到有效值。
*/
FwInstanceLst?: Array<VpcFwInstanceInfo>;
/**
* 防火墙(状态) 0:正常 1: 初始化或操作中
注意:此字段可能返回 null,表示取不到有效值。
*/
Status?: number;
/**
* auto :自动选择
如果为网段,则为用户自定义 192.168.0.0/20
*/
FwVpcCidr?: string;
/**
* cdc专用集群场景时表示部署所属的cdc
注意:此字段可能返回 null,表示取不到有效值。
*/
CdcId?: string;
/**
* cdc专用集群场景时表示cdc名称
注意:此字段可能返回 null,表示取不到有效值。
*/
CdcName?: string;
/**
* 跨租户模式 1管理员 2单边 0 非跨租户
注意:此字段可能返回 null,表示取不到有效值。
*/
CrossUserMode?: string;
}
/**
* DeleteBlockIgnoreRuleList返回参数结构体
*/
export interface DeleteBlockIgnoreRuleListResponse {
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 统计折线图通用结构体
*/
export interface IpStatic {
/**
* 值
*/
Num: number;
/**
* 折线图横坐标时间
*/
StatTime: string;
}
/**
* CreateVpcFwGroup返回参数结构体
*/
export interface CreateVpcFwGroupResponse {
/**
* 防火墙组ID
注意:此字段可能返回 null,表示取不到有效值。
*/
FwGroupId?: string;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* VPC防火墙实例的CVM信息
*/
export interface VpcFwCvmInsInfo {
/**
* VPC防火墙实例ID
注意:此字段可能返回 null,表示取不到有效值。
*/
FwInsId: string;
/**
* CVM所在地域
注意:此字段可能返回 null,表示取不到有效值。
*/
Region?: string;
/**
* CVM所在地域中文
注意:此字段可能返回 null,表示取不到有效值。
*/
RegionZh?: string;
/**
* CVM所在地域详情
注意:此字段可能返回 null,表示取不到有效值。
*/
RegionDetail?: string;
/**
* 主机所在可用区
注意:此字段可能返回 null,表示取不到有效值。
*/
ZoneZh?: string;
/**
* 备机所在可用区
注意:此字段可能返回 null,表示取不到有效值。
*/
ZoneZhBack?: string;
/**
* 防火墙CVM带宽值
注意:此字段可能返回 null,表示取不到有效值。
*/
BandWidth?: number;
/**
* 实例主机所在可用区
注意:此字段可能返回 null,表示取不到有效值。
*/
Zone?: string;
/**
* 实例备机所在可用区
注意:此字段可能返回 null,表示取不到有效值。
*/
ZoneBak?: string;
}
/**
* DescribeEnterpriseSecurityGroupRule请求参数结构体
*/
export interface DescribeEnterpriseSecurityGroupRuleRequest {
/**
* 分页查询时,显示的当前页的页码。
默认值为1。
*/
PageNo: string;
/**
* 分页查询时,显示的每页数据的最大条数。
可设置值最大为50。
*/
PageSize: 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)
支持通配
*/
SourceContent?: 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;
/**
* 规则描述,支持通配
*/
Description?: string;
/**
* 访问控制策略中设置的流量通过云防火墙的方式。取值:
accept:放行
drop:拒绝
*/
RuleAction?: string;
/**
* 是否启用规则,默认为启用,取值:
true为启用,false为不启用
*/
Enable?: string;
/**
* 访问控制策略的端口。取值:
-1/-1:全部端口
80:80端口
*/
Port?: string;
/**
* 协议;TCP/UDP/ICMP/ANY
*/
Protocol?: string;
/**
* 端口协议类型参数模板id;协议端口模板id;与Protocol,Port互斥
*/
ServiceTemplateId?: string;
/**
* 规则的uuid
*/
RuleUuid?: number;
}
/**
* CreateAlertCenterRule请求参数结构体
*/
export interface CreateAlertCenterRuleRequest {
/**
* 处置时间
1 1天
7 7天
-2 永久
*/
HandleTime: number;
/**
* 处置类型
当HandleIdList 不为空时:1封禁 2放通
当HandleIpList 不为空时:3放通 4封禁
*/
HandleType: number;
/**
* 当前日志方向: 0 出向 1 入向
*/
AlertDirection: number;
/**
* 处置方向: 0出向 1入向 0,1出入向 3内网
*/
HandleDirection: string;
/**
* 处置对象,ID列表, IdLists和IpList二选一
*/
HandleIdList?: Array<string>;
/**
* 处置对象,IP列表, IdLists和IpList二选一
*/
HandleIpList?: Array<string>;
/**
* 处置描述
*/
HandleComment?: string;
/**
* 放通原因:
0默认 1重复 2误报 3紧急放通
*/
IgnoreReason?: number;
/**
* 封禁域名-保留字段
*/
BlockDomain?: string;
}
/**
* ModifyNatFwReSelect返回参数结构体
*/
export interface ModifyNatFwReSelectResponse {
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateAlertCenterOmit请求参数结构体
*/
export interface CreateAlertCenterOmitRequest {
/**
* 处置对象,ID列表, IdLists和IpList二选一
*/
HandleIdList: Array<string>;
/**
* 忽略数据来源:
AlertTable 告警中心 InterceptionTable拦截列表
*/
TableType: string;
}
/**
* DescribeVpcAcRule请求参数结构体
*/
export interface DescribeVpcAcRuleRequest {
/**
* 每页条数
*/
Limit: number;
/**
* 偏移值
*/
Offset: number;
/**
* 需要查询的索引,特定场景使用,可不填
*/
Index?: string;
/**
* 过滤条件组合
*/
Filters?: Array<CommonFilter>;
/**
* 检索的起始时间,可不传
*/
StartTime?: string;
/**
* 检索的截止时间,可不传
*/
EndTime?: string;
/**
* desc:降序;asc:升序。根据By字段的值进行排序,这里传参的话则By也必须有值
*/
Order?: string;
/**
* 排序所用到的字段
*/
By?: string;
}
/**
* VPC防火墙实例卡片信息
*/
export interface VpcFwInstanceInfo {
/**
* VPC防火墙实例名称
注意:此字段可能返回 null,表示取不到有效值。
*/
FwInsName: string;
/**
* VPC防火墙实例ID
注意:此字段可能返回 null,表示取不到有效值。
*/
FwInsId: string;
/**
* VPC防火墙实例模式 0: 旧VPC模式防火墙 1: CCN模式防火墙
注意:此字段可能返回 null,表示取不到有效值。
*/
FwMode: number;
/**
* VPC防火墙接入网络实例个数
注意:此字段可能返回 null,表示取不到有效值。
*/
JoinInsNum: number;
/**
* VPC防火墙开关个数
注意:此字段可能返回 null,表示取不到有效值。
*/
FwSwitchNum: number;
/**
* VPC防火墙状态 0:正常 , 1:创建中 2: 变更中
注意:此字段可能返回 null,表示取不到有效值。
*/
Status: number;
/**
* VPC防火墙创建时间
注意:此字段可能返回 null,表示取不到有效值。
*/
Time: string;
/**
* VPC 相关云联网ID列表
注意:此字段可能返回 null,表示取不到有效值。
*/
CcnId?: Array<string>;
/**
* VPC 相关云联网名称列表
注意:此字段可能返回 null,表示取不到有效值。
*/
CcnName?: Array<string>;
/**
* VPC 相关对等连接ID列表
注意:此字段可能返回 null,表示取不到有效值。
*/
PeerConnectionId?: Array<string>;
/**
* VPC 相关对等连接名称列表
注意:此字段可能返回 null,表示取不到有效值。
*/
PeerConnectionName?: Array<string>;
/**
* VPC防火墙CVM的列表
注意:此字段可能返回 null,表示取不到有效值。
*/
FwCvmLst?: Array<VpcFwCvmInsInfo>;
/**
* VPC防火墙接入网络实例类型列表
注意:此字段可能返回 null,表示取不到有效值。
*/
JoinInsLst?: Array<VpcFwJoinInstanceType>;
/**
* 防火墙网关信息
注意:此字段可能返回 null,表示取不到有效值。
*/
FwGateway?: Array<FwGateway>;
/**
* 防火墙(组)ID
注意:此字段可能返回 null,表示取不到有效值。
*/
FwGroupId?: string;
/**
* 已使用规则数
注意:此字段可能返回 null,表示取不到有效值。
*/
RuleUsed?: number;
/**
* 最大规则数
注意:此字段可能返回 null,表示取不到有效值。
*/
RuleMax?: number;
/**
* 防火墙实例带宽
注意:此字段可能返回 null,表示取不到有效值。
*/
Width?: number;
/**
* 用户VPC墙总带宽
注意:此字段可能返回 null,表示取不到有效值。
*/
UserVpcWidth?: number;
/**
* 接入的vpc列表
注意:此字段可能返回 null,表示取不到有效值。
*/
JoinInsIdLst?: Array<string>;
/**
* 内网间峰值带宽 (单位 bps )
*/
FlowMax?: number;
/**
* 实例引擎版本
注意:此字段可能返回 null,表示取不到有效值。
*/
EngineVersion?: string;
/**
* 引擎是否可升级:0,不可升级;1,可升级
注意:此字段可能返回 null,表示取不到有效值。
*/
UpdateEnable?: number;
/**
* 引擎运行模式,Normal:正常, OnlyRoute:透明模式
注意:此字段可能返回 null,表示取不到有效值。
*/
TrafficMode?: string;
}
/**
* DescribeSwitchLists请求参数结构体
*/
export interface DescribeSwitchListsRequest {
/**
* 防火墙状态 0: 关闭,1:开启
*/
Status?: number;
/**
* 资产类型 CVM/NAT/VPN/CLB/其它
*/
Type?: string;
/**
* 地域 上海/重庆/广州,等等
*/
Area?: string;
/**
* 搜索值 例子:"{"common":"106.54.189.45"}"
*/
SearchValue?: string;
/**
* 条数 默认值:10
*/
Limit?: number;
/**
* 偏移值 默认值: 0
*/
Offset?: number;
/**
* 排序,desc:降序,asc:升序
*/
Order?: string;
/**
* 排序字段 PortTimes(风险端口数)
*/
By?: string;
}
/**
* Nat防火墙弹性公网ip列表
*/
export interface NatFwEipsInfo {
/**
* 弹性公网ip
*/
Eip: string;
/**
* 所属的Nat网关Id
注意:此字段可能返回 null,表示取不到有效值。
*/
NatGatewayId: string;
/**
* Nat网关名称
注意:此字段可能返回 null,表示取不到有效值。
*/
NatGatewayName: string;
}
/**
* AddAclRule返回参数结构体
*/
export interface AddAclRuleResponse {
/**
* 创建成功后返回新策略ID列表
*/
RuleUuid?: Array<number | bigint>;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: 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数组
注意:此字段可能返回 null,表示取不到有效值。
*/
EipAddress?: Array<string>;
/**
* 内外使用ip数组
注意:此字段可能返回 null,表示取不到有效值。
*/
VpcIp?: Array<string>;
/**
* 实例关联子网数组
注意:此字段可能返回 null,表示取不到有效值。
*/
Subnets?: Array<string>;
/**
* 0 :正常 1:正在初始化
注意:此字段可能返回 null,表示取不到有效值。
*/
Status?: number;
/**
* 地域区域信息
注意:此字段可能返回 null,表示取不到有效值。
*/
RegionDetail?: string;
/**
* 实例所在可用区
注意:此字段可能返回 null,表示取不到有效值。
*/
ZoneZh?: string;
/**
* 实例所在可用区
注意:此字段可能返回 null,表示取不到有效值。
*/
ZoneZhBak?: string;
/**
* 已使用规则数
注意:此字段可能返回 null,表示取不到有效值。
*/
RuleUsed?: number;
/**
* 实例的规则限制最大规格数
注意:此字段可能返回 null,表示取不到有效值。
*/
RuleMax?: number;
/**
* 实例引擎版本
注意:此字段可能返回 null,表示取不到有效值。
*/
EngineVersion?: string;
/**
* 引擎是否可升级:0,不可升级;1,可升级
注意:此字段可能返回 null,表示取不到有效值。
*/
UpdateEnable?: number;
/**
* 是的需要升级引擎 支持 nat拨测 1需要 0不需要
注意:此字段可能返回 null,表示取不到有效值。
*/
NeedProbeEngineUpdate?: number;
/**
* 引擎运行模式,Normal:正常, OnlyRoute:透明模式
注意:此字段可能返回 null,表示取不到有效值。
*/
TrafficMode?: string;
/**
* 实例主所在可用区
注意:此字段可能返回 null,表示取不到有效值。
*/
Zone?: string;
/**
* 实例备所在可用区
注意:此字段可能返回 null,表示取不到有效值。
*/
ZoneBak?: string;
}
/**
* SetNatFwEip返回参数结构体
*/
export interface SetNatFwEipResponse {
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteSecurityGroupRule返回参数结构体
*/
export interface DeleteSecurityGroupRuleResponse {
/**
* 状态值,0:成功,非0:失败
*/
Status: number;
/**
* 返回多余的信息
注意:此字段可能返回 null,表示取不到有效值。
*/
Info: string;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyPublicIPSwitchStatus请求参数结构体
*/
export interface ModifyPublicIPSwitchStatusRequest {
/**
* 公网IP
*/
FireWallPublicIP: string;
/**
* 状态值,0: 关闭 ,1:开启
*/
Status: number;
}
/**
* 创建NAT ACL规则参数结构
*/
export interface CreateNatRuleItem {
/**
* 访问源示例: net:IP/CIDR(192.168.0.2)
*/
SourceContent: string;
/**
* 访问源类型:入向规则时类型可以为 ip,net,template,location;出向规则时可以为 ip,net,template,instance,group,tag
*/
SourceType: string;
/**
* 访问目的示例: net:IP/CIDR(192.168.0.2) domain:域名规则,例如*.qq.com
*/
TargetContent: string;
/**
* 访问目的类型:入向规则时类型可以为ip,net,template,instance,group,tag;出向规则时可以为 ip,net,domain,template,location
*/
TargetType: string;
/**
* 协议,可选的值: TCP UDP ICMP ANY HTTP HTTPS HTTP/HTTPS SMTP SMTPS SMTP/SMTPS FTP DNS
*/
Protocol: string;
/**
* 访问控制策略中设置的流量通过云防火墙的方式。取值: accept:放行 drop:拒绝 log:观察
*/
RuleAction: string;
/**
* 访问控制策略的端口。取值: -1/-1:全部端口 80:80端口
*/
Port: string;
/**
* 规则方向:1,入站;0,出站
*/
Direction: number;
/**
* 规则序号
*/
OrderIndex: number;
/**
* 规则状态,true表示启用,false表示禁用
*/
Enable: string;
/**
* 规则对应的唯一id,创建规则时无需填写
*/
Uuid?: number;
/**
* 描述
*/
Description?: string;
}
/**
* ModifyStorageSetting返回参数结构体
*/
export interface ModifyStorageSettingResponse {
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 访问控制列表对象
*/
export interface AcListsData {
/**
* 规则id
*/
Id: number;
/**
* 访问源
注意:此字段可能返回 null,表示取不到有效值。
*/
SourceIp: string;
/**
* 访问目的
注意:此字段可能返回 null,表示取不到有效值。
*/
TargetIp: string;
/**
* 协议
注意:此字段可能返回 null,表示取不到有效值。
*/
Protocol: string;
/**
* 端口
注意:此字段可能返回 null,表示取不到有效值。
*/
Port: string;
/**
* 策略
注意:此字段可能返回 null,表示取不到有效值。
*/
Strategy: number;
/**
* 描述
注意:此字段可能返回 null,表示取不到有效值。
*/
Detail: string;
/**
* 命中次数
*/
Count: number;
/**
* 执行顺序
*/
OrderIndex: number;
/**
* 告警规则id
注意:此字段可能返回 null,表示取不到有效值。
*/
LogId: string;
}
/**
* ModifySecurityGroupItemRuleStatus请求参数结构体
*/
export interface ModifySecurityGroupItemRuleStatusRequest {
/**
* 方向,0:出站,1:入站,默认1
*/
Direction: number;
/**
* 是否开关开启,0:未开启,1:开启
*/
Status: number;
/**
* 更改的企业安全组规则的执行顺序
*/
RuleSequence: number;
}
/**
* VPC防火墙接入的网络实例类型及数量
*/
export interface VpcFwJoinInstanceType {
/**
* 接入实例类型,VPC、DIRECTCONNECT、 VPNGW 等
注意:此字段可能返回 null,表示取不到有效值。
*/
JoinType: string;
/**
* 接入的对应网络实例类型的数量
注意:此字段可能返回 null,表示取不到有效值。
*/
Num: number;
}
/**
* DescribeSourceAsset请求参数结构体
*/
export interface DescribeSourceAssetRequest {
/**
* 模糊查询
*/
FuzzySearch?: string;
/**
* 资产类型 1公网 2内网
*/
InsType?: string;
/**
* ChooseType为1,查询已经分组的资产;ChooseType不为1查询没有分组的资产
*/
ChooseType?: string;
/**
* 地域
*/
Zone?: string;
/**
* 查询单页的最大值;eg:10;则最多返回10条结果
*/
Limit?: number;
/**
* 查询结果的偏移量
*/
Offset?: number;
}
/**
* 企业安全组规则执行顺序修改对象
*/
export interface SecurityGroupOrderIndexData {
/**
* 企业安全组规则当前执行顺序
*/
OrderIndex: number;
/**
* 企业安全组规则更新目标执行顺序
*/
NewOrderIndex: number;
}
/**
* DescribeFwGroupInstanceInfo返回参数结构体
*/
export interface DescribeFwGroupInstanceInfoResponse {
/**
* 防火墙(组)
注意:此字段可能返回 null,表示取不到有效值。
*/
VpcFwGroupLst?: Array<VpcFwGroupInfo>;
/**
* 防火墙(组)个数
注意:此字段可能返回 null,表示取不到有效值。
*/
Total?: number;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeSourceAsset返回参数结构体
*/
export interface DescribeSourceAssetResponse {
/**
* 地域集合
*/
ZoneList: Array<AssetZone>;
/**
* 数据
*/
Data: Array<InstanceInfo>;
/**
* 返回数据总数
*/
Total: number;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeFwGroupInstanceInfo请求参数结构体
*/
export interface DescribeFwGroupInstanceInfoRequest {
/**
* 每页条数
*/
Limit: number;
/**
* 偏移值
*/
Offset: number;
/**
* 过滤条件组合
*/
Filters?: Array<CommonFilter>;
/**
* 检索的起始时间,可不传
*/
StartTime?: string;
/**
* 检索的截止时间,可不传
*/
EndTime?: string;
/**
* desc:降序;asc:升序。根据By字段的值进行排序,这里传参的话则By也必须有值
*/
Order?: string;
/**
* 排序所用到的字段
*/
By?: string;
}
/**
* ModifyBlockIgnoreRule请求参数结构体
*/
export interface ModifyBlockIgnoreRuleRequest {
/**
* 规则
*/
Rule: IntrusionDefenseRule;
/**
* 规则类型,1封禁,2放通
*/
RuleType: number;
}
/**
* DescribeEnterpriseSGRuleProgress请求参数结构体
*/
export declare type DescribeEnterpriseSGRuleProgressRequest = null;
/**
* 边界防火墙公网IP开关列表
*/
export interface EdgeIpInfo {
/**
* 公网IP
*/
PublicIp?: string;
/**
* 公网 IP 类型
注意:此字段可能返回 null,表示取不到有效值。
*/
PublicIpType?: number;
/**
* 实例ID
注意:此字段可能返回 null,表示取不到有效值。
*/
InstanceId?: string;
/**
* 实例名
注意:此字段可能返回 null,表示取不到有效值。
*/
InstanceName?: string;
/**
* 内网IP
注意:此字段可能返回 null,表示取不到有效值。
*/
IntranetIp?: string;
/**
* 资产类型
注意:此字段可能返回 null,表示取不到有效值。
*/
AssetType?: string;
/**
* 地域
注意:此字段可能返回 null,表示取不到有效值。
*/
Region?: string;
/**
* 风险端口数
注意:此字段可能返回 null,表示取不到有效值。
*/
PortRiskCount?: number;
/**
* 最近扫描时间
注意:此字段可能返回 null,表示取不到有效值。
*/
LastScanTime?: string;
/**
* 是否为region eip
0 不为region eip,不能选择串行
1 为region eip 可以选择串行
注意:此字段可能返回 null,表示取不到有效值。
*/
IsRegionEip?: number;
/**
* EIP 所关联的VPC
注意:此字段可能返回 null,表示取不到有效值。
*/
VpcId?: string;
/**
* 0: 该地域暂未支持串行
1: 该用户未在该地域配置串行带宽
2: 该用户已在该地域配置串行带宽,可以开启串行开关
注意:此字段可能返回 null,表示取不到有效值。
*/
IsSerialRegion?: number;
/**
* 0: 不是公网CLB 可以开启串行开关
1: 是公网CLB 不可以开启串行开关
注意:此字段可能返回 null,表示取不到有效值。
*/
IsPublicClb?: number;
/**
* 0: 开启开关时提示要创建私有连接。
1: 关闭该开关是提示删除私有连接。
如果大于 1: 关闭开关 、开启开关不需提示创建删除私有连接。
注意:此字段可能返回 null,表示取不到有效值。
*/
EndpointBindEipNum?: number;
/**
* 扫描深度
注意:此字段可能返回 null,表示取不到有效值。
*/
ScanMode?: string;
/**
* 扫描状态
注意:此字段可能返回 null,表示取不到有效值。
*/
ScanStatus?: number;
/**
* 开关状态
0 : 关闭
1 : 开启
2 : 开启中
3 : 关闭中
4 : 异常
注意:此字段可能返回 null,表示取不到有效值。
*/
Status?: number;
/**
* 私有连接ID
注意:此字段可能返回 null,表示取不到有效值。
*/
EndpointId?: string;
/**
* 私有连接IP
注意:此字段可能返回 null,表示取不到有效值。
*/
EndpointIp?: string;
/**
* 0 : 旁路
1 : 串行
2 : 正在模式切换
*/
SwitchMode?: number;
/**
* 开关权重
注意:此字段可能返回 null,表示取不到有效值。
*/
SwitchWeight?: number;
/**
* 域名化CLB的域名
注意:此字段可能返回 null,表示取不到有效值。
*/
Domain?: string;
}
/**
* AssetZone
*/
export interface AssetZone {
/**
* 地域
*/
Zone: string;
/**
* 地域英文
*/
ZoneEng: string;
}
/**
* 规则顺序变更项,由原始id值变为新的id值。
*/
export interface RuleChangeItem {
/**
* 原始sequence 值
*/
OrderIndex: number;
/**
* 新的sequence 值
*/
NewOrderIndex: number;
}
/**
* 入侵防御封禁列表、放通列表添加规则入参
*/
export interface IntrusionDefenseRule {
/**
* 规则方向,0出站,1入站,3内网间
*/
Direction: number;
/**
* 规则结束时间,格式:2006-01-02 15:04:05,必须大于当前时间
*/
EndTime: string;
/**
* 规则IP地址,IP与Domain必填其中之一
*/
IP?: string;
/**
* 规则域名,IP与Domain必填其中之一
*/
Domain?: string;
/**
* 备注信息,长度不能超过50
*/
Comment?: string;
/**
* 规则开始时间
*/
StartTime?: string;
}
/**
* DescribeTLogIpList请求参数结构体
*/
export interface DescribeTLogIpListRequest {
/**
* 开始时间
*/
StartTime: string;
/**
* 结束时间
*/
EndTime: string;
/**
* 类型 1 告警 2阻断
*/
QueryType: string;
/**
* top数
*/
Top: number;
/**
* 查询条件
*/
SearchValue?: string;
}
/**
* 通用的列表检索过滤选项
*/
export interface CommonFilter {
/**
* 检索的键值
*/
Name: string;
/**
* 检索的值,各检索值间为OR关系
*/
Values: Array<string>;
/**
* 枚举类型,代表Name与Values之间的匹配关系
enum FilterOperatorType {
//等于
FILTER_OPERATOR_TYPE_EQUAL = 1;
//大于
FILTER_OPERATOR_TYPE_GREATER = 2;
//小于
FILTER_OPERATOR_TYPE_LESS = 3;
//大于等于
FILTER_OPERATOR_TYPE_GREATER_EQ = 4;
//小于等于
FILTER_OPERATOR_TYPE_LESS_EQ = 5;
//不等于
FILTER_OPERATOR_TYPE_NO_EQ = 6;
//not in
FILTER_OPERATOR_TYPE_NOT_IN = 8;
//模糊匹配
FILTER_OPERATOR_TYPE_FUZZINESS = 9;
}
*/
OperatorType: number;
}
/**
* DescribeNatFwInstancesInfo请求参数结构体
*/
export interface DescribeNatFwInstancesInfoRequest {
/**
* 获取实例列表过滤字段
*/
Filter?: Array<NatFwFilter>;
/**
* 第几页
*/
Offset?: number;
/**
* 每页长度
*/
Limit?: number;
}
/**
* AddVpcAcRule请求参数结构体
*/
export interface AddVpcAcRuleRequest {
/**
* 需要添加的vpc内网间规则列表
*/
Rules: Array<VpcRuleItem>;
/**
* 添加规则的来源,一般不需要使用,值insert_rule 表示插入指定位置的规则;值batch_import 表示批量导入规则;为空时表示添加规则
*/
From?: 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;
}
/**
* ModifyNatSequenceRules返回参数结构体
*/
export interface ModifyNatSequenceRulesResponse {
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeAssetSync返回参数结构体
*/
export interface DescribeAssetSyncResponse {
/**
* 返回状态
1 更新中
2 更新完成
3 更新失败
4 更新失败
*/
Status?: number;
/**
* success 成功
其他失败
*/
ReturnMsg?: string;
/**
* 0 成功
非0 失败
*/
ReturnCode?: number;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeSecurityGroupList请求参数结构体
*/
export interface DescribeSecurityGroupListRequest {
/**
* 0: 出站规则,1:入站规则
*/
Direction: number;
/**
* 地域代码(例: ap-guangzhou),支持腾讯云全部地域
*/
Area: string;
/**
* 搜索值
*/
SearchValue?: string;
/**
* 每页条数,默认为10
*/
Limit?: