CustomerGateway
对端网关
被如下接口引用：CreateCustomerGateway, DescribeCustomerGateways。
| 名称 | 类型 | 描述 |
|---|---|---|
| CustomerGatewayId | String | 用户网关唯一ID |
| CustomerGatewayName | String | 网关名称 |
| IpAddress | String | 公网地址 |
| CreateTime | String | 创建时间 |
| VpnConnNum | Integer | VPN通道引用个数 注意：此字段可能返回 null，表示取不到有效值。 |
Filter
过滤器
被如下接口引用：DescribeCustomerGateways, DescribeRoutePolicies, DescribeRouteTables, DescribeSubnets, DescribeVpcPeerConnections, DescribeVpcResource, DescribeVpcs, DescribeVpnConnections, DescribeVpnGateways。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Name | String | 是 | 属性名称, 若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。 |
| Values | Array of String | 是 | 属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。 |
IKEOptionsSpecification
IKE配置（Internet Key Exchange，因特网密钥交换），IKE具有一套自我保护机制，用户配置网络安全协议
被如下接口引用：DescribeVpnConnections, ModifyVpnConnectionAttribute。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| PropoEncryAlgorithm | String | 否 | 加密算法，可选值：'3DES-CBC', 'AES-CBC-128', 'AES-CBC-192', 'AES-CBC-256', 'DES-CBC'，默认为3DES-CBC |
| PropoAuthenAlgorithm | String | 否 | 认证算法：可选值：'MD5', 'SHA1'，默认为MD5 |
| ExchangeMode | String | 否 | 协商模式：可选值：'AGGRESSIVE', 'MAIN'，默认为MAIN |
| LocalIdentity | String | 否 | 本端标识类型：可选值：'ADDRESS', 'FQDN'，默认为ADDRESS |
| RemoteIdentity | String | 否 | 对端标识类型：可选值：'ADDRESS', 'FQDN'，默认为ADDRESS |
| LocalAddress | String | 否 | 本端标识，当LocalIdentity选为ADDRESS时，LocalAddress必填。localAddress默认为vpn网关公网IP |
| RemoteAddress | String | 否 | 对端标识，当RemoteIdentity选为ADDRESS时，RemoteAddress必填 |
| LocalFqdnName | String | 否 | 本端标识，当LocalIdentity选为FQDN时，LocalFqdnName必填 |
| RemoteFqdnName | String | 否 | 对端标识，当remoteIdentity选为FQDN时，RemoteFqdnName必填 |
| DhGroupName | String | 否 | DH group，指定IKE交换密钥时使用的DH组，可选值：'GROUP1', 'GROUP2', 'GROUP5', 'GROUP14', 'GROUP24'， |
| IKESaLifetimeSeconds | Integer | 否 | IKE SA Lifetime，单位：秒，设置IKE SA的生存周期，取值范围：60-604800 |
| IKEVersion | String | 否 | IKE版本 |
IPSECOptionsSpecification
IPSec配置，腾讯云提供IPSec安全会话设置
被如下接口引用：DescribeVpnConnections, ModifyVpnConnectionAttribute。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| PfsDhGroup | String | 是 | PFS：可选值：'NULL', 'DH-GROUP1', 'DH-GROUP2', 'DH-GROUP5', 'DH-GROUP14', 'DH-GROUP24'，默认为NULL |
| IPSECSaLifetimeTraffic | Integer | 是 | IPsec SA lifetime(KB)：单位KB，取值范围：2560-604800 |
| EncryptAlgorithm | String | 否 | 加密算法，可选值：'3DES-CBC', 'AES-CBC-128', 'AES-CBC-192', 'AES-CBC-256', 'DES-CBC', 'NULL'， 默认为AES-CBC-128 |
| IntegrityAlgorith | String | 否 | 认证算法：可选值：'MD5', 'SHA1'，默认为 |
| IPSECSaLifetimeSeconds | Integer | 否 | IPsec SA lifetime(s)：单位秒，取值范围：180-604800 |
| SecurityProto | String | 否 | 安全协议，默认为ESP |
| EncapMode | String | 否 | 报文封装模式:默认为Tunnel |
IpInfo
NAT IP信息
被如下接口引用：BindIpsToNatGateway, CreateNatGateway, UnbindIpsFromNatGateway。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| SubnetId | String | 是 | 子网ID |
| Ips | Array of String | 是 | IP列表 |
NatGatewayInfo
NAT详情
被如下接口引用：DescribeNatGateways。
| 名称 | 类型 | 描述 |
|---|---|---|
| NatId | String | NAT网关ID |
| NatName | String | 网关名称 |
| VpcId | String | 私有网络ID |
| VpcName | String | 私有网络名称 |
| ProductionStatus | Integer | 网关创建状态，其中0表示创建中，1表示运行中，2表示创建失败 |
| Eips | Array of String | EIP列表 |
| MaxConcurrent | Integer | 并发连接数规格，取值为1000000, 3000000, 10000000 |
| Zone | String | 可用区 |
| Exclusive | Integer | 独占标识，其中0表示共享，1表示独占，默认值为0 |
| ForwardMode | Integer | 转发模式，其中0表示IP方式，1表示网段方式 |
| VpcCidrBlock | String | 私有网络网段 |
| Type | String | 网关类型，取值为 small，middle，big，分别对应小型、中型、大型 |
| CreateTime | Timestamp | 创建时间 |
| State | Integer | 网关启用状态，1为禁用，0为启用。 |
| IntVpcId | Integer | 私有网络整型ID |
| NatResourceId | Integer | NAT资源ID |
NatSubnetInfo
NAT子网信息
被如下接口引用：DescribeNatSubnets。
| 名称 | 类型 | 描述 |
|---|---|---|
| Name | String | 子网名称 |
| SubnetId | String | 子网ID |
| SubnetNatType | Integer | NAT子网类型，其中0表示绑定部分IP的NAT子网，1表示绑定全部IP的NAT子网，2表示绑定网关方式的NAT子网 |
| CidrBlock | String | 子网网段 |
RoutePolicy
路由条目
被如下接口引用：CreateRoutePolicies, DescribeRoutePolicies, ModifyRoutePolicy。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| DestinationCidrBlock | String | 否 | 目的网段 |
| GatewayType | String | 否 | 下一跳类型，目前我们支持的类型有： LOCAL：物理机默认路由； VPN：VPN网关； PEERCONNECTION：对等连接； CPM：物理机自定义路由； CCN：云联网； TGW：公网默认路由； SSLVPN : SSH SSL VPN网关。 |
| GatewayId | String | 否 | 下一跳地址，这里只需要指定不同下一跳类型的网关ID，系统会自动匹配到下一跳地址。 |
| RouteDescription | String | 否 | 路由策略描述。 |
| RoutePolicyId | String | 否 | 路由策略ID |
| RoutePolicyType | String | 否 | 路由类型，目前我们支持的类型有： USER：用户自定义路由； NETD：网络探测路由，创建网络探测实例时，系统默认下发，不可编辑与删除； CCN：云联网路由，系统默认下发，不可编辑与删除。 用户只能添加和编辑USER 类型的路由。 |
| Enabled | Boolean | 否 | 是否启用 |
RouteTable
路由表对象
被如下接口引用：DescribeRouteTables。
| 名称 | 类型 | 描述 |
|---|---|---|
| VpcId | String | VPC实例ID。 |
| VpcName | String | VPC的名称 |
| VpcCidrBlock | String | VPC的CIDR |
| Zone | String | 可用区 |
| RouteTableId | String | 路由表实例ID，例如：rtb-azd4dt1c。 |
| RouteTableName | String | 路由表名称。 |
| CreateTime | Timestamp | 创建时间。 |
SecurityPolicyDatabase
SecurityPolicyDatabase策略
被如下接口引用：DescribeVpnConnections, ModifyVpnConnectionAttribute。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| LocalCidrBlock | String | 是 | 本端网段 |
| RemoteCidrBlock | Array of String | 是 | 对端网段 |
SubnetCreateInputInfo
创建子网时的子网类型
被如下接口引用：CreateDockerSubnetWithVlan, CreateSubnet, CreateVirtualSubnetWithVlan。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| SubnetName | String | 是 | 子网名称，可任意命名，但不得超过60个字符 |
| CidrBlock | String | 是 | 子网网段，子网网段必须在VPC网段内，相同VPC内子网网段不能重叠 |
| DistributedFlag | Integer | 否 | 是否开启子网分布式网关，默认传1，传0为关闭子网分布式网关。关闭分布式网关子网用于云服务器化子网，此子网中只能有一台物理机，同时此物理机及其上子机只能在此子网中 |
| DhcpEnable | Integer | 否 | 是否开启dhcp relay ，关闭为0，开启为1。默认为0 |
| DhcpServerIp | Array of String | 否 | DHCP SERVER 的IP地址数组。IP地址为相同VPC的子网内分配的IP |
| IpReserve | Integer | 否 | 预留的IP个数。从该子网的最大可分配IP倒序分配N个IP 用于DHCP 动态分配使用的地址段 |
| VlanId | Integer | 否 | 子网绑定的vlanId。VlanId取值范围为2000-2999。创建物理机子网，VlanId默认为5; 创建docker子网或者虚拟子网，VlanId默认会分配2000--2999未使用的数值。 |
| Zone | String | 否 | 黑石子网的可用区 |
| IsSmartNic | Integer | 否 | 是否25G子网，1为是，0为否。 |
SubnetInfo
黑石子网的信息
被如下接口引用：DescribeSubnetByDevice, DescribeSubnetByHostedDevice, DescribeSubnets。
| 名称 | 类型 | 描述 |
|---|---|---|
| VpcId | String | 私有网络的唯一ID。 |
| VpcName | String | VPC的名称。 |
| VpcCidrBlock | String | VPC的CIDR。 |
| SubnetId | String | 私有网络的唯一ID |
| SubnetName | String | 子网名称。 |
| CidrBlock | String | 子网CIDR。 |
| Type | Integer | 子网类型。0: 黑石物理机子网; 6: ccs子网; 7 Docker子网; 8: 虚拟机子网 |
| ZoneId | Integer | 子网可用区ID。 |
| CpmNum | Integer | 子网物理机的个数 |
| VlanId | Integer | 子网的VlanId。 |
| DistributedFlag | Integer | 是否开启分布式网关 ，关闭为0，开启为1。 |
| DhcpEnable | Integer | 是否开启dhcp relay ，关闭为0，开启为1。默认为0。 |
| DhcpServerIp | Array of String | DHCP SERVER 的IP地址数组。IP地址为相同VPC的子网内分配的IP。 |
| IpReserve | Integer | 预留的IP个数。从该子网的最大可分配IP倒序分配N个IP 用于DHCP 动态分配使用的地址段。 |
| AvailableIpNum | Integer | 子网中可用的IP个数 |
| TotalIpNum | Integer | 子网中总共的IP个数 |
| SubnetCreateTime | Timestamp | 子网创建时间 |
| IsSmartNic | Integer | 25G子网标识 |
| Zone | String | 子网可用区。 注意：此字段可能返回 null，表示取不到有效值。 |
| VpcZoneId | Integer | VPC所在可用区ID |
| VpcZone | String | VPC所在可用区 |
| BroadcastFlag | Integer | 是否开启广播，关闭为0，开启为1。 |
VpcInfo
VPC信息
被如下接口引用：DescribeVpcs。
| 名称 | 类型 | 描述 |
|---|---|---|
| VpcId | String | 私有网络的唯一ID。 |
| VpcName | String | VPC的名称。 |
| CidrBlock | String | VPC的CIDR。 |
| Zone | String | 可用区 |
| State | String | VPC状态 |
| CreateTime | Timestamp | 创建时间 |
| IntVpcId | Integer | 整型私有网络ID。 |
VpcPeerConnection
对等连接对象
被如下接口引用：DescribeVpcPeerConnections。
| 名称 | 类型 | 描述 |
|---|---|---|
| VpcId | String | 本端VPC唯一ID |
| PeerVpcId | String | 对端VPC唯一ID |
| AppId | String | 本端APPID |
| PeerAppId | String | 对端APPID |
| VpcPeerConnectionId | String | 对等连接唯一ID |
| VpcPeerConnectionName | String | 对等连接名称 |
| State | String | 对等连接状态。pending:申请中,available:运行中,expired:已过期,rejected:已拒绝,deleted:已删除 |
| VpcZone | String | 本端VPC所属可用区 注意：此字段可能返回 null，表示取不到有效值。 |
| PeerVpcZone | String | 对端VPC所属可用区 注意：此字段可能返回 null，表示取不到有效值。 |
| Uin | Integer | 本端Uin |
| PeerUin | Integer | 对端Uin |
| PeerType | Integer | 对等连接类型 |
| Bandwidth | Integer | 对等连接带宽 |
| Region | String | 本端VPC地域 |
| PeerRegion | String | 对端VPC地域 |
| DeleteFlag | Integer | 是否允许删除 注意：此字段可能返回 null，表示取不到有效值。 |
| CreateTime | Timestamp | 创建时间 |
VpcQuota
VPC限额信息
被如下接口引用：DescribeVpcQuota。
| 名称 | 类型 | 描述 |
|---|---|---|
| TypeId | Integer | 配额类型ID |
| Quota | Integer | 配额 |
VpcResource
VPC占用资源
被如下接口引用：DescribeVpcResource。
| 名称 | 类型 | 描述 |
|---|---|---|
| VpcId | String | 私有网络ID |
| VpcName | String | 私有网络名称 |
| CidrBlock | String | 私有网络的CIDR |
| SubnetNum | Integer | 子网个数 |
| NatNum | Integer | NAT个数 |
| State | String | VPC状态 |
| MonitorFlag | Boolean | 是否开启监控 |
| CpmNum | Integer | 物理机个数 |
| LeaveIpNum | Integer | 可用IP个数 |
| LbNum | Integer | 负载均衡个数 |
| TrafficMirrorNum | Integer | 流量镜像网关个数 |
| EipNum | Integer | 弹性IP个数 |
| PlgwNum | Integer | 专线网关个数 |
| PlvpNum | Integer | 专线通道个数 |
| SslVpnGwNum | Integer | ssl vpn网关个数 |
| VpcPeerNum | Integer | 对等链接个数 |
| IpsecVpnGwNum | Integer | ipsec vpn网关个数 |
| Zone | String | 可用区 |
| CreateTime | Timestamp | 创建时间 |
| IsOld | Boolean | 是否老专区VPC |
| CcnServiceNum | Integer | 云联网服务个数 注意：此字段可能返回 null，表示取不到有效值。 |
| VpcPeerLimitToAllRegion | Integer | VPC允许创建的对等连接个数 注意：此字段可能返回 null，表示取不到有效值。 |
| VpcPeerLimitToSameRegion | Integer | VPC允许创建的同地域的对等连接的个数 注意：此字段可能返回 null，表示取不到有效值。 |
| IntVpcId | Integer | 整型私有网络ID |
VpcSubnetCreateInfo
创建VPC下默认子网
被如下接口引用：CreateVpc。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| SubnetName | String | 是 | 子网名称 |
| CidrBlock | String | 是 | 子网的CIDR |
| Zone | String | 否 | 子网的可用区 |
VpcSubnetViewInfo
VPC视图子网信息
被如下接口引用：DescribeVpcView。
| 名称 | 类型 | 描述 |
|---|---|---|
| SubnetId | String | 子网ID |
| SubnetName | String | 子网名称 |
| CidrBlock | String | 子网CIDR |
| CpmNum | Integer | 子网下设备个数 |
| LbNum | Integer | 内网负载均衡个数 |
| Zone | String | 子网所在可用区 |
VpcViewInfo
VPC视图信息
被如下接口引用：DescribeVpcView。
| 名称 | 类型 | 描述 |
|---|---|---|
| VpcId | String | 私有网络ID |
| VpcName | String | 私有网络名称 |
| CidrBlock | String | 私有网络CIDR |
| Zone | String | 私有网络所在可用区 |
| LbNum | Integer | 外网负载均衡个数 |
| EipNum | Integer | 弹性公网IP个数 |
| NatNum | Integer | NAT网关个数 |
| SubnetSet | Array of VpcSubnetViewInfo | 子网列表 |
VpnConnection
VPN通道对象。
被如下接口引用：DescribeVpnConnections。
| 名称 | 类型 | 描述 |
|---|---|---|
| VpnConnectionId | String | 通道实例ID。 |
| VpnConnectionName | String | 通道名称。 |
| VpcId | String | VPC实例ID。 |
| VpnGatewayId | String | VPN网关实例ID。 |
| CustomerGatewayId | String | 对端网关实例ID。 |
| PreShareKey | String | 预共享密钥。 |
| VpnProto | String | 通道传输协议。 |
| CreateTime | String | 创建时间。 |
| State | String | 通道的生产状态 |
| NetStatus | String | 通道连接状态 |
| SecurityPolicyDatabaseSet | Array of SecurityPolicyDatabase | SPD。 |
| IKEOptionsSpecification | IKEOptionsSpecification | IKE选项。 |
| IPSECOptionsSpecification | IPSECOptionsSpecification | IPSEC选项。 |
| Zone | String | 可用区 |
| VpcCidrBlock | String | VPC网段 |
| VpcName | String | VPC名称 |
| VpnGatewayName | String | VPN网关名称 |
| CustomerGatewayName | String | 对端网关名称 |
| DestinationCidr | Array of String | IPSEC VPN通道路由策略目的端地址 注意：此字段可能返回 null，表示取不到有效值。 |
| SourceCidr | Array of String | IPSEC VPN通道路由策略源端地址 注意：此字段可能返回 null，表示取不到有效值。 |
VpnGateway
VPN网关对象。
被如下接口引用：DescribeVpnGateways。
| 名称 | 类型 | 描述 |
|---|---|---|
| VpnGatewayId | String | 网关实例ID。 |
| VpcId | String | VPC实例ID。 |
| VpnGatewayName | String | 网关实例名称。 |
| VpcCidrBlock | String | VPC网段 |
| VpcName | String | VPC名称 |
| InternetMaxBandwidthOut | Integer | 网关出带宽。 |
| State | String | 网关实例状态 |
| PublicIpAddress | String | 网关公网IP。 |
| CreateTime | Timestamp | 创建时间。 |
| Zone | String | 可用区，如：ap-guangzhou |
| VpnConnNum | Integer | VPN网关的通道数 |
