数据结构
最近更新时间: 2026-11-06 00:15:43
VpcOssVpcPeerRequest
复杂类型: VpcOssVpcPeerRequest
被如下接口引用：UpdateVpcPeerInternal
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| State | 否 | 否 | Int64 | 原VPC OSS APIv2名称: UpdateVpcPeer.state 示例值： 0 |
| Bandwidth | 否 | 否 | Int64 | 原VPC OSS APIv2名称: UpdateVpcPeer.bandwidth 示例值： 0 |
| OwedFlag | 否 | 否 | Int64 | 原VPC OSS APIv2名称: UpdateVpcPeer.owedFlag 示例值： 0 |
| UniqueVpcPeerId | 否 | 否 | String | 原VPC OSS APIv2名称: UpdateVpcPeer.uniqVpcPeerId 示例值： pcx-fh7xs34s |
| VpcPeerId | 否 | 否 | Int64 | 原VPC OSS APIv2名称: UpdateVpcPeer.vpcPeerId 示例值： 2 |
| Owner | 否 | 否 | String | 用户AppId 示例值： 251198225 |
| Name | 否 | 否 | String | 名称 示例值： 11 |
| VirtualSafeGroupIp | 否 | 否 | String | 原VPC OSS APIv2名称: UpdateVpcPeer.vsgIp 示例值： 1.2.3.5 |
| NewAfcFlag | 否 | 否 | Int64 | 原VPC OSS APIv2名称: UpdateVpcPeer.bNewAfc 示例值： 1 |
| PublishDockerCidrFlag | 否 | 否 | Uint64 | 原VPC OSS APIv2名称: UpdateVpcPeer.bPublishDockerCidr 示例值： 0 |
NetDetectState
网络探测验证结果。
被如下接口引用：DescribeNetDetectStates
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| NetDetectId | 是 | 否 | String | 网络探测实例ID。形如：netd-demoag78。 示例值： netd-7s4wt576 |
| NetDetectIpStateSet | 是 | 否 | Array of NetDetectIpState | 网络探测目的IP验证结果对象数组。 示例值：查看 |
VpcOssRouteInfoRequest
复杂类型: VpcOssRouteInfoRequest
被如下接口引用：CreateRouteInternal、DeleteRouteInternal
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| RouteSet | 否 | 否 | Array of VpcOssRouteForDeleteRouteInternal | 原VPC OSS APIv2名称: DelRoute.route 示例值：查看 |
| VpcId | 否 | 否 | Int64 | 整数vpcId 示例值： 1 |
| UniqueVpcId | 否 | 否 | String | 对外唯一VpcId 示例值： vpc-jmaywf6r |
| GroupId | 否 | 否 | Int64 | 原VPC OSS APIv2名称: DelRoute.groupId 示例值： 0 |
| Type | 否 | 否 | Int64 | 原VPC OSS APIv2名称: DelRoute.type 示例值： 0 |
| Protocol | 否 | 否 | String | 原VPC OSS APIv2名称: DelRoute.proto 示例值： tcp |
| VirtualPort | 否 | 否 | Int64 | 原VPC OSS APIv2名称: DelRoute.vport 示例值： 22 |
| Vip | 否 | 否 | String | 原VPC OSS APIv2名称: DelRoute.vip 示例值： 172.16.0.18 |
ClassicLinkInstance
私有网络和基础网络互通设备
被如下接口引用：DescribeClassicLinkInstances
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| VpcId | 是 | 否 | String | VPC实例ID 示例值： vpc-67wlqf6v |
| InstanceId | 是 | 否 | String | 云服务器实例唯一ID 示例值： ins-kngiybxl |
VpcOssNewService
复杂类型: VpcOssNewService
被如下接口引用：CreateServiceInternal
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| UniqueVpcGatewayId | 否 | 否 | String | 原VPC OSS APIv2名称: AddService.uniqVpcgwId 示例值： vpcgw-7hk7255d |
| VpcGatewayZoneId | 否 | 否 | Int64 | 原VPC OSS APIv2名称: AddService.vpcgwZoneId 示例值： 1002 |
| Sip | 否 | 否 | String | 原VPC OSS APIv2名称: AddService.sip 示例值： 1.1.1.1 |
| SubnetRouteAlgorithm | 否 | 否 | Int64 | 原VPC OSS APIv2名称: AddService.subnetRouteAlgorithm 示例值： 0 |
| FakeToaIp | 否 | 是 | String | 原VPC OSS APIv2名称: AddService. fakeToaIp 示例值： 192.168.0.1 |
| Vip | 否 | 否 | String | 原VPC OSS APIv2名称: AddService.vip 示例值： 172.16.0.18 |
| StickyTimeout | 否 | 否 | Int64 | 原VPC OSS APIv2名称: AddService.stickyTimeout 示例值： 0 |
| RouteGroupId | 否 | 否 | Int64 | 原VPC OSS APIv2名称: AddService.routeGroupId 示例值： 1 |
| Type | 否 | 否 | Int64 | 原VPC OSS APIv2名称: AddService.type 示例值： 0 |
| Protocol | 否 | 否 | String | 原VPC OSS APIv2名称: AddService.proto 示例值： tcp |
| RemoteVpcId | 否 | 否 | Int64 | 原VPC OSS APIv2名称: AddService.remoteVpcId 示例值： 1 |
| VpcGatewayType | 否 | 否 | Int64 | 原VPC OSS APIv2名称: AddService.vpcGwType 示例值： 1 |
| StickyFlag | 否 | 否 | Int64 | 原VPC OSS APIv2名称: AddService.stickyFlag 示例值： 0 |
| LbType | 否 | 否 | Int64 | 原VPC OSS APIv2名称: AddService.lbType 示例值： 0 |
| ResetFlag | 否 | 否 | Int64 | 原VPC OSS APIv2名称: AddService.rstFlag 示例值： 0 |
| NoSnatFlag | 否 | 否 | Int64 | 原VPC OSS APIv2名称: AddService.noSnatFlag 示例值： 0 |
| BypassFlag | 否 | 否 | Int64 | 原VPC OSS APIv2名称: AddService.bypassFlag 示例值： 0 |
| Business | 否 | 否 | String | 原VPC OSS APIv2名称: AddService.business 示例值： dockerMaster |
| GroupId | 否 | 是 | Int64 | 原VPC OSS APIv2名称: AddService.groupId 示例值： 1 |
| VpcId | 否 | 否 | Int64 | 整数vpcId 示例值： 1 |
| VirtualPort | 否 | 否 | Int64 | 原VPC OSS APIv2名称: AddService.vport 示例值： 22 |
| UniqueClassicVpcGatewayId | 否 | 否 | String | 原VPC OSS APIv2名称: AddService.uniqClassicVpcgwId 示例值： vpcgw-7hk70tq |
| VpcGatewayAttrFlag | 否 | 否 | Int64 | 原VPC OSS APIv2名称: AddService.bVpcgwAttrFlag 示例值： 0 |
| StickyMaxCount | 否 | 否 | Int64 | 原VPC OSS APIv2名称: AddService.stickyMaxCount 示例值： 0 |
| RouteSet | 否 | 否 | Array of VpcOssRouteForDeleteRouteInternal | 原VPC OSS APIv2名称: AddService.route 示例值：查看 |
| DelPipRouteFlag | 否 | 否 | Int64 | 原VPC OSS APIv2名称: AddService. bDelPipRoute 示例值： 0 |
| VipVpcGatewayId | 否 | 否 | String | 原VPC OSS APIv2名称: AddService.uniqVpcGwIpVpcgwId 示例值： vpcgw-7hk7255d |
| VpcGatewayIp | 否 | 否 | String | 原VPC OSS APIv2名称: AddService.vpcGwIp 示例值： 1.1.1.1 |
| UniqueRouteGroupId | 否 | 否 | String | 原VPC OSS APIv2名称: AddService.uniqRouteGroupId 示例值： vpcgw-7hk7255d |
| CdcFlag | 否 | 否 | Int64 | 原VPC OSS APIv2名称: AddService.bCdc 示例值： 0 |
| UniqueVpcId | 否 | 否 | String | 对外唯一VpcId 示例值： vpc-jmaywf6r |
| RouteGroupFlag | 否 | 否 | Int64 | 原VPC OSS APIv2名称: AddService.routeGroupFlag 示例值： 0 |
| UniqueCdcId | 否 | 否 | String | 原VPC OSS APIv2名称: AddService.uniqCdcId 示例值： cluster-pwqp4055 |
Ipv6SectionSet
ipv6地址池对象
被如下接口引用：DescribeIpv6Section
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| SectionId | 否 | 否 | Uint64 | ipv6地址池唯一ID 示例值： 31 |
| CidrBlock | 否 | 否 | String | IPv6地址池网段 示例值： 3402:4e00:20:1200::/56 |
| AddressType | 否 | 否 | Uint64 | ipv6地址类型 示例值： 0/1 |
| EnableSplit | 否 | 否 | Uint64 | 是否支持自动裂解 示例值： 0:不支持，1:支持自定义 |
Quota
描述配额信息
被如下接口引用：DescribeAddressActionQuota、DescribeAddressQuota、DescribeIp6TranslatorQuota
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| QuotaId | 否 | 否 | String | 配额名称，取值范围：TOTAL_EIP_QUOTA：用户当前地域下EIP的配额数；DAILY_EIP_APPLY：用户当前地域下今日申购次数；DAILY_PUBLIC_IP_ASSIGN：用户当前地域下，重新分配公网 IP次数。示例值： TOTAL_EIP_QUOTA |
| QuotaCurrent | 否 | 否 | Int64 | 当前数量 示例值： 10 |
| QuotaLimit | 否 | 否 | Int64 | 配额数量 示例值： 10 |
| QuotaType | 否 | 是 | String | 配额类型 示例值： 10 |
| DefaultInternetServiceProvider | 否 | 否 | Bool | 默认运营商 示例值： true |
| InstanceId | 否 | 是 | String | 实例 ID 示例值： ins-2dr67vs9 |
| QuotaGroup | 否 | 否 | String | 配额生效的地域。 示例值： sz |
IdcSet
ip6 IDC信息
被如下接口引用：DescribeIp6IdcInfo
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| RegionId | 否 | 否 | Int64 | RegionId 示例值： 50090001 |
| RegionName | 否 | 否 | String | RegionName 示例值： cq |
| ZoneId | 否 | 否 | Int64 | ZoneId 示例值： 50090001 |
| ZoneName | 否 | 否 | String | ZoneName 示例值： cq |
| IdcId | 否 | 否 | Int64 | IdcId 示例值： 50080005 |
| IdcName | 否 | 否 | String | IdcName 示例值： iaasidc |
IKEOptionsSpecification
IKE配置（Internet Key Exchange，因特网密钥交换），IKE具有一套自我保护机制，用户配置网络安全协议
被如下接口引用：CreateVpnConnection、DescribeVpnConnections、ModifyVpnConnectionAttribute
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| PropoEncryAlgorithm | 否 | 否 | String | 加密算法，可选值：'3DES-CBC', 'AES-CBC-128', 'AES-CBS-192', 'AES-CBC-256', 'DES-CBC'，默认为3DES-CBC 示例值： 3DES-CBC |
| PropoAuthenAlgorithm | 否 | 否 | String | 认证算法：可选值：'MD5', 'SHA1'，默认为MD5 示例值： MD5 |
| ExchangeMode | 否 | 否 | String | 协商模式：可选值：'AGGRESSIVE', 'MAIN'，默认为MAIN 示例值： MAIN |
| LocalIdentity | 否 | 否 | String | 本端标识类型：可选值：'ADDRESS', 'FQDN'，默认为ADDRESS 示例值： ADDRESS |
| RemoteIdentity | 否 | 否 | String | 对端标识类型：可选值：'ADDRESS', 'FQDN'，默认为ADDRESS 示例值： ADDRESS |
| LocalAddress | 否 | 否 | String | 本端标识，当LocalIdentity选为ADDRESS时，LocalAddress必填。localAddress默认为vpn网关公网IP 示例值： 1.2.3.4 |
| RemoteAddress | 否 | 否 | String | 对端标识，当RemoteIdentity选为ADDRESS时，RemoteAddress必填 示例值： 4.3.2.1 |
| LocalFqdnName | 否 | 否 | String | 本端标识，当LocalIdentity选为FQDN时，LocalFqdnName必填 示例值： LocalName |
| RemoteFqdnName | 否 | 否 | String | 对端标识，当remoteIdentity选为FQDN时，RemoteFqdnName必填 示例值： RemoteName |
| DhGroupName | 否 | 否 | String | DH group，指定IKE交换密钥时使用的DH组，可选值：'GROUP1', 'GROUP2', 'GROUP5', 'GROUP14', 'GROUP24'， 示例值： GOURP1 |
| IKESaLifetimeSeconds | 否 | 否 | Uint64 | IKE SA Lifetime，单位：秒，设置IKE SA的生存周期，取值范围：60-604800 示例值： 60 |
| IKEVersion | 否 | 否 | String | IKE版本 示例值： 1 |
VpcOssDockerRequest
复杂类型: VpcOssDockerRequest
被如下接口引用：CreateDockerInternal
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Subnet | 否 | 否 | String | 子网地址 示例值： 10.0.0.0 |
| IntMask | 否 | 否 | Int64 | 整数掩码 示例值： 16 |
| UniqueVpcId | 否 | 否 | String | vpc唯一Id 示例值： vpc-7zayowkt |
| VpcId | 否 | 否 | Int64 | 整数vpcId 示例值： 1 |
VpcEndPointServiceUser
终端节点服务的服务白名单对象详情。
被如下接口引用：DescribeVpcEndPointServiceWhiteList
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Owner | 是 | 否 | Uint64 | AppId。 示例值： 1255000100 |
| UserUin | 是 | 否 | String | Uin。 示例值： jkt |
| Description | 是 | 否 | String | 描述信息。 示例值： demo |
| CreateTime | 是 | 否 | String | 创建时间 示例值： 2021-01-14 15:58:40 |
| EndPointServiceId | 是 | 否 | String | 终端节点服务ID。 示例值： vpcsvc-b2mrmmx7 |
LogSetInfo
日志集信息。
被如下接口引用：DescribeLogSet
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| LogSetName | 是 | 否 | String | 日志集名称。 示例值： test_logset |
| LogSetId | 是 | 否 | String | 日志集Id。 示例值： 30a7eae6-48e6-4d25-bf6f-5be3d74a58f6 |
| CreateTime | 是 | 否 | String | 创建时间。 示例值： 2021-07-28 10:09:26 |
PublicAddressAssociationSet
终端节点关联的 弹性公网 信息
被如下接口引用：CreateVpcEndPoint、CreateVpcEndPointService、DescribeVpcEndPoint、DescribeVpcEndPointService
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| PublicIpAddress | 否 | 否 | String | 弹性公网 IP 示例值： 100.123.12.131 |
| AddressId | 否 | 否 | String | 弹性公网ID 示例值： eip-4t7fr3fi |
VpcOssGlobalRoute
复杂类型: VpcOssGlobalRoute
被如下接口引用：DescribeGlobalRouteInternal
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Subnet | 否 | 否 | String | 子网地址 示例值： 100.64.0.0 |
| IntMask | 否 | 否 | Int64 | 整数掩码 示例值： 24 |
| Remote | 否 | 否 | String | 原VPC OSS APIv2名称: GetGlobalRoute.remote 示例值： 172.16.0.2 |
| Master | 否 | 否 | String | 原VPC OSS APIv2名称: GetGlobalRoute.master 示例值： 16.5.3.6 |
| VpcId | 否 | 否 | Int64 | 整数vpcId 示例值： 22 |
TemplateLimit
参数模板配额
被如下接口引用：DescribeTemplateLimits
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| AddressTemplateMemberLimit | 是 | 否 | Uint64 | 参数模板IP地址成员配额。 示例值： 2 |
| AddressTemplateGroupMemberLimit | 是 | 否 | Uint64 | 参数模板IP地址组成员配额。 示例值： 2 |
| ServiceTemplateMemberLimit | 是 | 否 | Uint64 | 参数模板I协议端口成员配额。 示例值： 2 |
| ServiceTemplateGroupMemberLimit | 是 | 否 | Uint64 | 参数模板协议端口组成员配额。 示例值： 2 |
DfwOssAddPolicyToVMRequest
复杂类型: DfwOssAddPolicyToVMRequest
被如下接口引用：AttachPolicyToVMInternal
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| IsTop | 否 | 否 | Bool | 原DFW APIv2名称: addPolicyToVM.isTop 示例值： True |
| Policies | 否 | 否 | Array of DfwOssPolicies | 原DFW APIv2名称: addPolicyToVM.policys 示例值：查看 |
| Uuid | 否 | 否 | String | 原DFW APIv2名称: addPolicyToVM.uuid 示例值： 84f9a2ad-6659-4864-808c-bd17f3c2acea |
EdgeRegion
用于TEZ场景的Region信息
被如下接口引用：DescribeEipRegionInfos
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| RegionId | 是 | 否 | Uint64 | region id 示例值： 1 |
| ShortName | 是 | 否 | String | 地域缩写名称 示例值： gz |
| Name | 是 | 否 | String | 地域全名 示例值： demo |
| AvailableZoneSet | 是 | 否 | Array of EdgeZoneInfo | 可用区列表信息 示例值：查看 |
| Region | 是 | 否 | String | region key 示例值： ap-demo |
AclRuleIdType
本端IP转换ACL规则ID复杂类型
被如下接口引用：DeleteLocalSourceIpPortTranslationAclRule
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| AclRuleId | 是 | 否 | Int64 | 规则ID 示例值： 5 |
VpcOssOverlap
复杂类型: VpcOssOverlap
被如下接口引用：CheckRoutingTableRouteSubnetOverlapInternal
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| VpcId | 否 | 否 | Int64 | 整数vpcId 示例值： 6 |
| UniqueVpcGatewayIndex | 否 | 否 | String | 原VPC OSS APIv2名称: CheckRtbRouteSubnetOverlap.uniqVgwIndex 示例值： pcx-qjtzxwhm |
| Mask | 否 | 否 | String | 掩码 示例值： 255.255.0.0 |
| RoutingTableId | 否 | 否 | Int64 | 原VPC OSS APIv2名称: CheckRtbRouteSubnetOverlap.rtbId 示例值： 29 |
| UniqueRoutingTableId | 否 | 否 | String | 原VPC OSS APIv2名称: CheckRtbRouteSubnetOverlap.uniqRtbId 示例值： rtb-o9u877nw |
| Name | 否 | 否 | String | 名称 示例值： testss2 |
| UniqueVpcId | 否 | 否 | String | 对外唯一VpcId 示例值： vpc-pe0kssdp |
| VirtualGatewayType | 否 | 否 | Int64 | 原VPC OSS APIv2名称: CheckRtbRouteSubnetOverlap.vgwType 示例值： 4 |
| IntMask | 否 | 否 | Int64 | 整数掩码 示例值： 16 |
| VpcGatewayIndex | 否 | 否 | String | 原VPC OSS APIv2名称: CheckRtbRouteSubnetOverlap.vgwIndex 示例值： 19 |
| Owner | 否 | 否 | String | 用户AppId 示例值： toyacao |
| Subnet | 否 | 否 | String | 子网地址 示例值： 10.2.0.0 |
DfwOssDryRunFlowInObjectResult
复杂类型: DfwOssDryRunFlowInObjectResult
被如下接口引用：DescribeDryRunFlowInObjectInternal
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| ObjectCheckResult | 否 | 否 | Array of DfwOssDryRunFlowInObjectCheckResult | check result 示例值：查看 |
| FlowIndex | 否 | 否 | String | flow数组下标 示例值： "0" |
CvmInstance
云主机实例信息。
被如下接口引用：DescribeVpcInstances
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| VpcId | 是 | 否 | String | VPC实例ID。 示例值： vpc-67wlqf6v |
| SubnetId | 是 | 否 | String | 子网实例ID。 示例值： subnet-hj3he929 |
| InstanceId | 是 | 否 | String | 云主机实例ID 示例值： ins-nswq8wkq |
| InstanceName | 是 | 否 | String | 云主机名称。 示例值： demo |
| InstanceState | 是 | 否 | String | 云主机状态。 示例值： RUNNING |
| CPU | 是 | 否 | Uint64 | 实例的CPU核数，单位：核。 示例值： 8 |
| Memory | 是 | 否 | Uint64 | 实例内存容量，单位：GB。 示例值： 32 |
| CreatedTime | 是 | 否 | String | 创建时间。 示例值： 2020-06-08 10:00:00 |
| InstanceType | 是 | 否 | String | 实例机型。 示例值： SA3.2XLARGE32 |
| EniLimit | 是 | 否 | Uint64 | 实例弹性网卡配额（包含主网卡）。 示例值： 6 |
| EniIpLimit | 是 | 否 | Uint64 | 实例弹性网卡内网IP配额（包含主网卡）。 示例值： 20 |
| InstanceEniCount | 是 | 否 | Uint64 | 实例已绑定弹性网卡的个数（包含主网卡）。 示例值： 1 |
AnycastRegionInfo
支持AnycastEIP的地域的信息
被如下接口引用：DescribeAnycastRegion
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Region | 是 | 否 | String | 地域 示例值： ap-region |
| RegionName | 是 | 否 | String | 地域名称 示例值： ap-region |
| RegionState | 是 | 否 | String | 地域当前状态 示例值： Used |
| AnycastZone | 是 | 否 | String | AnycastEIP发布域 示例值： Zone-1 |
VpcNum
vpc数字ID
被如下接口引用：DescribeVpcIds
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| VpcId | 是 | 否 | String | VPC实例ID。 示例值： vpc-napeigw5 |
| VpcNumId | 是 | 否 | Uint64 | VPC实例数字ID。 示例值： 67087 |
VpcOssVpcCidr
复杂类型: VpcOssVpcCidr
被如下接口引用：UpdateVpcAssistCidrInternal
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Owner | 否 | 否 | String | 用户AppId 示例值： 251198225 |
| Subnet | 否 | 否 | String | 子网地址 示例值： 172.16.0.0 |
| IntMask | 否 | 否 | Int64 | 整数掩码 示例值： 20 |
| OperationRouteToVbcFlag | 否 | 否 | Int64 | 原VPC OSS APIv2名称: UpdateVpcAssistCidr.bOpRouteToVbc 示例值： 1 |
| PublishVpgFlag | 否 | 否 | Int64 | 原VPC OSS APIv2名称: bPublishVpg 示例值： 1 |
| VpcId | 否 | 否 | Int64 | 整数vpcId 示例值： 78257 |
| UniqueVpcId | 否 | 否 | String | 对外唯一VpcId 示例值： vpc-fjknwrrj |
EIPIspInfo
EIP运营商信息
被如下接口引用：DescribeEIPIspInfo
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Type | 是 | 否 | String | 运营商类型 CTCC CUCC CMCC BGP 示例值： CTCC |
| Name | 是 | 否 | String | 运营商名称 示例值： ISP Name |
| Id | 否 | 否 | Int64 | 运营商ID。 示例值： 5 |
| IspStatus | 否 | 否 | Int64 | IPv4运营商状态。 示例值： 1 |
| IspStatusIPv6 | 否 | 否 | Int64 | IPv6运营商状态。 示例值： 1 |
| DefaultIsp | 否 | 否 | Int64 | 是否IPv4默认运营商。 示例值： 1 |
| V4Alias | 否 | 是 | String | v4别名 示例值： name |
| V6Alias | 否 | 是 | String | v6别名 示例值： name |
LocalSourceIpPortTranslationAclRuleNeedId
本端源IP端口转换ACL映射规则
被如下接口引用：DescribeLocalSourceIpPortTranslationAclRules、ModifyLocalSourceIpPortTranslationAclRule
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Protocol | 是 | 否 | String | 协议 示例值： tcp |
| SourceCidr | 是 | 否 | String | 源地址 示例值： 1.1.1.0/16 |
| SourcePort | 是 | 否 | String | 源端口 示例值： 80 |
| DestinationCidr | 是 | 否 | String | 目的地址 示例值： 2.2.2.0/16 |
| DestinationPort | 是 | 否 | String | 目的端口 示例值： 80 |
| Action | 否 | 否 | Int64 | 动作，0允许，1拒绝 示例值： 0 |
| AclRuleId | 是 | 否 | Int64 | ACL规则ID 示例值： 100 |
DfwOssInsertUSGRuleRequest
复杂类型: DfwOssInsertUSGRuleRequest
被如下接口引用：CreateUSGRuleInternal
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| UsgId | 否 | 否 | String | 原DFW APIv2名称: insertUSGRule.usgId 示例值： 487487 |
| Index | 否 | 否 | Int64 | 原DFW APIv2名称: insertUSGRule.index 示例值： 1 |
| Direction | 否 | 否 | String | 原DFW APIv2名称: insertUSGRule.direction 示例值： inbound |
| Version | 否 | 否 | Int64 | 原DFW APIv2名称: insertUSGRule.version 示例值： 12 |
| Policies | 否 | 否 | Array of DfwOssUSGPolicyItem | 原DFW APIv2名称: insertUSGRule.policys 示例值：查看 |
BandwidthAttribute
带宽属性
被如下接口引用：DescribeBandwidthAttribute
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| NetworkPayMode | 是 | 是 | Array of String | 网络计费模式列表，取值包括 'BANDWIDTH_POSTPAID_BY_MONTH', 'BANDWIDTH_PREPAID_BY_MONTH', 'TRAFFIC_POSTPAID_BY_HOUR', 'BANDWIDTH_POSTPAID_BY_HOUR', 'BANDWIDTH_PACKAGE' 示例值： TRAFFIC_POSTPAID_BY_HOUR |
| networkPayMode | 否 | 是 | Array of Int64 | 网络计费模式列表。 示例值： TRAFFIC_POSTPAID_BY_HOUR |
| CvmPayMode | 是 | 是 | Array of String | cvm实例计费模式列表，取值包括"PREPAID","POSTPAID_BY_HOUR","CDHPAID"。 示例值： POSTPAID_BY_HOUR |
| cvmPayMode | 否 | 是 | Array of Int64 | cvm实例计费模式列表。 示例值： POSTPAID_BY_HOUR |
| Cpu | 是 | 是 | Array of Int64 | cpu核数范围，前闭后闭区间。如[9,23]表示9 <= cpu核心数 <= 23。空区间表示任意cpu核心数都支持。 示例值： 1 |
| cpu | 否 | 是 | Array of Int64 | cpu核数范围，前闭后闭区间。如[9,23]表示9 <= cpu核心数 <= 23。空区间表示任意cpu核心数都支持。 示例值： 1 |
| ZoneId | 是 | 是 | Array of Int64 | 可用区ID列表。空列表表示任意可用区Id都支持。 示例值： 21 |
| zoneId | 否 | 是 | Array of Int64 | 可用区ID列表。空列表表示任意可用区Id都支持。 示例值： 21 |
| BandwidthUpper | 是 | 否 | Int64 | 带宽最大值 示例值： 200 |
| bandwidthUpper | 否 | 是 | Int64 | 带宽最大值 示例值： 200 |
| BandwidthLimit | 是 | 是 | Int64 | 带宽是否必须有上限。1表示有上限，0表示无上限 示例值： 0 |
| bandwidthLimit | 否 | 是 | Int64 | 带宽是否必须有上限。1表示有上限，0表示无上限 示例值： 0 |
| ResourceIds | 否 | 否 | Array of String | 资源唯一ID列表，可以是云服务器InstanceId，或者弹性公网IP唯一ID 示例值： eip-d97psd1o |
SecurityGroup
安全组对象
被如下接口引用：CloneSecurityGroup、CreateDefaultSecurityGroup、CreateSecurityGroup、CreateSecurityGroupWithPolicies、DescribeSecurityGroups
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| ProjectId | 否 | 否 | String | 项目id，默认0。可在控制台项目管理页面查询到。 示例值： 0 |
| SecurityGroupId | 是 | 否 | String | 安全组实例ID，例如：sg-ohuuioma。 示例值： sg-05bb4upy |
| SecurityGroupName | 是 | 否 | String | 安全组名称，可任意命名，但不得超过60个字符。 示例值： demoGroup |
| SecurityGroupDesc | 是 | 否 | String | 安全组备注，最多100个字符。 示例值： demo-group-desc |
| IsDefault | 否 | 否 | Bool | 是否是默认安全组，默认安全组不支持删除。 示例值： false |
| CreatedTime | 否 | 否 | String | 安全组创建时间。 示例值： 2017-04-18 21:02:30 |
| TagSet | 否 | 否 | Array of Tag | 标签键值对。 示例值：查看 |
| UpdateTime | 否 | 否 | String | 安全组更新时间。 示例值： 2017-04-18 21:02:30 |
| Region | 否 | 否 | String | 地域。 示例值： sz |
UpdateVpcAssistCidrResult
更新vpc的辅助CIDR结果
被如下接口引用：UpdateVpcAssistCidrInternal
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| NewAfcFlag | 是 | 否 | Int64 | 原bNewAfc 示例值： 1 |
| CreateTime | 是 | 否 | String | 原createTime 示例值： 2021-05-17 19:55:20 |
| OwnedFlag | 是 | 否 | Int64 | 原ownrdFlag 示例值： 0 |
| OldOperationRouteToVbcFlag | 是 | 否 | Int64 | 原oldBOpRouteToVbc 示例值： 0 |
| VpcId | 是 | 否 | Int64 | 原vpcId 示例值： 16769060 |
| UniqueVpcId | 是 | 否 | String | 原uniqVpcId 示例值： vpc-7zayowkt |
| VpgId | 是 | 否 | Int64 | 原vpgId 示例值： 53786 |
| Owner | 是 | 否 | String | 原owner 示例值： 251197522 |
| IntMask | 是 | 否 | Int64 | 原intMask 示例值： 16 |
| OperationRouteToVbcFlag | 是 | 否 | Int64 | 原bOpRouteToVbc 示例值： 1 |
| VpcSubnet | 是 | 否 | String | 原vpcSubnet 示例值： 10.0.0.0 |
| ZoneVpgFlag | 是 | 否 | Int64 | 原bZoneVpg 示例值： 0 |
| OldPublishVpgFlag | 是 | 否 | Int64 | 原oldBPublishVpg 示例值： 1 |
| VpcAssistCidrId | 是 | 否 | Int64 | 原vpcAssistCidrId 示例值： 22811 |
| AssistType | 是 | 否 | Int64 | 原assistType 示例值： 0 |
| Subnet | 是 | 否 | String | 原subnet 示例值： 10.4.0.0 |
| Mask | 是 | 否 | String | 原mask 示例值： 255.255.0.0 |
| VpcIntMask | 是 | 否 | Int64 | 原vpcIntMask 示例值： 16 |
PublicEndPointService
公共终端节点服务信息
被如下接口引用：DescribePublicEndPointServices
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| EndPointServiceName | 是 | 是 | String | 终端节点服务名称。 示例值： name1 |
| EndPointServiceBusinessType | 是 | 是 | String | COS 示例值： COS |
| IpAddressType | 否 | 否 | String | 协议类型，支持 Ipv4，Ipv6。 示例值： Ipv4 |
| CreateTime | 否 | 否 | String | 创建时间。格式：YYYY-MM-DD HH:MM:SS。 示例值： 2018-04-03 15:00:00 |
| EndPointServiceId | 是 | 否 | String | 终端节点服务唯一ID 示例值： vpcsvc-pnpcflil |
EdgeZoneInfo
eip边缘可用区信息
被如下接口引用：DescribeEipRegionInfos
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| BusinessType | 是 | 是 | String | 表示可用区可部署的业务类型：DC-中心可用区，TEZ，EZ，SOC等 示例值： DC |
| Provider | 是 | 是 | Array of String | 支持的运营商类型列表：CMCC，CTCC，CUCC 示例值： - |
| NetworkEgressName | 是 | 是 | String | 网络出口名称 示例值： demo边缘出口 |
| Zone | 是 | 否 | String | 可用区key值 示例值： ap-demo-3 |
| ZoneName | 是 | 否 | String | 可用区名称 示例值： demo三区 |
| ZoneId | 是 | 否 | Uint64 | 可用区id 示例值： 200003 |
| ZoneState | 是 | 否 | String | 可用区状态：可用/不可用 示例值： AVAILABLE |
| Area | 是 | 是 | String | 可用区所属地域 示例值： demo |
| NetworkGroup | 否 | 是 | String | 网络组标识。 示例值： ap-region |
| NetworkEgressSet | 否 | 是 | Array of String | 网络出口列表。 示例值： ["demo-egress"] |
Ipv6SubnetCidrBlock
IPv6子网段对象。
被如下接口引用：AssignIpv6SubnetCidrBlock、UnassignIpv6SubnetCidrBlock
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| SubnetId | 是 | 否 | String | 子网实例ID。形如：subnet-pxir56ns。示例值： subnet-8qywqc4y |
| Ipv6CidrBlock | 否 | 否 | String | IPv6子网段。形如：3402:4e00:20:1001::/64示例值： 3402:4e00:20:1200::/56 |
| AddressType | 否 | 否 | String | IPv6地址类型 示例值： GUA |
| ISPType | 否 | 否 | String | IPv6 Cidr所属运营商类型，支持的类型有 'BGP'-默认, 'CMCC'-移动, 'CTCC'-电信, 'CUCC'-联调 示例值： BGP |
FlowLogStorage
流日志存储信息
被如下接口引用：CreateAndAttachNetworkInterface、CreateNetworkInterface、DeleteNetworkInterfaces、DescribeFlowLogs、DescribeNetworkInterfaces、DescribeNetworkInterfacesEx、DescribeNetworkInterfacesExtra
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| StorageId | 是 | 否 | String | 存储实例Id，当流日志存储类型为ckafka时，必填。 示例值： ckafka-aso1kaoq |
| StorageTopic | 否 | 否 | String | 主题Id，当流日志存储类型为ckafka时，必填。 示例值： topic-asow02oa |
DfwOssDelAddrFromSvcResult
复杂类型: DfwOssDelAddrFromSvcResult
被如下接口引用：UpdateUsgOfSvcInternal
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| SvcId | 否 | 否 | String | 原DFW APIv2名称: updateUsgOfSvc.svcid 示例值： 78202_12.2.2.3_3600_0 |
| ErrorCode | 否 | 否 | Int64 | 原DFW APIv2名称: updateUsgOfSvc.errorCode 示例值： 0 |
| ErrorInfo | 否 | 否 | String | 原DFW APIv2名称: updateUsgOfSvc.errorInfo 示例值： success |
Ip6RuleInfo
IPV6转换规则
被如下接口引用：AddIp6Rules
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Vport6 | 是 | 否 | Int64 | IPV6端口号，可在0~65535范围取值 示例值： 80 |
| Protocol | 是 | 否 | String | 协议类型，支持TCP/UDP 示例值： TCP |
| Vip | 是 | 否 | String | IPV4地址 示例值： 172.0.0.0 |
| Vport | 是 | 否 | Int64 | IPV4端口号，可在0~65535范围取值 示例值： 80 |
ProductQuota
描述网络中心每个产品的配额信息
被如下接口引用：DescribeProductQuota
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| QuotaName | 是 | 否 | String | 产品配额名称 示例值： 每个开发商可创建的VPC数 |
| QuotaCurrent | 是 | 否 | Int64 | 产品当前配额 示例值： 10 |
| QuotaLimit | 是 | 否 | Int64 | 产品配额上限 示例值： 100 |
| QuotaRegion | 是 | 否 | Bool | 产品配额是否有地域属性 示例值： True |
| QuotaId | 是 | 否 | String | 产品配额ID 示例值： 0 |
NewRouteSet
新的路由名称
被如下接口引用：ReplaceRoutes
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| RouteId | 否 | 否 | Uint64 | 路由Id 示例值： 16820 |
| DestinationCidrBlock | 否 | 否 | String | 目的网段 示例值： 169.254.128.0/17 |
| GatewayType | 否 | 否 | String | 网关类型 示例值： NORMAL_CVM |
| GatewayId | 否 | 否 | String | 网关Id 示例值： 172.16.16.37 |
| RouteDescription | 否 | 否 | String | 路由描述 示例值： demo |
| DestinationIpv6CidrBlock | 否 | 否 | String | 创建IPv6目的网段，取值不能在私有网络网段内，例如：2402:4e00:1000:810b::/64。 示例值： 3402:4e00:20:1200::/56 |
| RouteItemId | 否 | 否 | String | 路由唯一策略ID。 示例值： rti-9bjer08h |
| CreatedTime | 否 | 否 | String | 路由策略创建时间 示例值： 2021-03-02 14:41:15 |
| RouteTableId | 否 | 否 | String | rtb-azd4dt1c 示例值： 路由表实例ID，例如：rtb-azd4dt1c。 |
| PublishedToVbc | 否 | 否 | Bool | 路由策略是否发布到云联网。该字段仅做出参使用，作为入参字段时此参数不生效。 示例值： true |
TrafficMirrorTarget
流量镜像采集目标类型
被如下接口引用：CreateTrafficMirror、DescribeTrafficMirrors、ResetTrafficMirrorTarget
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| TargetIps | 是 | 否 | Array of String | 流量镜像的接收IP 示例值： ["10.0.0.0"] |
| AlgHash | 是 | 否 | String | 流量镜像接收IP组，均衡规则，支持ENI/FIVE_TUPLE_FLOW 示例值： FIVE_TUPLE_FLOW |
EndPointService
终端节点服务对象。
被如下接口引用：CreateVpcEndPointService、DescribeVpcEndPointService
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| EndPointServiceId | 是 | 否 | String | 终端节点服务ID 示例值： vpcsvc-demoag78 |
| VpcId | 是 | 否 | String | VPCID。 示例值： vpc-gjui0b5t |
| ServiceOwner | 是 | 否 | String | APPID。 示例值： 251007979 |
| ServiceName | 是 | 否 | String | 终端节点服务名称。 示例值： demo |
| ServiceVip | 是 | 否 | String | 后端服务的VIP。 示例值： 10.1.1.1 |
| ServiceInstanceId | 是 | 否 | String | 后端服务的ID，比如lb-xxx。 示例值： lb-was1d32s |
| AutoAcceptFlag | 是 | 否 | Bool | 是否自动接受。 示例值： True |
| EndPointCount | 是 | 是 | Uint64 | 关联的终端节点个数。 示例值： 0 |
| EndPointSet | 是 | 是 | Array of EndPoint | 终端节点对象数组。 示例值：查看 |
| CreateTime | 是 | 否 | String | 创建时间。 示例值： 2018-06-21 11:32:29 |
| IpAddressType | 否 | 否 | String | IP地址类型 示例值： IPv4/IPv6 |
| TagSet | 否 | 否 | Array of Tag | 标签信息 示例值：查看 |
| ServiceType | 否 | 否 | String | 挂载的PAAS服务类型，CLB（负载均衡），CDB（云数据库 MySQL），CRS（云数据库 Redis），GWLB（网关负载均衡）。 示例值： CRS |
| Region | 否 | 否 | String | 地域信息 示例值： city |
| CdcId | 否 | 否 | String | CDC 集群唯一 ID 示例值： cluster-d8htgb6k |
SecurityPolicyDatabase
SecurityPolicyDatabase策略
被如下接口引用：CreateVpnConnection、DescribeVpnConnections、ModifyVpnConnectionAttribute
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| LocalCidrBlock | 是 | 否 | String | 本端网段 示例值： 11.0.0.0/8 |
| RemoteCidrBlock | 是 | 否 | Array of String | 对端网段 示例值： 11.0.0.0/8 |
DfwOssUSGPolicyItem
复杂类型: DfwOssUSGPolicyItem
被如下接口引用：CreateUSGRuleInternal、DescribeUSGPolicyInternal
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| ServiceModule | 否 | 是 | String | 原DFW APIv2名称: getUSGPolicy.serviceModule 示例值： ppm-ni1v9ozg |
| AddressModule | 否 | 是 | String | 原DFW APIv2名称: getUSGPolicy.addressModule 示例值： ipmg-liaueln6 |
| Id | 否 | 是 | String | 原DFW APIv2名称: getUSGPolicy.id 示例值： sg-e5qrs5d9 |
| ModifyTime | 否 | 是 | String | 原DFW APIv2名称: getUSGPolicy.modifytime 示例值： 2022-06-21 10:46:42 |
| Desc | 否 | 是 | String | 原DFW APIv2名称: getUSGPolicy.desc 示例值： test |
| Action | 否 | 否 | String | 原DFW APIv2名称: getUSGPolicy.action 示例值： ACCEPT |
| Ip | 否 | 是 | String | 原DFW APIv2名称: getUSGPolicy.ip 示例值： 10.0.0.0/8 |
| Protocol | 否 | 是 | String | 原DFW APIv2名称: getUSGPolicy.protocol 示例值： tcp |
| Port | 否 | 是 | String | 原DFW APIv2名称: getUSGPolicy.port 示例值： 80 |
ResourceStatistics
资源统计信息
被如下接口引用：DescribeFlowLogs、DescribeSubnetResourceDashboard
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| VpcId | 是 | 否 | String | Vpc实例ID，例如：vpc-f1xjkw1b。 示例值： vpc-pnpcflil |
| SubnetId | 是 | 否 | String | 子网实例ID，例如：subnet-bthucmmy。 示例值： subnet-nswq8wkq |
| Ip | 是 | 否 | Uint64 | 当前已使用的IP总数。 示例值： 100 |
| ResourceStatisticsItemSet | 是 | 否 | Array of ResourceStatisticsItem | 资源统计信息。 示例值：查看 |
DellRoute
删除路由策略对象
被如下接口引用：DeleteRoutes
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| RouteId | 否 | 否 | Uint64 | 路由对象 示例值： 167 |
| RouteDescription | 否 | 否 | String | 路由策略描述。 示例值： demo |
| Enabled | 否 | 否 | Bool | 是否启用 示例值： true |
| RouteType | 否 | 否 | String | 路由类型，目前我们支持的类型有：USER：用户路由；NETD：网络探测路由，创建网络探测实例时，系统默认下发，不可编辑与删除；CCN：云联网路由，系统默认下发，不可编辑与删除。用户只能添加和操作 USER 类型的路由。 示例值： NETD |
| RouteTableId | 否 | 否 | String | 路由表实例ID，例如：rtb-azd4dt1c。 示例值： rtb-azd4dt1c |
| RouteItemId | 否 | 否 | String | 路由策略字符串ID。 示例值： rule-azd4dt1c |
IPSECOptionsSpecification
IPSec配置，IPSec安全会话设置
被如下接口引用：CreateVpnConnection、DescribeVpnConnections、ModifyVpnConnectionAttribute
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| EncryptAlgorithm | 否 | 否 | String | 加密算法，可选值：'3DES-CBC', 'AES-CBC-128', 'AES-CBC-192', 'AES-CBC-256', 'DES-CBC', 'NULL'， 默认为AES-CBC-128 示例值： AES-CBC-128 |
| IPSECSaLifetimeSeconds | 否 | 否 | Uint64 | IPsec SA lifetime(s)：单位秒，取值范围：180-604800 示例值： 180 |
| PfsDhGroup | 否 | 否 | String | PFS：可选值：'NULL', 'DH-GROUP1', 'DH-GROUP2', 'DH-GROUP5', 'DH-GROUP14', 'DH-GROUP24'，默认为NULL 示例值： NULL |
| IPSECSaLifetimeTraffic | 否 | 否 | Uint64 | IPsec SA lifetime(KB)：单位KB，取值范围：2560-604800 示例值： 2560 |
| IntegrityAlgorithm | 否 | 是 | String | 认证算法：可选值：'MD5', 'SHA1'，默认为 示例值： SHA1 |
DfwOssUSG
复杂类型: DfwOssUSG
被如下接口引用：DescribeUSGFromSvcInternal、DescribeUSGInternal
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| SafeGroupId | 否 | 否 | String | 原VPC OSS APIv2名称: getUSGById.sgId 示例值： sg-5q4brrmt |
| Os | 否 | 否 | Int64 | 原VPC OSS APIv2名称: getUSGById.os 示例值： 0 |
| Sys | 否 | 否 | Int64 | 原VPC OSS APIv2名称: getUSGById.sys 示例值： 0 |
| CreateTime | 否 | 是 | String | 原VPC OSS APIv2名称: getUSGById.createTime 示例值： 2021-12-08 21:00:33 |
| SgRemark | 否 | 否 | String | 原VPC OSS APIv2名称: getUSGById.sgRemark 示例值： 自定义 |
| UpdateTime | 否 | 是 | String | 原VPC OSS APIv2名称: getUSGById. updateTime 示例值： 2021-12-08 21:00:33 |
| SgId | 否 | 是 | String | 用户AppId 示例值： 251197522 |
| ProjectId | 否 | 否 | String | 原VPC OSS APIv2名称: getUSGById.projectId 示例值： 0 |
| SgName | 否 | 否 | String | 原VPC OSS APIv2名称: getUSGById.sgName 示例值： test_all |
| ErrorCode | 否 | 否 | Int64 | 原VPC OSS APIv2名称: getUSGById.errorCode 示例值： 0 |
| AppId | 否 | 否 | String | 原VPC OSS APIv2名称: getUSGById.appId 示例值： 251197522 |
DfwOssDelSvcAddrFromUSGResult
复杂类型: DfwOssDelSvcAddrFromUSGResult
被如下接口引用：DeleteSvcAddrFromUSGInternal
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| ErrorCode | 否 | 否 | Int64 | 原DFW APIv2名称: addSvcAddrToUSG.errorCode 示例值： 0 |
| ErrorInfo | 否 | 否 | String | 原DFW APIv2名称: addSvcAddrToUSG.errorInfo 示例值： success |
LocalSourceIpPortTranslationNatRule
专线网关本端源IP端口NAT映射地址池
被如下接口引用：CreateLocalSourceIpPortTranslationNatRule、DeleteLocalSourceIpPortTranslationNatRule、DescribeLocalSourceIpPortTranslationNatRules、ModifyLocalSourceIpPortTranslationNatRule
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| IpPool | 是 | 否 | String | IP地址池 示例值： 2.2.2.2/16 |
| Description | 是 | 否 | String | 描述 示例值： for_demo |
MemberInfo
模板对象成员信息
被如下接口引用：AddTemplateMember、DeleteTemplateMember、ModifyTemplateMember
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Member | 是 | 否 | String | 模板对象成员 示例值： ipm-h0fk8lfc |
| Description | 否 | 否 | String | 模板对象成员描述信息 示例值： demo |
NatRegionInfoWithArea
NAT地域地区对象
被如下接口引用：DescribePrivateNatGatewayRegions
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Region | 是 | 否 | String | 地域ID，如：ap-region。 示例值： ap-region |
| RegionId | 是 | 否 | Uint64 | 地域数字ID。 示例值： 1 |
| ShortName | 是 | 否 | String | 地域简称，如：gz。 示例值： gz |
| Name | 是 | 否 | String | 地域名称，如：region。 示例值： region |
| IsChinaMainland | 是 | 否 | Bool | 是否大陆地域。 示例值： true |
| IsFinance | 是 | 否 | Bool | 是否金融地域。 示例值： true |
| NatProductVersion | 是 | 否 | Uint64 | NAT大版本号，如：2。 示例值： 2 |
| Area | 是 | 否 | String | 地区名称， 如：region地区 示例值： region地区 |
LocalSourceIpPortTranslationAclRule
本端源IP端口转换ACL映射规则
被如下接口引用：CreateLocalSourceIpPortTranslationAclRule
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Protocol | 是 | 否 | String | 协议 示例值： tcp |
| SourceCidr | 是 | 否 | String | 源地址 示例值： 1.1.1.0/16 |
| SourcePort | 是 | 否 | String | 源端口 示例值： 80 |
| DestinationCidr | 是 | 否 | String | 目的地址 示例值： 2.2.2.0/16 |
| DestinationPort | 是 | 否 | String | 目的端口 示例值： 80 |
| Action | 否 | 否 | Int64 | 动作，0允许，1拒绝 示例值： 0 |
ReferredSecurityGroup
安全组被引用信息
被如下接口引用：DescribeSecurityGroupReferences
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| SecurityGroupId | 是 | 否 | String | 安全组实例ID。 示例值： sg-pnpcflil |
| ReferredSecurityGroupIds | 是 | 否 | Array of String | 引用安全组实例ID（SecurityGroupId）的所有安全组实例ID。 示例值： ["sg-nswq8wkq"] |
DfwOssUpdateUsgOfSvcAddrResult
复杂类型: DfwOssUpdateUsgOfSvcAddrResult
被如下接口引用：UpdateUsgOfSvcAddrInternal
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| SvcAddrId | 否 | 否 | String | 原DFW APIv2名称: updateUsgOfSvcAddr.svcAddrId 示例值： 76084_10.1.2.16_27017_6 |
| ErrorCode | 否 | 否 | Int64 | 原DFW APIv2名称: updateUsgOfSvcAddr.errorCode 示例值： 0 |
| ErrorInfo | 否 | 否 | String | 原DFW APIv2名称: updateUsgOfSvcAddr.errorInfo 示例值： success |
AddressChargePrepaid
用于描述弹性公网IP的费用对象
被如下接口引用：AllocateAddresses、InquiryPriceAllocateAddresses
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Period | 是 | 否 | Int64 | 购买实例的时长 示例值： 0 |
| RenewFlag | 否 | 否 | String | 自动续费标志 示例值： AutoRenewFlag |
SubnetInput
子网对象
被如下接口引用：CreateSubnets
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| CidrBlock | 是 | 否 | String | 子网的CIDR。示例值： 192.241.0.0/24 |
| SubnetName | 是 | 否 | String | 子网名称。 示例值： demo |
| Zone | 是 | 否 | String | 可用区。形如：ap-region-2。示例值： 50001 |
| RouteTableId | 否 | 否 | String | 指定关联路由表，形如：rtb-3ryrwzuu。示例值： rtb-q8o2z892 |
| Type | 否 | 否 | Uint64 | 指定需要创建的子网类型 示例值： 0 |
RouteTable
路由表对象
被如下接口引用：CreateIpv6Routes、CreateRouteTable、CreateRoutes、DescribeRouteTables
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| VpcId | 是 | 否 | String | VPC实例ID。 示例值： vpc-m0c2kcun |
| RouteTableId | 是 | 否 | String | 路由表实例ID，例如：rtb-azd4dt1c。 示例值： rtb-32kbqgtm |
| RouteTableName | 是 | 否 | String | 路由表名称。 示例值： ruby |
| AssociationSet | 是 | 否 | Array of RouteTableAssociation | 路由表关联关系。 示例值：查看 |
| RouteSet | 是 | 否 | Array of Route | 路由表策略集合。 示例值：查看 |
| Main | 是 | 否 | Bool | 是否默认路由表。 示例值： True |
| Visible | 否 | 否 | Bool | 是否可见。。 示例值： True |
| CreatedTime | 否 | 否 | String | 创建时间。 示例值： 2010-11-21 |
| TagSet | 否 | 否 | Array of Tag | 标签键值对。 示例值：查看 |
| SubnetNum | 否 | 是 | Uint64 | 子网数 示例值： 4 |
| Region | 否 | 否 | String | 地域。 示例值： sz |
| LocalCidrBlocks | 否 | 否 | Array of String | local路由。 示例值： ["10.0.0.0/16"] |
| SpecialAssociationSet | 否 | 否 | Array of SpecialRouteTableAssociation | 特殊子网绑定的路由表。 示例值：查看 |
| LocalCidrForCcn | 否 | 否 | Array of CidrForCcn | local路由是否发布云联网。 示例值：查看 |
| RoutePolicyAssociationSet | 否 | 否 | Array of RoutePolicyAssociation | 路由接收策略绑定。 示例值：查看 |
VpcExtendCidr
vpc扩展的CIDR
被如下接口引用：DescribeVpcExtendCidrs
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| VpcId | 是 | 否 | String | vpcId 示例值： vpc-67wlqf6v |
| CidrBlock | 是 | 否 | String | CIDR 示例值： 192.241.0.0/24 |
| CreateTime | 是 | 否 | Date | 创建时间 示例值： 2018-06-21 11:32:29 |
Ipv6VpcSet
IPv6地址池信息
被如下接口引用：DescribeIpv6Vpc
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| SectionId | 否 | 否 | Uint64 | 所属的Ipv6地址池ID 示例值： 1 |
| CidrBlock | 否 | 否 | String | IPv6地址段 示例值： 3402:4e00:20:1200::/56 |
| AddressType | 否 | 否 | Uint64 | ipv6地址类型 示例值： 0/1 |
| EnableSplit | 否 | 否 | Uint64 | 是否支持自动裂解 示例值： 0:不支持，1:支持自定义 |
| Flag | 否 | 否 | Uint64 | 是否空闲 示例值： |
| Description | 否 | 否 | String | 描述信息。 示例值： |
HaVip
描述 HAVIP 信息
被如下接口引用：CreateHaVip、DescribeHaVips
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Vip | 是 | 否 | String | 虚拟IP地址。 示例值： 10.0.0.10 |
| VpcId | 是 | 否 | String | HAVIP所在私有网络ID。示例值： vpc-hj3he929 |
| Visible | 否 | 否 | Bool | 表示该 HAVIP 是否对租户可见。 示例值： True |
| CdcId | 否 | 否 | String | CDC实例ID。 示例值： cluster-gbo27yc4 |
| HaVipId | 是 | 否 | String | HAVIP的ID，是HAVIP的唯一标识。示例值： havip-nswq8wkq |
| CreatedTime | 是 | 否 | Datetime | 创建时间。 示例值： 2018-10-10 17:03:09 |
| TagSet | 否 | 否 | Array of Tag | 标签键值对。 示例值：查看 |
| HaVipName | 是 | 否 | String | HAVIP名称。示例值： demo |
| SubnetId | 是 | 否 | String | HAVIP所在子网ID。示例值： subnet-4t7fr3fi |
| NetworkInterfaceId | 是 | 否 | String | HAVIP关联弹性网卡ID。示例值： eni-pnpcflil |
| InstanceId | 是 | 否 | String | 被绑定的实例ID。示例值： ins-kngiybxl |
| State | 是 | 否 | String | 状态：AVAILABLE：运行中UNBIND：未绑定示例值： AVAILABLE |
| HaVipAssociationSet | 否 | 否 | Array of HaVipAssociation | HAVIP的飘移范围。示例值：查看 |
| CheckAssociate | 否 | 否 | Bool | 是否开启HAVIP的飘移范围校验。示例值： True |
| AddressIp | 是 | 否 | String | 绑定EIP。示例值： 100.10.487.131 |
| Business | 是 | 否 | String | 使用havip的业务标识。 示例值： SCF |
| FlushedTime | 否 | 否 | String | HAVIP 刷新时间。该参数只作为出参数。以下场景会触发 FlushTime 被刷新：1）子机发出免费 ARP 触发 HAVIP 漂移；2）手动HAVIP解绑网卡; 没有更新时默认值：0000-00-00 00:00:00 示例值： 2024-06-06 22:24:45 |
| Ipv6Vip | 否 | 否 | String | 虚拟IPv6地址。 示例值： 240d:c000:f030:900:0:9d0b:92a5:af00 |
| IfnName | 否 | 否 | String | 网卡接口名称。 示例值： veth_21CF51f0 |
| IsCdc | 否 | 否 | Bool | 是否是cdc类型的 havip 示例值： false |
| Type | 否 | 否 | String | HAVIP类型。取值: NORMAL(普通，默认值); GWLB(网关负载均衡); OPTIMIZATION(优化模式)。 示例值： NORMAL |
| AddressIpv6 | 否 | 否 | String | ipv6地址 示例值： 2011:db8:abcd:1d00:6:47c8:5567:ee69 |
| WanType | 否 | 否 | String | 0:NAT 模式下，EIP 在本地不可见, 云服务器内无法查看公网 IP ,1:EIP 直通后，EIP 在本地可见 示例值： 0 |
| IpAddressType | 否 | 否 | String | 地址类型 示例值： Ipv4 |
EndPoint
终端节点详情。
被如下接口引用：CreateVpcEndPoint、CreateVpcEndPointService、DescribeVpcEndPoint、DescribeVpcEndPointService
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| EndPointId | 是 | 否 | String | 终端节点ID。 示例值： vpce-7czfogk8 |
| VpcId | 是 | 否 | String | VPCID。 示例值： vpc-67wlqf6v |
| SubnetId | 是 | 否 | String | 子网ID。 示例值： subnet-8qywqc4y |
| EndPointOwner | 是 | 否 | String | APPID。 示例值： jkt45567 |
| EndPointName | 是 | 否 | String | 终端节点名称。 示例值： demo |
| ServiceVpcId | 是 | 否 | String | 终端节点服务的VPCID。 示例值： vpc-67wlqf6v |
| ServiceVip | 是 | 否 | String | 终端节点服务的VIP。 示例值： 10.23.11.12 |
| EndPointServiceId | 是 | 否 | String | 终端节点服务的ID。 示例值： vpcsvc-demoag78 |
| EndPointVip | 是 | 否 | String | 终端节点的VIP。 示例值： 10.23.11.12 |
| State | 是 | 否 | String | 终端节点状态，ACTIVE：可用，PENDING：待接受，ACCEPTING：接受中，REJECTED：已拒绝，FAILED：失败。 示例值： 0/1/2/3/4 |
| CreateTime | 是 | 否 | String | 创建时间。 示例值： 2018-06-21 11:32:29 |
| GroupSet | 否 | 否 | Array of String | 终端节点绑定的安全组实例ID列表。 示例值： ['sg-demoag78'] |
| ServiceName | 否 | 否 | String | 终端节点服务名称。 示例值： demo |
| IpAddressType | 否 | 否 | String | IP地址类型 示例值： IPv4/IPv6 |
| TagSet | 否 | 否 | Array of Tag | 标签信息 示例值：查看 |
| IsFreeEndPoint | 否 | 否 | Bool | 是否免费 示例值： False |
| EnableJumbo | 否 | 否 | Bool | 是否开启巨帧转发，false（默认）：否，true：是。 示例值： False |
| ServiceUin | 否 | 否 | String | 服务账号信息 示例值： 592383020 |
| EndPointServiceType | 否 | 否 | String | 终端节点关联的终端节点服务类型。 示例值： GWLB |
| AddressId | 否 | 否 | String | 关联弹性公网的ID 示例值： eip-tyhgrwet |
| CdcId | 否 | 否 | String | cluster-d8htgb6k 示例值： CDC 集群唯一 ID |
| PublicIpAddress | 否 | 否 | String | 关联弹性公网的IP 示例值： 100.123.12.131 |
| EndPointUin | 否 | 否 | String | 终端节点账号信息 示例值： 58372332 |
| Region | 否 | 否 | String | 地域信息 示例值： city |
| TargetFaultAction | 否 | 否 | String | 适用于 gwlb类型的终端节点，支持选项'Drop'，'Bypass'。 示例值： Bypass |
| PublicAddressAssociationSet | 否 | 否 | Array of PublicAddressAssociationSet | 终端节点关联的 弹性公网 信息 示例值：查看 |
VpcOssRoutingTable
复杂类型: VpcOssRoutingTable
被如下接口引用：DescribeRoutingTableListDetailInternal
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| VpcDefaultFlag | 否 | 否 | Int64 | 原VPC OSS APIv2名称: GetRtbListDetail.vpcBDefault 示例值： 1 |
| Subnet | 否 | 否 | Array of VpcOssSubnet | 子网地址 示例值：查看 |
| Name | 否 | 否 | String | 名称 示例值： default |
| UniqueVpcId | 否 | 否 | String | 对外唯一VpcId 示例值： vpc-jmaywf6r |
| RoutingTableId | 否 | 否 | Int64 | 原VPC OSS APIv2名称: GetRtbListDetail.rtbId 示例值： 213266 |
| RouterId | 否 | 否 | Int64 | 原VPC OSS APIv2名称: GetRtbListDetail.routerId 示例值： 196826 |
| SubnetNum | 否 | 否 | Int64 | 原VPC OSS APIv2名称: GetRtbListDetail.subnetNum 示例值： 1 |
| UniqueRouterId | 否 | 否 | String | 原VPC OSS APIv2名称: GetRtbListDetail.uniqRouterId 示例值： router-omlmjmr6 |
| Owner | 否 | 否 | String | 用户AppId 示例值： 251198225 |
| UniqueRoutingTableId | 否 | 否 | String | 原VPC OSS APIv2名称: GetRtbListDetail.uniqRtbId 示例值： rtb-c6mxqnvy |
| Type | 否 | 否 | Int64 | 原VPC OSS APIv2名称: GetRtbListDetail.type 示例值： 1 |
| CreateTime | 否 | 否 | String | 原VPC OSS APIv2名称: GetRtbListDetail.createTime 示例值： 2021-03-22 20:59:55 |
| VpcId | 否 | 否 | Int64 | 整数vpcId 示例值： 78257 |
| VpcIntMask | 否 | 否 | Int64 | 原VPC OSS APIv2名称: GetRtbListDetail.vpcIntMask 示例值： 16 |
| VpcMask | 否 | 否 | String | 原VPC OSS APIv2名称: GetRtbListDetail.vpcMask 示例值： 255.255.0.0 |
| VpcSubnet | 否 | 否 | String | 原VPC OSS APIv2名称: GetRtbListDetail.vpcSubnet 示例值： 172.16.0.0 |
| VpcName | 否 | 否 | String | 原VPC OSS APIv2名称: GetRtbListDetail.vpcName 示例值： Default-VPC |
RouteConflict
路由冲突对象
被如下接口引用：DescribeRouteConflicts
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| RouteTableId | 是 | 否 | String | 路由表实例ID，例如：rtb-azd4dt1c。 示例值： rtb-q8o2z892 |
| DestinationCidrBlock | 是 | 否 | String | 要检查的与之冲突的目的端 示例值： 192.241.0.0/24 |
| ConflictSet | 是 | 否 | Array of Route | 冲突的路由策略列表 示例值：查看 |
AddressInfo
IP地址模板信息
被如下接口引用：CreateAddressTemplate、DescribeAddressTemplates
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Address | 是 | 否 | String | ip地址。 示例值： 2.2.2.2 |
| Description | 否 | 否 | String | 备注。 示例值： desc |
| UpdatedTime | 否 | 否 | String | 更新时间。 示例值： 2020-08-10 18:10:12 |
SnapshotFileInfo
快照文件信息
被如下接口引用：DescribeSnapshotFiles
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| BackupTime | 是 | 否 | String | 备份时间。 示例值： 2021-03-02 14:41:15 |
| Operator | 是 | 否 | String | 操作者Uin。 示例值： 487445567 |
| SnapshotPolicyId | 是 | 否 | String | 快照策略Id。 示例值： sspolicy-hx8an9sr |
| InstanceId | 是 | 否 | String | 实例Id。 示例值： sg-qwmk1q |
| SnapshotFileId | 是 | 否 | String | 快照文件Id。 示例值： ssfile-rnhdyl67 |
RoutePolicyAssociation
路由接收策略绑定。用来绑定路由表和路由接收策略以及绑定的优先级。
被如下接口引用：CreateIpv6Routes、CreateRoutePolicyAssociations、CreateRouteTable、CreateRoutes、DescribeRoutePolicies、DescribeRouteTables
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| RoutePolicyId | 否 | 否 | String | 路由接收策略唯一ID。 示例值： rrp-r70ctaia |
| Priority | 否 | 否 | Uint64 | 优先级。 示例值： 100 |
| RouteTableId | 否 | 否 | String | 路由表唯一ID。 示例值： rtb-qk8eyn9g |
NetworkInterfaceAttachment
弹性网卡绑定关系
被如下接口引用：CreateAndAttachNetworkInterface、CreateNetworkInterface、DeleteNetworkInterfaces、DescribeNetworkInterfaces、DescribeNetworkInterfacesEx、DescribeNetworkInterfacesExtra
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| DeviceIndex | 是 | 否 | Uint64 | 网卡在云主机实例内的序号。 示例值： 1 |
| InstanceAccountId | 是 | 否 | String | 云主机所有者账户信息。 示例值： 251000681 |
| AttachTime | 是 | 否 | String | 绑定时间。 示例值： 2020-10-12 10:00:00 |
| InstanceId | 是 | 否 | String | 云主机实例ID。 示例值： ins-6o1wqibe |
Filter
过滤器
被如下接口引用：BandwidthLimitForCcnAlarmOnly、DescribeAddressTemplateGroups、DescribeAddressTemplates、DescribeAddresses、DescribeAssistantCidr、DescribeCcnAttachedInstances、DescribeCcnLimits、DescribeCcnRoutes、DescribeCrossSubNetworkInterfaces、DescribeCustomerGateways、DescribeDBInstancesWithSecurityGroup、DescribeDirectConnectGateways、DescribeEipStatistics、DescribeFlowLogs、DescribeHaVips、DescribeIp6Addresses、DescribeIp6Translators、DescribeLocalDestinationIpPortTranslationNatRules、DescribeLocalGateway、DescribeLocalIpTranslationAclRules、DescribeLocalIpTranslationNatRules、DescribeLocalSourceIpPortTranslationAclRules、DescribeLocalSourceIpPortTranslationNatRules、DescribeNatGatewayDestinationIpPortTranslationNatRules、DescribeNatGatewayLimits、DescribeNatGatewaySourceIpTranslationNatRules、DescribeNatGateways、DescribeNetDetectStates、DescribeNetDetects、DescribeNetworkAcls、DescribeNetworkInterfaces、DescribeNetworkInterfacesEx、DescribeNetworkInterfacesExtra、DescribePeerIpTranslationNatRules、DescribePublicEndPointServices、DescribeRoutePolicies、DescribeRouteTables、DescribeRoutes、DescribeRoutesWithLocal、DescribeSecurityGroupPolicies、DescribeSecurityGroups、DescribeServiceInternal、DescribeServiceTemplateGroups、DescribeServiceTemplates、DescribeSubnets、DescribeTrafficMirrors、DescribeUsedIpAddress、DescribeVpcEndPoint、DescribeVpcEndPointService、DescribeVpcEndPointServiceWhiteList、DescribeVpcInstances、DescribeVpcPeeringConnections、DescribeVpcs、DescribeVpnConnections、GetCcnRegionBandwidthLimits
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Name | 是 | 否 | String | 属性名称, 若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。 示例值： tag-key |
| Values | 是 | 否 | Array of String | 属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。当值类型为布尔类型时，可直接取值为字符串"TRUE"或 "FALSE"。 示例值： ["TagKeyA", "TagKeyB"] |
VpcLimit
私有网络配额
被如下接口引用：DescribeVpcLimits
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| LimitType | 是 | 否 | String | 私有网络配额描述 示例值： appid-max-vpcs |
| LimitValue | 是 | 否 | Uint64 | 私有网络配额值 示例值： 0 |
DfwOssDelObjectsFromUSGRequest
复杂类型: DfwOssDelObjectsFromUSGRequest
被如下接口引用：DeleteObjectFromUSGInternal
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| UsgId | 否 | 否 | String | 原VPC OSS APIv2名称: delObjectsFromUSG.usgId 示例值： sg-aosmqpxs |
| Vms | 否 | 否 | Array of String | 原VPC OSS APIv2名称: delObjectsFromUSG.vms 示例值： ['84f9a2ad-6659-4864-808c-bd17f3c2acea'] |
| VIFS | 否 | 否 | Array of String | 原VPC OSS APIv2名称: delObjectsFromUSG.vifs 示例值： ['xxx'] |
| Services | 否 | 否 | Array of String | 原VPC OSS APIv2名称: delObjectsFromUSG.svcs 示例值： ['xxx'] |
SourceIpTranslationNatRule
NAT的SNAT规则
被如下接口引用：CreateNatGateway、CreateNatGatewaySourceIpTranslationNatRule、DescribeNatGatewaySourceIpTranslationNatRules、DescribeNatGateways、ModifyNatGatewaySourceIpTranslationNatRule
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| NatGatewaySnatId | 否 | 否 | String | Snat规则ID 示例值： snat-3nptcfvp |
| ResourceId | 是 | 否 | String | 资源ID 示例值： subnet-7aed90al |
| ResourceType | 是 | 是 | String | 资源类型，目前包含SUBNET、NETWORKINTERFACE 示例值： SUBNET |
| PrivateIpAddress | 是 | 否 | String | 源IP/网段 示例值： 172.168.100.0/24 |
| PublicIpAddresses | 是 | 否 | Array of String | 弹性IP地址池 示例值： ['180.12.59.43'] |
| Description | 是 | 否 | String | 描述 示例值： demo |
| NatGatewayId | 否 | 是 | String | NAT网关的ID。 示例值： nat-3nptcfvp |
| VpcId | 否 | 是 | String | 私有网络VPC的ID。 示例值： vpc-oty76xyl |
| CreatedTime | 否 | 是 | String | NAT网关SNAT规则创建时间。 示例值： 2021-03-14 13:59:00 |
| CreatedTimeIso | 否 | 是 | Datetime_iso | NAT网关SNAT规则创建时间。 示例值： 2025-12-16T10:06:17+08:00 |
DfwOssDeleteUSGRequest
复杂类型: DfwOssDeleteUSGRequest
被如下接口引用：DeleteUSGInternal
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| UsgId | 否 | 否 | String | 原DFW APIv2名称: deleteUSG.usgId 示例值： 487487 |
| ProjectId | 否 | 否 | String | 原DFW APIv2名称: deleteUSG.projectId 示例值： 487 |
NatGatewayAddress
NAT网关绑定的弹性IP
被如下接口引用：CreateNatGateway、DescribeNatGateways
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| AddressId | 否 | 否 | String | 弹性公网IP（EIP）的唯一 ID，形如：eip-jrkzpvgt。示例值： eip-jrkzpvgt |
| PublicIpAddress | 否 | 否 | String | 外网IP地址，形如：487.121.34.33。示例值： 487.121.34.3 |
| IsBlocked | 否 | 否 | Bool | 资源封堵状态。true表示弹性ip处于封堵状态，false表示弹性ip处于未封堵状态。 示例值： true |
DfwOssCreateUSGRequest
复杂类型: DfwOssCreateUSGRequest
被如下接口引用：CreateUSGInternal
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Sys | 否 | 否 | Int64 | 原DFW APIv2名称: createUSG.sys 示例值： 1 |
| SgId | 否 | 否 | String | 原DFW APIv2名称: createUSG.sgId 示例值： 487487 |
| UsgName | 否 | 否 | String | 原DFW APIv2名称: createUSG.usgName 示例值： test |
| UsgRemark | 否 | 否 | String | 原DFW APIv2名称: createUSG.usgRemark 示例值： remark |
| ProjectId | 否 | 否 | String | 原DFW APIv2名称: createUSG.projectId 示例值： 487 |
| Os | 否 | 否 | Int64 | 原DFW APIv2名称: createUSG.os 示例值： 1 |
VpnGateway
VPN网关对象。
被如下接口引用：CreateVpnGateway、DescribeVpnGateways
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| VpnGatewayId | 是 | 否 | String | 网关实例ID。 示例值： vpngw-az2xuzp5 |
| VpcId | 是 | 否 | String | VPC实例ID。 示例值： vpc-qqa5rnd5 |
| VpnGatewayName | 是 | 否 | String | 网关实例名称。 示例值： demo-gateway |
| Type | 是 | 否 | String | 网关实例类型：'IPSEC', 'SSL','CCN'。 示例值： IPSEC |
| State | 是 | 否 | String | 网关实例状态， 'PENDING'：生产中，'DELETING'：删除中，'AVAILABLE'：运行中。 示例值： AVAILABLE |
| PublicIpAddress | 是 | 否 | String | 网关公网IP。 示例值： 139.124.3.2 |
| RenewFlag | 是 | 否 | String | 网关续费类型：'NOTIFY_AND_MANUAL_RENEW'：手动续费，'NOTIFY_AND_AUTO_RENEW'：自动续费，'NOT_NOTIFY_AND_NOT_RENEW'：到期不续费。 示例值： NOTIFY_AND_MANUAL_RENEW |
| InstanceChargeType | 是 | 否 | String | 网关付费类型：POSTPAID_BY_HOUR：按小时后付费，PREPAID：包年包月预付费， 示例值： POSTPAID_BY_HOUR |
| InternetMaxBandwidthOut | 是 | 否 | Uint64 | 网关出带宽。 示例值： 5 |
| CreatedTime | 是 | 否 | Datetime | 创建时间。 示例值： 2021-04-25 17:14:34 |
| ExpiredTime | 是 | 否 | Datetime | 预付费网关过期时间。 示例值： 2021-04-25 17:14:34 |
| IsAddressBlocked | 是 | 否 | Bool | 公网IP是否被封堵。 示例值： false |
| NewPurchasePlan | 是 | 否 | String | 计费模式变更，PREPAID_TO_POSTPAID：包年包月预付费到期转按小时后付费。 示例值： PREPAID_TO_POSTPAID |
| RestrictState | 是 | 否 | String | 网关计费装，PROTECTIVELY_ISOLATED：被安全隔离的实例，NORMAL：正常。 示例值： PROTECTIVELY_ISOLATED |
| Zone | 是 | 否 | String | 可用区，如：ap-region-2 示例值： ap-region-2 |
| VpnGatewayQuotaSet | 是 | 否 | Array of VpnGatewayQuota | 网关带宽配额信息 示例值：查看 |
| Version | 是 | 否 | String | 网关实例版本信息 示例值： 1.0 |
| NetworkInstanceId | 是 | 否 | String | Type值为CCN时，该值表示云联网实例ID 示例值： ccn-gree226l |
| IspType | 是 | 否 | String | 公网IP运营商 示例值： 5 |
| ProtocolType | 否 | 否 | String | 协议类型 IPSEC/SSL 示例值： IPSEC |
| NetworkType | 否 | 否 | String | 网络类型，当前仅支持VPC 示例值： VPC |
| MaxConnection | 否 | 否 | Uint64 | 最大连接数。 示例值： 5 |
| CreateSSLServer | 否 | 否 | Bool | 是否已创建SSL服务端 示例值： true |
| CdcId | 否 | 是 | String | CDC实例ID。 示例值： cluster-gbo27yc4 |
| TagSet | 否 | 是 | Array of Tag | 标签 示例值：查看 |
| IsPrivate | 否 | 否 | Bool | 是否是私网 示例值： false |
| BgpAsn | 否 | 否 | Uint64 | 61413 示例值： Bgp ASN |
QuotaSet
配额信息
被如下接口引用：DescribeAddressAssociationQuota
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| QuotaId | 否 | 是 | String | 配额 ID 示例值： NETWORK_INTERFACE_ADDRESS_ASSOCIATION |
| NetworkInterfaceId | 否 | 是 | String | 网卡 ID 示例值： eni-2dr67vs9 |
| InstanceId | 否 | 是 | String | 实例 ID 示例值： ins-2dr67vs9 |
| QuotaCurrent | 否 | 是 | Int64 | 已使用配额 示例值： 2 |
| QuotaLimit | 否 | 是 | Int64 | 总配额 示例值： 10 |
| DefaultInternetServiceProvider | 否 | 是 | Bool | 是否默认运营商 示例值： true |
LocalIpTranslationAclRuleNeedId
本端IP转换ACL规则复杂类型
被如下接口引用：DescribeLocalIpTranslationAclRules、ModifyLocalIpTranslationAclRule
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Protocol | 是 | 否 | String | 协议 示例值： tcp |
| SourcePort | 是 | 否 | String | 源端口 示例值： 80 |
| DestinationCidr | 是 | 否 | String | 目的IP 示例值： 2.2.2.0/16 |
| DestinationPort | 是 | 否 | String | 目的端口 示例值： 80 |
| Action | 否 | 否 | Int64 | 0 或 1 示例值： 0 |
| AclRuleId | 是 | 否 | Int64 | 规则ID 示例值： 100 |
CcnAttachedInstance
云联网（CCN）关联实例（Instance）对象
被如下接口引用：DescribeCcnAttachedInstances
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| CcnId | 是 | 否 | String | 云联网实例ID。 示例值： ccn-31zf3vib |
| InstanceType | 是 | 否 | String | 关联实例类型：VPC：私有网络DIRECTCONNECT：专线网关BMVPC：黑石私有网络示例值： VPC |
| InstanceId | 是 | 否 | String | 关联实例ID。 示例值： vpc-lt6ork07 |
| InstanceName | 是 | 否 | String | 关联实例名称。 示例值： demo |
| InstanceRegion | 是 | 否 | String | 关联实例所属大区，例如：ap-region。 示例值： ap-region |
| InstanceUin | 是 | 否 | String | 关联实例所属UIN（根账号）。 示例值： 100000072292 |
| CidrBlock | 是 | 否 | Array of String | 关联实例CIDR。 示例值： 10.1.0.0/16 |
| State | 是 | 否 | String | 关联实例状态：PENDING：申请中ACTIVE：已连接EXPIRED：已过期REJECTED：已拒绝DELETED：已删除FAILED：失败的（2小时后将异步强制解关联）ATTACHING：关联中DETACHING：解关联中DETACHFAILED：解关联失败（2小时后将异步强制解关联）示例值： ACTIVE |
| AttachedTime | 是 | 否 | Datetime | 关联时间。 示例值： 2021-03-03 16:19:44 |
| CcnUin | 是 | 否 | String | 云联网所属UIN（根账号）。 示例值： 100000072292 |
DirectConnectGateway
专线网关对象。
被如下接口引用：CreateDirectConnectGateway、DescribeDirectConnectGateways
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| DirectConnectGatewayId | 是 | 否 | String | 专线网关ID。示例值： dcg-e6mxyyvj |
| DirectConnectGatewayName | 是 | 否 | String | 专线网关名称。 示例值： demo |
| VpcId | 是 | 否 | String | 专线网关关联VPC实例ID。示例值： vpc-hm2okght |
| NetworkType | 是 | 否 | String | 关联网络类型：VPC - 私有网络CCN - 云联网示例值： CCN |
| NetworkInstanceId | 是 | 否 | String | 关联网络实例ID：NetworkType为VPC时，这里为私有网络实例IDNetworkType为CCN时，这里为云联网实例ID示例值： ccn-4rukgymd |
| GatewayType | 是 | 否 | String | 网关类型： 示例值： NORMAL |
| CreateTime | 是 | 否 | Datetime | 创建时间。 示例值： 2020-02-01 12:00:00 |
| CreateTimeIso | 否 | 是 | Datetime_iso | 创建时间。 示例值： 2025-12-16T10:06:17+08:00 |
| DirectConnectGatewayIp | 是 | 否 | String | 专线网关IP。 示例值： 10.212.253.59 |
| CcnId | 是 | 否 | String | 专线网关关联CCN实例ID。示例值： ccn-4rukgymd |
| CcnRouteType | 是 | 否 | String | 云联网路由学习类型：BGP - 自动学习。STATIC - 静态，即用户配置。示例值： BGP |
| EnableBGP | 是 | 否 | Bool | 是否启用BGP。 示例值： true |
| EnableBGPCommunity | 否 | 否 | Bool | 开启和关闭BGP的community属性。 示例值： false |
| Bandwidth | 否 | 否 | Int64 | 专线网关带宽限速值。 示例值： 100 |
| ModeType | 否 | 否 | String | 是否支持发布到云联网 示例值： standard |
| BGPCommunitySupport | 否 | 否 | Bool | 是否支持BGP 社团属性 示例值： true |
| VXLANSupport | 否 | 是 | Bool | 是否支持VXLAN 示例值： true |
| LocalZone | 否 | 否 | Bool | 是否是本地区域 示例值： false |
| BGPSupport | 否 | 否 | Bool | 是否支持BGP 示例值： true |
| TagSet | 否 | 否 | Array of Tag | tag 信息 示例值：查看 |
| AliasType | 否 | 是 | String | 别名类型 示例值： NORMAL |
| Ipv6Mode | 否 | 否 | Bool | 是否为Ipv6 示例值： true |
| FlowDetailsUpdateTime | 否 | 是 | String | 流日志信息更新时间 示例值： 2021-07-08 14:47:49 |
| AccessNetworkType | 否 | 否 | String | 骨干网络类型 示例值： MPLS |
| FlowLogId | 否 | 是 | String | 流日志唯一ID 示例值： fl-7zvyvr8d |
| DirectConnectGatewayVersion | 否 | 是 | String | 专线网关版本号 示例值： V1 |
| AliasInstanceId | 否 | 是 | String | 专线网关的别名实例ID，与AliasType配合使用 示例值： 5gcg-9865478 |
| EnableFlowDetails | 否 | 否 | Int64 | 是否开启流量统计 示例值： 0 |
| NewAfc | 否 | 否 | Int64 | 标识专线网关是否使用新的 AFC 架构 示例值： 0 |
ZoneSet
zone数组
被如下接口引用：DescribeNatGatewayZones
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Zone | 是 | 是 | String | zone名称 示例值： ap-region-2 |
| ZoneId | 是 | 否 | Uint64 | 可用区ID 示例值： 50001 |
SecurityGroupPolicyCheckInfo
安全组策略检测结果对象
被如下接口引用：CheckSecurityGroupPolicies
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Direction | 是 | 否 | String | 数据流方向，取值：inbound(入站)，outbound(出站)。 示例值： EGRESS |
| Protocol | 是 | 否 | String | 协议, 取值: TCP,UDP, ICMP。 示例值： TCP |
| Port | 是 | 否 | String | 端口号，对于入站为目标端口，对于出站为源端口。 示例值： 122 |
| Action | 是 | 否 | String | 数据流是否放通，取值：ACCEPT(放通)，DROP(未放通)。 示例值： DROP |
CustomerGateway
对端网关
被如下接口引用：CreateCustomerGateway、DescribeCustomerGateways
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| CustomerGatewayId | 是 | 否 | String | 用户网关唯一ID 示例值： cgw-ea2fck23 |
| CustomerGatewayName | 是 | 否 | String | 网关名称 示例值： demo-name |
| IpAddress | 是 | 否 | String | 公网地址 示例值： 1.3.15.5 |
| CreatedTime | 是 | 否 | String | 创建时间 示例值： 2021-02-03 00:00:00 |
| VpnConnNum | 否 | 否 | Uint64 | 关联通道数 示例值： 1 |
| BgpAsn | 否 | 否 | Int64 | BGP的ASN号 示例值： 6000 |
| TagSet | 否 | 是 | Array of Tag | 标签 示例值：查看 |
PolicyStatistics
安全组策略统计
被如下接口引用：CreateSecurityGroupPolicies、CreateSecurityGroupWithPolicies、DeleteSecurityGroupPolicies、DescribeSecurityGroupPolicies、ModifySecurityGroupPolicies、ReplaceSecurityGroupPolicies、ReplaceSecurityGroupPolicy
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| EgressIPv6TotalCount | 是 | 否 | Uint64 | 出站IPv6总数 示例值： 1 |
| IngressIPv4TotalCount | 是 | 否 | Uint64 | 入站IPv4总数 示例值： 1 |
| IngressIPv6TotalCount | 是 | 否 | Uint64 | 入站IPv6总数 示例值： 1 |
| EgressIPv4TotalCount | 是 | 否 | Uint64 | 出站IPv4总数 示例值： 1 |
SecurityGroupPolicy
安全组规则对象
被如下接口引用：CreateSecurityGroupPolicies、CreateSecurityGroupWithPolicies、DeleteSecurityGroupPolicies、DescribeSecurityGroupPolicies、DescribeSecurityGroupPolicyTemplates、ModifySecurityGroupPolicies、ReplaceSecurityGroupPolicies、ReplaceSecurityGroupPolicy
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 否 | 否 | String | ACCEPT 或 DROP。 示例值： ACCEPT |
| PolicyDescription | 否 | 否 | String | 安全组规则描述。作为入参时，当未传递该参数或值为空，且参数CidrBlock或Ipv6CidrBlock值为MY_PUBLIC_IP时，该参数的值将会被自动填充为Replaced-From-MY_PUBLIC_IP。 示例值： demo |
| ModifyTime | 否 | 否 | String | 安全组最近修改时间。 示例值： 2021-03-02 14:41:15 |
| Dir | 否 | 否 | String | 策略方向，入站-INPUT，出站-OUTPUT。 示例值： INPUT |
| Priority | 否 | 否 | Int64 | 安全组规则优先级，值会随着安全组规则的变更动态变化。使用Priority时，请先调用DescribeSecurityGroupPolicies获取到规则的Priority，并且结合返回值中的Version一起使用处理规则。示例值： |
| PolicyIndex | 否 | 否 | Int64 | 安全组规则索引号，值会随着安全组规则的变更动态变化。使用PolicyIndex时，请先调用DescribeSecurityGroupPolicies获取到规则的PolicyIndex，并且结合返回值中的Version一起使用处理规则。示例值： 0 |
| Protocol | 否 | 否 | String | 协议, 取值: TCP,UDP,ICMP,ICMPv6,ALL。 示例值： TCP |
| ServiceTemplate | 否 | 否 | ServiceTemplateSpecification | 协议端口ID或者协议端口组ID。ServiceTemplate和Protocol+Port互斥。 示例值：查看 |
| SecurityGroupId | 否 | 否 | String | 安全组实例ID，例如：sg-ohuuioma。 示例值： sg-ohuuioma |
| AddressTemplate | 否 | 否 | AddressTemplateSpecification | IP地址ID或者IP地址组ID。 示例值：查看 |
| Diff | 否 | 否 | Bool | 是否有差异，对于入站表示删除，对于出站表示新增。 示例值： true |
| Port | 否 | 否 | String | 端口(all, 离散port, range)。 说明：如果Protocol设置为ALL，则Port也需要设置为all。 示例值： 22 |
| CidrBlock | 否 | 否 | String | 网段或IP(互斥)，特殊说明：0.0.0.0/n 都会映射为0.0.0.0/0。作为入参时，可使用字符串MY_PUBLIC_IP指代发起请求的公网IP地址。示例值： 10.0.0.0/16 |
| Ipv6CidrBlock | 否 | 否 | String | 网段或IPv6(互斥)。作为入参时，可使用字符串MY_PUBLIC_IP指代发起请求的公网IPv6地址。示例值： ::/0 |
PrivateIpAddressForSubNetWorkInterface
中继网卡IP地址信息
被如下接口引用：CreateCrossSubNetworkInterface、CreateSubNetworkInterface、DeleteCrossSubNetworkInterface、DeleteSubNetworkInterface、DescribeCrossSubNetworkInterfaces
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| ResourceId | 否 | 是 | String | 保留IP指定绑定的资源ID。 示例值： cluster-9865478 |
| State | 否 | 是 | String | IP状态： PENDING：生产中 MIGRATING：迁移中 DELETING：删除中 AVAILABLE：可用的 示例值： AVAILABLE |
| PrivateIpAddress | 是 | 是 | String | IP地址。 示例值： 10.0.0.1 |
| Primary | 否 | 是 | Bool | 是否主IP：True-是，False-否。 示例值： True |
VpnConnection
VPN通道对象。
被如下接口引用：CreateVpnConnection、DescribeVpnConnections
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| VpnConnectionId | 是 | 否 | String | 通道实例ID。 示例值： vpnx-7m3llk0z |
| VpnConnectionName | 是 | 否 | String | 通道名称。 示例值： tunnel_name |
| VpcId | 是 | 否 | String | VPC实例ID。 示例值： vpc-cd20bl9ox |
| VpnGatewayId | 是 | 否 | String | VPN网关实例ID。 示例值： vpngw-mjuqp21j |
| CustomerGatewayId | 是 | 否 | String | 对端网关实例ID。 示例值： cgw-gj1n0rz6 |
| PreShareKey | 是 | 否 | String | 预共享密钥。 示例值： presharekey |
| VpnProto | 是 | 否 | String | 通道传输协议。 示例值： IPSEC |
| EncryptProto | 是 | 否 | String | 通道加密协议。 示例值： IKE |
| RouteType | 是 | 否 | String | 路由类型。 示例值： StaticRoute |
| CreatedTime | 是 | 否 | Datetime | 创建时间。 示例值： 0000-00-00 00:00:00 |
| State | 是 | 否 | String | 通道的生产状态，PENDING：生产中，AVAILABLE：运行中，DELETING：删除中。 示例值： AVAILABLE |
| NetStatus | 是 | 否 | String | 通道连接状态，AVAILABLE：已连接。 示例值： AVAILABLE |
| SecurityPolicyDatabaseSet | 是 | 否 | Array of SecurityPolicyDatabase | SPD。 示例值：查看 |
| IKEOptionsSpecification | 是 | 否 | IKEOptionsSpecification | IKE选项。 示例值：查看 |
| IPSECOptionsSpecification | 是 | 否 | IPSECOptionsSpecification | IPSEC选择。 示例值：查看 |
| NegotiationType | 否 | 否 | String | 协商类型，默认为active（主动协商） 示例值： active |
| DpdEnable | 否 | 否 | Int64 | DPD探测开关。默认为0，表示关闭DPD探测。可选值：0（关闭），1（开启） 示例值： 0 |
| DpdTimeout | 否 | 否 | String | DPD超时时间。即探测确认对端不存在需要的时间。dpdEnable为1（开启）时有效。默认30，单位为秒 示例值： 30 |
| DpdAction | 否 | 否 | String | DPD超时后的动作。默认为clear。 示例值： clear |
| HealthCheckLocalIp | 否 | 否 | String | 本端探测IP 示例值： 0.0.0.0 |
| HealthCheckRemoteIp | 否 | 否 | String | 对端探测IP 示例值： 0.0.0.0 |
| VpnGatewayName | 否 | 否 | String | VPN网关名称 示例值： vpngw-1 |
| EnableHealthCheck | 否 | 否 | Bool | 是否支持健康状态探测 示例值： false |
| HealthCheckStatus | 否 | 是 | String | 通道健康检查状态，AVAILABLE：正常，UNAVAILABLE：不正常。 未配置健康检查不返回该对象 示例值： AVAILABLE |
| TagSet | 否 | 否 | Array of Tag | 标签 示例值：查看 |
| BgpConfig | 否 | 否 | BgpConfigAndAsn | BGP配置信息 示例值：查看 |
| CustomerGatewayIdInfo | 否 | 否 | CustomerGatewayIdInfo | 对端网关信息 示例值：查看 |
| VpcInfo | 否 | 否 | VpcInfo | VPC信息 示例值：查看 |
DfwOssDeletePolicyFromVmRequest
复杂类型: DfwOssDeletePolicyFromVmRequest
被如下接口引用：DeletePolicyFromVmInternal
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Uuid | 否 | 否 | String | 原DFW APIv2名称: delPolicyFromVM.uuid 示例值： 487487 |
| Policies | 否 | 否 | Array of DfwOssPolicies | 原DFW APIv2名称: delPolicyFromVM.policies 示例值：查看 |
ISPTypeItem
申请ipv6 cidr block的信息
被如下接口引用：AssignIpv6CidrBlocks
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| ISPType | 是 | 是 | String | IPv6 Cidr所属运营商类型，支持的类型有 'BGP'-默认, 'CMCC'-运营商, 'CTCC'-运营商, 'CUCC'-运营商 示例值： "BGP" |
| Count | 是 | 是 | Uint64 | 申请IPv6 Cidr Block的个数 示例值： 1 |
Route
路由策略对象
被如下接口引用：CreateIpv6Routes、CreateRouteTable、CreateRoutes、DeleteIpv6Routes、DeleteRoutes、DescribeRouteConflicts、DescribeRouteTables、DescribeRoutes、DescribeRoutesWithLocal、ModifyIpv6Routes、ReplaceRoutes、ResetRoutes
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| RouteId | 否 | 否 | Uint64 | 路由策略ID。 示例值： 1289089 |
| DestinationCidrBlock | 否 | 否 | String | 目的网段，取值不能在私有网络网段内，例如：112.20.51.0/24。 示例值： 10.0.0.0/24 |
| GatewayType | 否 | 否 | String | 下一跳类型，目前我们支持的类型有： CVM：公网网关类型的云服务器； VPN：VPN网关； DIRECTCONNECT：专线网关； PEERCONNECTION：对等连接； SSLVPN：sslvpn网关； NAT：NAT网关; NORMAL_CVM：普通云服务器； EIP：云服务器的公网IP； CCN：云联网。 示例值： VPN |
| GatewayId | 否 | 否 | String | 下一跳地址，这里只需要指定不同下一跳类型的网关ID，系统会自动匹配到下一跳地址。 特别注意：当 GatewayType 为 EIP 时，GatewayId 固定值 '0' 示例值： vpn-acxun9p |
| RouteDescription | 否 | 否 | String | 路由策略描述。 示例值： demo |
| Enabled | 否 | 否 | Bool | 是否启用 示例值： true |
| RouteType | 否 | 否 | String | 路由类型，目前我们支持的类型有： USER：用户路由； NETD：网络探测路由，创建网络探测实例时，系统默认下发，不可编辑与删除； CCN：云联网路由，系统默认下发，不可编辑与删除。 用户只能添加和操作 USER 类型的路由。 示例值： USER |
| RouteTableId | 否 | 否 | String | 路由表实例ID，例如：rtb-azd4dt1c。 示例值： rtb-azd4dt1c |
| RouteItemId | 否 | 否 | String | 路由策略字符串ID。 示例值： rti-9bjer08h |
| DestinationIpv6CidrBlock | 否 | 否 | String | 创建IPv4目的网段，取值不能在私有网络网段内，例如：112.20.51.0/24。 示例值： 10.0.0.0/24 |
| CreatedTime | 否 | 否 | Datetime | 路由策略创建时间。 示例值： 2021-03-02 14:41:15 |
| IsCdc | 否 | 否 | Bool | 是否为 Cdc路由 示例值： true |
| PublishedToVbc | 否 | 否 | Bool | 路由策略是否发布到云联网。该字段仅做出参使用，作为入参字段时此参数不生效。 示例值： true |
| SubnetRouteAlgorithm | 否 | 否 | String | 支持的 ECMP算法有：ECMP_QUINTUPLE_HASH：五元组hash，ECMP_SOURCE_DESTINATION_IP_HASH：源和目的IP hash，ECMP_DESTINATION_IP_HASH：目的IP hash，ECMP_SOURCE_IP_HASH：源IP hash。 示例值： ECMP_SOURCE_DESTINATION_IP_HASH |
| CdcId | 否 | 否 | String | cluster-d8htgb6k 示例值： CDC 集群唯一 ID。 |
| AssistantType | 否 | 否 | String | local cidr类型：NORMAL/DOCKER。 示例值： NORMAL |
| HighPriorityRouteFlag | 否 | 否 | Bool | 高优路由表标记 示例值： true |
GatewaySet
网关地址
被如下接口引用：CreateAssistantCidr、CreateNetworkAcl、CreateSubnet、CreateSubnets、CreateVpc、DescribeAssistantCidr、DescribeNetworkAcls、DescribeSubnets、DescribeVpcs、ModifyAssistantCidr
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Address | 否 | 否 | String | 网关地址 示例值： 10.0.0.1 |
SecurityGroupPolicyTemplate
安全组规则模板
被如下接口引用：DescribeSecurityGroupPolicyTemplates
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| TemplateName | 是 | 否 | String | 模板名称。 示例值： demo |
| TemplateRemark | 是 | 否 | String | 模板描述。 示例值： demo |
| Ingress | 是 | 否 | Array of SecurityGroupPolicy | 入站规则。 示例值：查看 |
| Egress | 是 | 否 | Array of SecurityGroupPolicy | 出站规则。 示例值：查看 |
SpecialRouteTableAssociation
特殊子网绑定的路由表
被如下接口引用：CreateIpv6Routes、CreateRouteTable、CreateRoutes、DescribeRouteTables
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Subnet | 否 | 否 | String | 子网。 示例值： 169.254.128.1 |
| IntMask | 否 | 否 | Uint64 | 整型掩码长度。 示例值： 32 |
| RouteTableId | 否 | 否 | String | 路由表ID。 示例值： rtb-42k2zi1a |
NetworkInterface
弹性网卡
被如下接口引用：CreateAndAttachNetworkInterface、CreateNetworkInterface、DeleteNetworkInterfaces、DescribeNetworkInterfaces、DescribeNetworkInterfacesEx、DescribeNetworkInterfacesExtra
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| NetworkInterfaceDescription | 否 | 否 | String | 弹性网卡描述。 示例值： demo |
| BusinessOwner | 否 | 否 | String | 原VPC OSS APIv2名称: GetEni.businessOwner 示例值： 125500312 |
| Primary | 否 | 否 | Bool | 是否是主网卡。 示例值： true |
| SubNetworkInterfaces | 否 | 否 | Array of String | 该网卡关联的中继网卡实例列表。 示例值： ["eni-pq9vxykj"] |
| FlushSubEniHavipFlag | 否 | 否 | Bool | 是否刷新子网卡Havip的开关。 示例值： true |
| EnableDirectSend | 否 | 否 | Bool | 示例值： false |
| ElasticNetworkCardName | 否 | 否 | String | 网卡接口名 示例值： veni_vFspYEOS |
| NetworkInterfaceId | 是 | 否 | String | 弹性网卡实例ID，例如：eni-f1xjkw1b。 示例值： eni-b4ax8qbz |
| Business | 否 | 否 | String | 网卡绑定的子机类型：cvm（普通CVM子机），eks（弹性容器服务Elastic Kubernetes Service）， hai（高性能应用服务Hyper Application Inventor）。 示例值： TKE |
| ResourceId | 否 | 否 | String | 用于保留网卡主IP的资源ID用于保留网卡主IP的资源ID。用于删除网卡时作为入参数。 示例值： cls-j85c20d4-reserved |
| DeleteOnTermination | 否 | 否 | Bool | 删除实例的时候，是否销毁网卡。 示例值： false |
| VlanId | 否 | 否 | Uint64 | 如果是中继子网卡时，分配的 VlanId示例值： 100 |
| PrivateIpAddressSet | 是 | 否 | Array of PrivateIpAddressSpecification | 内网IP信息。 示例值：查看 |
| TagSet | 是 | 否 | Array of Tag | 标签键值对。 示例值：查看 |
| DirectSendMaxPort | 否 | 否 | Uint64 | DirectSend端口范围最大值。 示例值： 8080 |
| SubnetId | 是 | 否 | String | 子网实例ID。 示例值： subnet-l0ykcjvi |
| GroupSet | 否 | 否 | Array of String | 绑定的安全组。 示例值： ["sg-2edhcclz"] |
| Ipv6AddressSet | 是 | 否 | Array of Ipv6Address | IPv6地址列表。示例值：查看 |
| Synchronized | 否 | 否 | Bool | 接口是否为同步模式。 示例值： false |
| DirectSendMinPort | 否 | 否 | Uint64 | DirectSend端口范围最小值。 示例值： 0 |
| MacAddress | 是 | 否 | String | MAC地址。 示例值： 20:90:6F:EE:57:E2 |
| State | 是 | 否 | String | 弹性网卡状态：PENDING：创建中AVAILABLE：可用的ATTACHING：绑定中DETACHING：解绑中DELETING：删除中示例值： AVAILABLE |
| CdcId | 否 | 否 | String | 网卡所关联的CDC实例ID。 示例值： cluster-gbo27yc4 |
| IsCdc | 否 | 否 | Bool | 是否为 Cdc 类型的网卡。 示例值： false |
| SupportSpecialRouteTable | 否 | 否 | Bool | 是否开启绑定32位子网路由表。 示例值： false |
| NetworkInterfaceName | 是 | 否 | String | 弹性网卡名称。 示例值： demo |
| NetworkInterfaceState | 否 | 否 | String | 弹性网卡状态：PENDING：创建中AVAILABLE：可用的ATTACHING：绑定中DETACHING：解绑中DELETING：删除中INUSE：已绑定示例值： AVAILABLE |
| Zone | 否 | 否 | String | 可用区。 示例值： ap-region1-1 |
| IsRdma | 否 | 否 | Bool | 是否为RDMA弹性网卡，true-是rdma弹性网卡，false-不是 示例值： true |
| EnableToa | 否 | 否 | Bool | 启用Toa标识。 示例值： false |
| DirectSend | 否 | 否 | String | 支持选项：5-TUPLE-默认五元组会话，DIRECT-SEND-不建ct，直接转发，3-TUPLE-三元组建立ct，不查端口。示例值： 5-TUPLE |
| VpcId | 是 | 否 | String | VPC实例ID。 示例值： vpc-29mdigub |
| Attachment | 否 | 是 | NetworkInterfaceAttachment | 绑定的云服务器对象。 示例值：查看 |
| CreatedTime | 否 | 否 | String | 创建时间。格式：YYYY-MM-DD hh:mm:ss。示例值：2020-10-28 08:23:59 示例值： 2020-10-28 08:23:59 |
| AttachType | 否 | 否 | Uint64 | 弹性网卡类型：0:标准型/1:扩展型。默认值为0。 示例值： 0 |
| Region | 否 | 否 | String | 地域。 示例值： ap-region1 |
| ServiceManaged | 否 | 否 | Bool | 是否托管弹性网卡 示例值： false |
| InstanceAccountId | 否 | 否 | String | 网卡关联实例的AppId账号。 示例值： 251199581 |
| TrunkingNetworkInterfaceId | 否 | 否 | String | 如果是中继子网卡时，关联的主网卡。 示例值： eni-bb7vven9 |
| EniType | 否 | 否 | Uint64 | 网卡类型。“0”-辅助网卡，“1”-主网卡，“2”：中继网卡 示例值： 0 |
| QosLevel | 否 | 否 | String | 服务质量级别： PT（云金）、AU（云银）、AG(云铜）、DEFAULT（默认）。 可选值：PT（云金）、AU（云银）、AG(云铜）、DEFAULT（默认）。 示例值： AG |
| FlowLogsSet | 否 | 是 | Array of FlowLog | 流日志列表。 示例值：查看 |
| InstanceId | 否 | 否 | String | 云主机实例ID。 示例值： ins-20113wki |
| taskId | 否 | 否 | Int64 | Des 任务taskId 示例值： 213415 |
VpcOssRouteWeightRequest
复杂类型: VpcOssRouteWeightRequest
被如下接口引用：UpdateRouteWeightInternal
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| UniqueVpcId | 否 | 否 | String | 对外唯一VpcId 示例值： vpc-jmaywf6r |
| GroupId | 否 | 否 | Int64 | 原VPC OSS APIv2名称: UpdateRouteWeight.groupId 示例值： 1 |
| Protocol | 否 | 否 | String | 原VPC OSS APIv2名称: UpdateRouteWeight.proto 示例值： tcp |
| Vip | 否 | 否 | String | 原VPC OSS APIv2名称: UpdateRouteWeight.vip 示例值： 172.16.0.18 |
| VirtualPort | 否 | 否 | Int64 | 原VPC OSS APIv2名称: UpdateRouteWeight.vport 示例值： 22 |
| RouteSet | 否 | 否 | Array of VpcOssRouteForUpdateRouteWeightInternal | 原VPC OSS APIv2名称: UpdateRouteWeight.route 示例值：查看 |
| VpcId | 否 | 否 | Int64 | 整数vpcId 示例值： 1 |
AddressTemplateItem
地址信息
被如下接口引用：CreateAddressTemplateGroup、DescribeAddressTemplateGroups
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| AddressTemplateName | 否 | 否 | String | 地址模版名称 示例值： demo |
| AddressTemplateId | 是 | 否 | String | 地址模版Id 示例值： ipm-ig8xpno8 |
| Description | 否 | 否 | String | 备注 示例值： demo |
| From | 否 | 否 | String | 废弃字段。 示例值： demo |
| To | 否 | 否 | String | 废弃字段。 示例值： demo |
AddressBase
弹性公网IP基础信息
被如下接口引用：DescribeAddressSet
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| InternetServiceProvider | 是 | 否 | String | 运营商信息，包括移动，联通，电信，平台CAP 示例值： BGP |
| SetName | 是 | 否 | String | 弹性公网IP集群名称 示例值： demo |
| SetId | 是 | 否 | Int64 | 弹性公网IP集群唯一Id 示例值： 24523 |
| AddressIp | 是 | 否 | String | 弹性公网IP地址 示例值： 10.23.32.2 |
| IsDpdk | 是 | 否 | Bool | 弹性公网IP是否支持DPDK 示例值： True |
| Status | 是 | 否 | String | 弹性公网IP是否可用 示例值： Used |
CcnRoute
CCN路由策略对象
被如下接口引用：DescribeCcnRoutes
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| RouteId | 否 | 否 | String | 路由策略ID 示例值： ccnr-hs2yc3ha |
| DestinationCidrBlock | 是 | 否 | String | 目的端 示例值： 10.1.19.0/24 |
| InstanceType | 是 | 否 | String | 下一跳类型（关联实例类型），所有类型：VPC、DIRECTCONNECT 示例值： VPC |
| InstanceId | 是 | 否 | String | 下一跳（关联实例） 示例值： vpc-fc21z82c |
| InstanceName | 是 | 否 | String | 下一跳名称（关联实例名称） 示例值： demo |
| InstanceRegion | 是 | 否 | String | 下一跳所属地域（关联实例所属地域） 示例值： region |
| UpdateTime | 是 | 否 | Datetime | 更新时间 示例值： 2022-11-19 15:20:25 |
| Enabled | 是 | 否 | Bool | 路由是否启用 示例值： True |
| InstanceUin | 是 | 否 | String | 关联实例所属UIN（根账号） 示例值： 100000072292 |
AddressLibInfo
IP地址库信息
被如下接口引用：DescribeIpLocation、DescribeIpOnline
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Country | 是 | 否 | String | 国家信息 示例值： UK |
| Province | 是 | 否 | String | 省、州、郡一级行政区域信息 示例值： ap-region |
| City | 是 | 否 | String | 市一级行政区域信息 示例值： ap-region |
| Region | 是 | 否 | String | 市内区域信息 示例值： ap-region |
| Isp | 是 | 否 | String | 接入运营商信息 示例值： BGP |
| AddressIp | 是 | 否 | String | 查询IP地址 示例值： 10.21.3.2 |
| AsName | 是 | 否 | String | 骨干运营商信息 示例值： CTCC |
| AsId | 是 | 否 | String | 运营商As号 示例值： CTCC |
| Comment | 是 | 否 | String | 注释信息。目前的填充值为移动接入用户的APN值，如无APN属性则为空 示例值： demo |
| InternetServiceProvider | 是 | 否 | String | 同Isp，废弃 示例值： BGP |
VpcOsssubEniLimit
复杂类型: VpcOssSubEniLimit
被如下接口引用：DescribeEniLimitAllInternal
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| LowerMem | 否 | 否 | Int64 | 原VPC OSS APIv2名称: GetEniLimitAll.lowerMem 示例值： 1 |
| LowerCpu | 否 | 否 | Int64 | 原VPC OSS APIv2名称: GetEniLimitAll.lowerCpu 示例值： 1 |
| Limit | 否 | 否 | Int64 | 返回数量，默认为20，最大值为100 示例值： 100 |
DfwOssCreateUSGResult
复杂类型: DfwOssCreateUSGResult
被如下接口引用：CreateUSGInternal
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| SgId | 否 | 否 | String | 原DFW APIv2名称: createUSG.sgId 示例值： 251197522 |
| UsgId | 否 | 否 | String | 原DFW APIv2名称: createUSG.usgId 示例值： sg-ispsj3ah |
| UsgName | 否 | 否 | String | 原DFW APIv2名称: createUSG.usgName 示例值： test_sdk |
LocalGateway
本地网关信息
被如下接口引用：CreateLocalGateway、DescribeLocalGateway
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| CreateTime | 是 | 否 | String | 本地网关创建时间 示例值： 2021-03-24 15:31:56 |
| CdcId | 是 | 否 | String | CDC实例ID 示例值： cluster-gbo27yc4 |
| VpcId | 是 | 否 | String | VPC实例ID 示例值： vpc-m0c2kcun |
| UniqLocalGwId | 是 | 否 | String | 本地网关实例ID 示例值： lgw-jkt4erty |
| LocalGatewayName | 是 | 否 | String | 本地网关名称 示例值： demo |
| LocalGwIp | 是 | 否 | String | 本地网关IP地址 示例值： 192.168.15.55 |
DfwOssGetUSGCountFromSGResult
复杂类型: DfwOssGetUSGCountFromSGResult
被如下接口引用：DescribeUSGCountFromSgInternal
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| SgId | 否 | 否 | String | 原DFW APIv2名称: getUSGCountFromSG.sgId 示例值： 251197522 |
| USGCount | 否 | 否 | Int64 | 原DFW APIv2名称: getUSGCountFromSG.uSGCount 示例值： 17 |
NetworkAcl
网络ACL
被如下接口引用：CreateNetworkAcl、DescribeNetworkAcls
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| VpcId | 是 | 否 | String | VPC实例ID。示例值： vpc-q26u781x |
| NetworkAclId | 是 | 否 | String | 网络ACL实例ID。示例值： acl-fy0ys38q |
| NetworkAclName | 是 | 否 | String | 网络ACL名称，最大长度为60。 示例值： demo |
| CreatedTime | 是 | 否 | String | 创建时间。 示例值： 2021-03-22 20:59:55 |
| SubnetSet | 否 | 否 | Array of Subnet | 网络ACL关联的子网数组。 示例值：查看 |
| IngressEntries | 否 | 否 | Array of NetworkAclEntry | 网络ACl入站规则。 示例值：查看 |
| EgressEntries | 否 | 否 | Array of NetworkAclEntry | 网络ACL出站规则。 示例值：查看 |
| TagSet | 否 | 否 | Array of Tag | 标签信息 示例值：查看 |
| NetworkAclType | 否 | 否 | String | TRIPLE 示例值： 网络ACL类型 |
| ModifyTime | 否 | 否 | String | 更新时间 示例值： 2021-03-22 20:59:55 |
VpcOssGlobalRouteRequest
复杂类型: VpcOssGlobalRouteRequest
被如下接口引用：CreateGlobalRouteInternal、DeleteGlobalRouteInternal
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| VpcId | 否 | 否 | Int64 | 整数vpcId 示例值： 1 |
| Subnet | 否 | 否 | String | 子网地址 示例值： 10.0.0.0 |
| IntMask | 否 | 否 | Int64 | 整数掩码 示例值： 16 |
| Remote | 否 | 否 | String | 原VPC OSS APIv2名称: DelGlobalRoute.remote 示例值： 172.16.0.18 |
| Type | 否 | 否 | Int64 | 原VPC OSS APIv2名称: DelGlobalRoute.type 示例值： 0 |
| CanEcmpFlag | 否 | 否 | Int64 | 表示是否支持 ecmp , 默认1是支持的。 示例值： 1 |
RoutePolicy
路由接收策略。当云联网或其他业务添加路由到VPC自定义路由表时，可以丢弃或启用，禁用相应的路由条目。
被如下接口引用：DescribeRoutePolicies
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| RoutePolicyName | 否 | 是 | String | 路由策略名。 示例值： demo |
| RoutePolicyDescription | 否 | 是 | String | 路由策略描述。 示例值： demo |
| RoutePolicyEntrySet | 否 | 是 | Array of RoutePolicyEntry | 路由策略规则列表。 示例值：查看 |
| RoutePolicyAssociationSet | 否 | 是 | Array of RoutePolicyAssociation | 路由策略绑定。 示例值：查看 |
| Region | 否 | 是 | String | 地域。 示例值： ap-region |
| CreatedTime | 否 | 是 | String | 创建时间。 示例值： 2023-05-20 15:21:54 |
| TagSet | 否 | 否 | Array of Tag | 标签键值对。 示例值：查看 |
| RoutePolicyId | 否 | 是 | String | 路由策略唯一ID。 示例值： rrp-pguby7ma |
DBInstances
数据库实例详细信息。
被如下接口引用：DescribeDBInstancesWithSecurityGroup
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| InstanceId | 是 | 否 | String | 实例ID形如：crs-1newjcxb。 示例值： crs-1newjcxb |
| InstanceIp | 是 | 否 | String | 实例IP形如：172.16.32.18。 示例值： 172.16.32.18 |
| InstanceName | 是 | 否 | String | 实例名称。 示例值： cfs-qci |
| VpcId | 是 | 否 | String | VPC唯一ID形如：vpc-q9iejf9r。 示例值： vpc-67wlqf6v |
DfwOssVMOperateResult
复杂类型: DfwOssVMOperateResult
被如下接口引用：AttachPolicyToVMInternal、DeletePolicyFromVmInternal
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Uuid | 否 | 否 | String | 原DFW APIv2名称: addPolicyToVM.uuid 示例值： 84f9a2ad-6659-4864-808c-bd17f3c2acea |
| ErrorCode | 否 | 否 | Int64 | 原DFW APIv2名称: addPolicyToVM.errorCode 示例值： 0 |
| ErrorInfo | 否 | 否 | String | 原DFW APIv2名称: addPolicyToVM.errorInfo 示例值： success |
Address
描述 EIP 信息
被如下接口引用：DescribeAddresses、DescribeIp6Addresses
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| AddressId | 否 | 是 | String | EIP的ID，是EIP的唯一标识。示例值： eip-ip9ongec |
| AddressName | 否 | 是 | String | EIP名称。示例值： demoName |
| ProjectId | 否 | 否 | String | 项目ID。 示例值： pr-8177bb6d |
| Zone | 否 | 否 | String | 可用区 示例值： zone-1 |
| BusinessType | 否 | 否 | String | 业务类型 示例值： DC |
| AddressStatus | 否 | 是 | String | EIP状态，包含'CREATING'(创建中),'BINDING'(绑定中),'BIND'(已绑定),'UNBINDING'(解绑中),'UNBIND'(已解绑),'OFFLINING'(释放中),'BIND_ENI'(绑定悬空弹性网卡), 'PRIVATE'(未开通公网的 IPv6)示例值： UNBIND |
| AddressIp | 否 | 是 | String | 外网IP地址 示例值： 100.10.1.1 |
| InstanceId | 否 | 是 | String | 绑定的资源实例ID。可能是一个CVM，NAT，BMS。示例值： ins-qw23er13 |
| CreatedTime | 否 | 是 | Datetime_iso | 创建时间。按照ISO8601标准表示，并且使用UTC时间。格式为：YYYY-MM-DDThh:mm:ssZ。示例值： 2021-05-19T08:37:53Z |
| NetworkInterfaceId | 否 | 是 | String | 绑定的弹性网卡ID 示例值： eni-37xao8t |
| PrivateAddressIp | 否 | 是 | String | 绑定的资源内网ip 示例值： 10.2.3.4 |
| IsArrears | 否 | 是 | Bool | 资源隔离状态。true表示eip处于隔离状态，false表示资源处于未隔离状态 示例值： false |
| IsBlocked | 否 | 是 | Bool | 资源封堵状态。true表示eip处于封堵状态，false表示eip处于未封堵状态 示例值： false |
| IsEipDirectConnection | 否 | 是 | Bool | eip是否支持直通模式。true表示eip支持直通模式，false表示资源不支持直通模式 示例值： false |
| AddressType | 否 | 是 | String | eip资源类型，包括"CalcIP","WanIP","EIP","AnycastEIP"。其中"CalcIP"表示设备ip，“WanIP”表示普通公网ip，“EIP”表示弹性公网ip，“AnycastEip”表示加速EIP 示例值： EIP |
| CascadeRelease | 否 | 是 | Bool | eip是否在解绑后自动释放。true表示eip将会在解绑后自动释放，false表示eip在解绑后不会自动释放 示例值： false |
| EipAlgType | 否 | 是 | AlgType | EIP ALG开启的协议类型。 示例值：查看 |
| InternetServiceProvider | 否 | 是 | String | 弹性公网IP的运营商信息，当前可能返回值包括"CMCC","CTCC","CUCC","BGP" 示例值： BGP |
| TagSet | 否 | 是 | Array of Tag | eip绑定标签列表 示例值：查看 |
| ComplianceStatus | 否 | 是 | String | EIP合规状态。BANNING表示封禁，FREEZING 表示冻结,其他表示正常。示例值： BANNING |
| ApplicableForCLB | 否 | 是 | Bool | 是否用于CLB。 示例值： True |
| IsNewGeneration | 否 | 是 | Bool | 是否下一代EIP。 示例值： True |
| IsActiveAccessEip | 否 | 是 | Bool | 是否主动外联。 示例值： True |
| NetworkGroup | 否 | 是 | String | EIP所属地域信息。 示例值： ap-region |
| PayMode | 否 | 是 | String | 计费方式。 示例值： BANDWIDTH_POSTPAID_BY_MONTH |
| DeadlineDate | 否 | 是 | Date | 到期时间。 示例值： 2024-10-17 22:45:47 |
| IsEip | 否 | 是 | Bool | 是否为EIP。 示例值： True |
| Bandwidth | 否 | 是 | Uint64 | 弹性公网IP的带宽值。注意，传统账户类型账户的弹性公网IP没有带宽属性，值为空。 示例值： 1 |
| UpdatedTime | 否 | 是 | String | 更新时间。 示例值： 2024-10-17 22:45:47 |
| InternetChargeType | 否 | 是 | String | 弹性公网IP的网络计费模式。注意，传统账户类型账户的弹性公网IP没有网络计费模式属性，值为空。 示例值： TRAFFIC_POSTPAID_BY_HOUR |
| BindResourceType | 否 | 是 | String | 绑定资源类型。 示例值： BIND_LB |
| LocalBgp | 否 | 是 | Bool | 是否本地带宽EIP。 示例值： false |
| IsFromWanIP | 否 | 是 | Bool | 是否从WANIP转换。 示例值： true |
| UnVpcId | 否 | 是 | String | VPC ID。 示例值： vpc-ig8xpno8 |
| DedicatedClusterId | 否 | 是 | String | CDC 唯一ID。 示例值： cluster-gbo27yc4 |
| OnlyActiveAccess | 否 | 是 | Bool | 是否仅出外网 示例值： true |
DryRunNetFlow
流特征
被如下接口引用：DescribeDryRunFlowInSecurityGroup
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| DstIp | 否 | 否 | String | 目的IP(ipv4) 示例值： 172.0.1.1 |
| Protocol | 否 | 否 | String | 协议(小写tcp/udp/icmp等) 示例值： tcp |
| DstPort | 否 | 否 | Uint64 | 目的端口 示例值： 487 |
| SrcIp | 否 | 否 | String | 源IP(ipv4) 示例值： 172.0.1.9 |
AddressTemplate
IP地址模板
被如下接口引用：CreateAddressTemplate、DescribeAddressTemplates
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| AddressTemplateName | 是 | 否 | String | IP地址模板名称。 示例值： name |
| AddressTemplateId | 是 | 否 | String | IP地址模板实例唯一ID。 示例值： ipm-3iv46d0c |
| AddressSet | 是 | 否 | Array of String | IP地址信息。 示例值： ["2.2.2.2"] |
| CreatedTime | 否 | 否 | String | 创建时间。 示例值： 2021-03-02 14:41:15 |
| UpdatedTime | 否 | 否 | String | 最后更新时间 示例值： 2020-08-10 18:10:12 |
| AddressExtraSet | 否 | 否 | Array of AddressInfo | 模版信息 示例值：查看 |
| TagSet | 否 | 否 | Array of Tag | 标签信息 示例值：查看 |
IpField
IP在线查询的字段信息
被如下接口引用：DescribeIpLocation、DescribeIpOnline
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Country | 否 | 否 | Bool | 国家字段信息 示例值： true |
| Province | 否 | 否 | Bool | 省、州、郡一级行政区域字段信息 示例值： true |
| City | 否 | 否 | Bool | 市一级行政区域字段信息 示例值： true |
| Region | 否 | 否 | Bool | 市内区域字段信息 示例值： true |
| Isp | 否 | 否 | Bool | 接入运营商字段信息 示例值： true |
| AsName | 否 | 否 | Bool | 骨干运营商字段信息 示例值： true |
| AsId | 否 | 否 | Bool | 骨干As号 示例值： true |
| Comment | 是 | 否 | Bool | 注释字段 示例值： true |
RegionStatistics
按照地域统计资源数量
被如下接口引用：DescribeNetworkInterfaces、DescribeRoutePolicies、DescribeRouteTables、DescribeSecurityGroups、DescribeSubnets、DescribeVpcEndPoint、DescribeVpcEndPointService、DescribeVpcs
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| TotalCount | 是 | 否 | Uint64 | 资源总数量。 示例值： 0 |
| Region | 是 | 否 | String | 地域。 示例值： "ap-region" |
GatewayQos
网关流控带宽信息
被如下接口引用：DescribeGatewayFlowQos
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| VpcId | 是 | 否 | String | VPC实例ID。 示例值： vpc-67wlqf6v |
| IpAddress | 是 | 否 | String | 云服务器内网IP。 示例值： 192.168.3.23 |
| Bandwidth | 是 | 否 | Uint64 | 流控带宽值。 示例值： 50 |
| CreateTime | 是 | 否 | String | 创建时间。 示例值： 2023-12-25 12:30:00 |
HaVipAssociation
HaVip绑定的子机/网卡（用于限制HaVip飘移的范围，并不是真正的飘移动作）。
被如下接口引用：CreateHaVip、DescribeHaVips
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| InstanceId | 是 | 否 | String | HaVip绑定的子机或网卡唯一ID。 示例值： ins-3qx9elib |
| HaVipId | 否 | 否 | String | HaVip实例唯一ID。 示例值： havip-7tqt5jn6 |
| InstanceType | 否 | 否 | String | HaVip绑定的类型。取值:CVM, ENI。 示例值： CVM |
LocalDestinationIpPortTranslationNatRule
本端目的IP端口转换复杂结构
被如下接口引用：CreateLocalDestinationIpPortTranslationNatRule、DeleteLocalDestinationIpPortTranslationNatRule、DescribeLocalDestinationIpPortTranslationNatRules
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Protocol | 是 | 否 | String | 协议 示例值： tcp |
| OriginalPort | 是 | 否 | Int64 | 源端口 示例值： 80 |
| OriginalIp | 是 | 否 | String | 源IP 示例值： 10.0.0.5 |
| TranslationPort | 是 | 否 | Int64 | 目的端口 示例值： 80 |
| TranslationIp | 是 | 否 | String | 目的IP 示例值： 2.2.2.2 |
| Description | 否 | 否 | String | 描述 示例值： for_demo |
ServicesInfo
协议端口模板信息
被如下接口引用：CreateServiceTemplate、CreateServiceTemplateGroup、DescribeServiceTemplateGroups、DescribeServiceTemplates
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Service | 否 | 否 | String | 协议端口。 示例值： tcp:80 |
| Description | 否 | 否 | String | 备注。 示例值： desc |
| UpdatedTime | 否 | 否 | String | 更新时间。 示例值： 2020-08-10 18:10:12 |
| MemberId | 否 | 否 | String | 唯一ID 示例值： ppm-sddsefsx |
ConflictItem
冲突资源条目信息。
被如下接口引用：CheckAssistantCidr
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| ConfilctId | 是 | 否 | String | 冲突资源的ID 示例值： rti-kngiybxl |
| DestinationItem | 是 | 否 | String | 冲突目的资源 示例值： 10.0.0.0/24 |
DfwOssDelSvcAddrFromUSG
复杂类型: DfwOssDelSvcAddrFromUSG
被如下接口引用：DeleteSvcAddrFromUSGInternal
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| VpcId | 否 | 否 | Int64 | 整数vpcId 示例值： 76084 |
| Vip | 否 | 否 | String | 原DFW APIv2名称: delSvcAddrFromUSG.vip 示例值： 10.1.2.16 |
| VirtualPort | 否 | 否 | Int64 | 原DFW APIv2名称: delSvcAddrFromUSG.vport 示例值： 27017 |
| Protocol | 否 | 否 | Int64 | 原DFW APIv2名称: delSvcAddrFromUSG.protocol 示例值： 6 |
| UsgId | 否 | 否 | String | 原DFW APIv2名称: delSvcAddrFromUSG.usgId 示例值： sg-bb536gh1 |
SingleIspZone
可用区与三网运营商的映射关系
被如下接口引用：DescribeSingleIspRegion
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Zone | 是 | 否 | String | 可用区 示例值： region |
| ZoneId | 是 | 否 | Uint64 | 可用区ID 示例值： 50001 |
| Singleisp | 是 | 否 | Array of String | 三网运营商，包括"CMCC", "CTCC", "CUCC" 示例值： CTCC |
AddressTemplateGroup
IP地址模板集合
被如下接口引用：CreateAddressTemplateGroup、DescribeAddressTemplateGroups
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| AddressTemplateGroupName | 是 | 否 | String | IP地址模板集合名称。 示例值： demo |
| AddressTemplateGroupId | 是 | 否 | String | IP地址模板集合实例ID，例如：ipmg-dih8xdbq。 示例值： ipmg-oono4p1w |
| AddressTemplateIdSet | 是 | 否 | Array of String | IP地址模板ID。 示例值： ['ipm-88t6207k','ipm-mdunqeb6'] |
| CreatedTime | 否 | 否 | String | 创建时间。 示例值： 2018-06-21 11:32:29 |
| AddressTemplateSet | 是 | 否 | Array of AddressTemplateItem | IP地址模板实例。 示例值：查看 |
| TagSet | 否 | 否 | Array of Tag | 标签信息 示例值：查看 |
| UpdatedTime | 否 | 否 | String | string 示例值： 最后更新时间。 |
RoutePolicyEntry
路由接收策略条目。
被如下接口引用：DescribeRoutePolicies
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| RouteType | 否 | 是 | String | 路由类型。 USER：用户自定义类型。 NETD：网络探测下发的路由。 CCN：云联网路由。 示例值： CCN |
| ObjectId | 否 | 是 | String | 对象ID。 示例值： ccn-48kdyb1d |
| CreatedTime | 否 | 是 | String | 创建时间。 示例值： 2023-05-20 15:06:34 |
| Region | 否 | 是 | String | 地域。 示例值： ap-region |
| RoutePolicyEntryId | 否 | 是 | String | 路由策略条目IPv4唯一ID。 示例值： rrpi-hd7hsfhh |
| Description | 否 | 是 | String | 路由策略规则描述。 示例值： demo |
| GatewayType | 否 | 是 | String | 下一跳类型。目前我们支持的类型有： CVM：公网网关类型的云服务器； VPN：VPN网关； DIRECTCONNECT：专线网关； PEERCONNECTION：对等连接； HAVIP：高可用虚拟IP； NAT：NAT网关; EIP：云服务器的公网IP； LOCAL_GATEWAY：本地网关; PVGW：PVGW网关。 示例值： CVM |
| GatewayId | 否 | 是 | String | 网关唯一ID。 示例值： 172.16.16.37 |
| Priority | 否 | 是 | Uint64 | 优先级。数值越小，优先级越高。 示例值： 100 |
| Action | 否 | 是 | String | 动作。 DROP：丢弃。 DISABLE：接收且禁用。 ACCEPT：接收且启用。 示例值： ACCEPT |
| CidrBlock | 否 | 是 | String | 目标网段。 示例值： 13.0.0.0/16 |
ServiceTemplateGroup
协议端口模板集合
被如下接口引用：CreateServiceTemplateGroup、DescribeServiceTemplateGroups
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| ServiceTemplateGroupId | 是 | 否 | String | 协议端口模板集合实例ID，例如：ppmg-2klmrefu。 示例值： ppmg-p4oaqawq |
| ServiceTemplateGroupName | 是 | 否 | String | 协议端口模板集合名称。 示例值： demo |
| ServiceTemplateIdSet | 是 | 否 | Array of String | 协议端口模板实例ID。 示例值： ["ppm-529nwwj8", "ppm-4dw6agho"] |
| CreatedTime | 否 | 否 | String | 创建时间。 示例值： 2018-06-21 11:32:29 |
| ServiceTemplateSet | 是 | 否 | Array of ServiceTemplate | 协议端口模板实例信息。 示例值：查看 |
| TagSet | 否 | 否 | Array of Tag | 标签信息 示例值：查看 |
| UpdatedTime | 否 | 否 | String | 更新时间 示例值： 2018-06-21 11:32:29 |
Tag
标签键值对
被如下接口引用：AllocateAddresses、AllocateIp6AddressesBandwidth、CloneSecurityGroup、CreateAddressTemplate、CreateAddressTemplateGroup、CreateAndAttachNetworkInterface、CreateAssistantCidr、CreateCustomerGateway、CreateDefaultSecurityGroup、CreateDirectConnectGateway、CreateHaVip、CreateIpv6Routes、CreateNatGateway、CreateNetDetect、CreateNetworkAcl、CreateNetworkInterface、CreateRouteTable、CreateRoutes、CreateSecurityGroup、CreateSecurityGroupWithPolicies、CreateServiceTemplate、CreateServiceTemplateGroup、CreateSubNetworkInterface、CreateSubnet、CreateSubnets、CreateVpc、CreateVpcEndPoint、CreateVpcEndPointService、CreateVpnConnection、CreateVpnGateway、DeleteNetworkInterfaces、DescribeAddressTemplateGroups、DescribeAddressTemplates、DescribeAddresses、DescribeAssistantCidr、DescribeCustomerGateways、DescribeDirectConnectGateways、DescribeFlowLogs、DescribeHaVips、DescribeIp6Addresses、DescribeNatGateways、DescribeNetDetects、DescribeNetworkAcls、DescribeNetworkInterfaces、DescribeNetworkInterfacesEx、DescribeNetworkInterfacesExtra、DescribeRoutePolicies、DescribeRouteTables、DescribeSecurityGroups、DescribeServiceTemplateGroups、DescribeServiceTemplates、DescribeSubnets、DescribeVpcEndPoint、DescribeVpcEndPointService、DescribeVpcPeeringConnections、DescribeVpcs、DescribeVpnConnections、DescribeVpnGateways、ModifyAssistantCidr
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Key | 是 | 是 | String | 标签键 示例值： tag-key |
| Value | 是 | 是 | String | 标签值 示例值： tag-value |
NatGatewayLimitSet
VPC的NAT配额数量，和当前剩余可创建的NAT网关数量
被如下接口引用：DescribeNatGatewayLimits
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| UniqVpcId | 是 | 否 | String | VPC实例ID。 示例值： vpc-9865478 |
| TotalLimit | 是 | 否 | Uint64 | VPC的NAT网关配额总数 示例值： 3 |
| Available | 是 | 否 | Uint64 | VPC剩余可以创建的NAT网关数量 示例值： 2 |
DfwOssSvcOperateResult
复杂类型: DfwOssSvcOperateResult
被如下接口引用：CreateAddrToSvcInternal、CreateSvcToUsgInternal、DeleteAddrFromSvcInternal、DeleteSvcFromUsgInternal
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| SvcId | 否 | 否 | String | 原DFW APIv2名称: addAddrToSvc.svcid 示例值： 78202_12.2.2.3_3600_0 |
| ErrorCode | 否 | 否 | Int64 | 原DFW APIv2名称: addAddrToSvc.errorCode 示例值： 0 |
| ErrorInfo | 否 | 否 | String | 原DFW APIv2名称: addAddrToSvc.errorInfo 示例值： success |
TrafficMirrorFilter
流量镜像五元组过滤规则对象
被如下接口引用：CreateTrafficMirror、DescribeTrafficMirrors、ResetTrafficMirrorFilter、UpdateTrafficMirrorAllFilter
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| SrcNet | 是 | 否 | String | 过滤规则的源网段 示例值： 10.0.0.0/24 |
| DstNet | 是 | 否 | String | 过滤规则的目的网段 示例值： 192.168.0.0/24 |
| SrcPort | 否 | 否 | String | 过滤规则的源端口，默认值1-65535 示例值： 5000 |
| DstPort | 否 | 否 | String | 过滤规则的目的端口，默认值1-65535 示例值： 3456 |
| Protocol | 是 | 否 | String | 过滤规则的协议 示例值： ALL |
DfwOssGetUsgFromSvcResult
复杂类型: DfwOssGetUsgFromSvcResult
被如下接口引用：DescribeUSGFromSvcInternal
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| SvcId | 否 | 否 | String | 原DFW APIv2名称: getUsgFromSvc.svcid 示例值： vpce-kifyia9o |
| UsgIdList | 否 | 否 | Array of String | 原DFW APIv2名称: getUsgFromSvc.usgids 示例值： ['sg-h4q2qsjv'] |
| UsgInfo | 否 | 否 | Array of DfwOssUSG | 原DFW APIv2名称: getUsgFromSvc.usginfo 示例值：查看 |
PeerConnection
对等连接实例信息。
被如下接口引用：DescribeVpcPeeringConnections
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| VpcId | 是 | 否 | String | 本端VPC唯一ID。 示例值： vpc-67wlqf6v |
| VpcName | 是 | 否 | String | 本端VPC名称。 示例值： demo |
| VpcCidrBlock | 是 | 否 | String | 本端VPC的IPv4CIDR。 示例值： 10.0.0.0/8 |
| PeerVpcId | 是 | 否 | String | 对端VPC唯一ID。 示例值： vpc-demo5678 |
| PeerVpcName | 是 | 否 | String | 对端VPC名称。 示例值： demo |
| PeerVpcCidrBlock | 是 | 否 | String | 对端VPC的IPv4CIDR。 示例值： 172.0.0.0/8 |
| PeeringConnectionId | 是 | 否 | String | 对等连接唯一ID。 示例值： pcx-demojkt4 |
| PeeringConnectionName | 是 | 否 | String | 对等连接名称。 示例值： Example |
| State | 是 | 否 | String | 对等连接状态，PENDING，投放中；ACTIVE，使用中；REJECTED，已拒绝‘DELETED，已删除；FAILED，失败。 示例值： PEDNING |
| Type | 是 | 否 | Int64 | 0：基础网络互通；1：vpc间互通；2：vpc与黑石网络互通； 示例值： VPC_PEER |
| IsNgw | 是 | 否 | Int64 | 0:是NewAfc；1:不是。 示例值： true |
| Bandwidth | 是 | 否 | Int64 | 对等连接带宽值。 示例值： 10 |
| SrcRegion | 是 | 否 | String | 本端地域。 示例值： 500001 |
| DstRegion | 是 | 否 | String | 对端地域。 示例值： 500002 |
| CreateTime | 是 | 否 | String | 创建时间。 示例值： 2019-01-15 11:07:15 |
| AppId | 是 | 否 | Int64 | 本端APPID。 示例值： jkt456789 |
| PeerAppId | 是 | 否 | Int64 | 对端APPID。 示例值： jkt456789 |
| Uin | 是 | 否 | Uint64 | UIN。 示例值： 100000072292 |
| TagSet | 否 | 是 | Array of Tag | Tag信息 示例值：查看 |
| PeerUin | 否 | 否 | Uint64 | 对端uin 示例值： 100000072292 |
| ChargeType | 否 | 否 | String | 最近变更类型 示例值： POSTPAID_BY_DAY_MAX |
Ipv6Address
IPv6地址信息。
被如下接口引用：AssignIpv6Addresses、CreateAndAttachNetworkInterface、CreateNetworkInterface、DeleteNetworkInterfaces、DescribeNetworkInterfaces、DescribeNetworkInterfacesEx、DescribeNetworkInterfacesExtra、ModifyIpv6AddressesAttribute、UnassignIpv6Addresses
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| AddressType | 否 | 否 | String | IPv6地址的类型: GUA(全球单播地址), ULA(唯一本地地址)示例值： ULA |
| Address | 是 | 否 | String | IPv6地址，形如：3402:4e00:20:100:0:8cd9:2a67:71f3示例值： 3402:4e00:20:1202::1 |
| Primary | 否 | 否 | Bool | 是否是主IP。示例值： false |
| AddressId | 否 | 否 | String | EIP实例ID，形如：eip-hxlqja90。作为入参数时，可通过DescribeAddresses接口获取。示例值： eip-5k6fot41 |
| Description | 否 | 否 | String | 描述信息。 示例值： demo |
| IsWanIpBlocked | 否 | 否 | Bool | 公网IP是否被封堵。 示例值： false |
| State | 否 | 否 | String | IPv6地址状态：PENDING：生产中MIGRATING：迁移中DELETING：删除中AVAILABLE：可用的示例值： AVAILABLE |
| PublicIpAddress | 否 | 否 | String | 如果 IPv6地址是 ULA 类型，绑定的公网IP地址。 示例值： 3402:4e00:20:1202::2 |
VpcOssRouteForDeleteRouteInternal
复杂类型: VpcOssRouteForDeleteRouteInternal
被如下接口引用：CreateRouteInternal、CreateServiceInternal、DeleteRouteInternal
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| PrivateIp | 否 | 否 | String | 原VPC OSS APIv2名称: DelRoute.pip 示例值： 10.19.0.121 |
| ProtocolPort | 否 | 否 | Int64 | 原VPC OSS APIv2名称: DelRoute.pport 示例值： 8080 |
| Weight | 否 | 否 | Int64 | 原VPC OSS APIv2名称: DelRoute.weight 示例值： 10 |
| ZoneId | 否 | 否 | Int64 | 原VPC OSS APIv2名称: DelRoute.zoneId 示例值： 50001 |
| UdpOption | 否 | 否 | Int64 | 原VPC OSS APIv2名称: DelRoute.udpOption 示例值： 1 |
| HostIp | 否 | 否 | String | 原VPC OSS APIv2名称: DelRoute.hostIp 示例值： 1.1.1.1 |
VpcOssDocker
复杂类型: VpcOssDocker
被如下接口引用：DescribeDockerInternal、DescribeDockerSubnetInternal
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Mask | 否 | 否 | String | 掩码 示例值： 255.255.0.0 |
| IntMask | 否 | 否 | Int64 | 整数掩码 示例值： 16 |
| CreateTime | 否 | 否 | String | 原VPC OSS APIv2名称: GetDockerSubnet.createTime 示例值： 2021-12-28 16:42:40 |
| Subnet | 否 | 否 | String | 子网地址 示例值： 10.0.0.0 |
| VpcId | 否 | 否 | Int64 | 整数vpcId 示例值： 78257 |
| UniqueVpcId | 否 | 否 | String | 对外唯一VpcId 示例值： vpc-jmaywf6r |
TrafficMirror
流量镜像实例
被如下接口引用：CreateTrafficMirror、DescribeTrafficMirrors
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| VpcId | 是 | 否 | String | VPC实例ID 示例值： vpc-7zayowkt |
| TrafficMirrorId | 是 | 否 | String | 流量镜像实例 示例值： imgf-oc2mpbni |
| TrafficMirrorName | 是 | 否 | String | TrafficMirrorName 示例值： demo_vxlan |
| TrafficMirrorDescribe | 是 | 否 | String | 流量镜像描述 示例值： desc |
| State | 是 | 否 | String | 流量镜像状态 示例值： RUNNING |
| Direction | 是 | 否 | String | 流量镜像采集方向 示例值： ALL |
| CollectorSrcs | 是 | 否 | Array of String | 流量镜像采集对象 示例值： ["vpc-7zayowkt"] |
| NatId | 是 | 否 | String | 流量镜像过滤的nat网关实例ID 示例值： "" |
| CollectorNormalFilters | 是 | 否 | Array of TrafficMirrorFilter | 流量镜像过滤的五元组规则 示例值：查看 |
| CollectorTarget | 是 | 否 | TrafficMirrorTarget | 流量镜接收目标 示例值：查看 |
| CreateTime | 是 | 否 | String | 流量镜像创建时间 示例值： 2021-03-02 14:41:15 |
SecurityGroupAssociationStatistics
安全组关联的实例统计
被如下接口引用：DescribeSecurityGroupAssociationStatistics
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| SecurityGroupId | 是 | 否 | String | 安全组实例ID。 示例值： sg-o62agjal |
| CVM | 是 | 否 | Uint64 | 云服务器实例数。 示例值： 2 |
| CDB | 是 | 否 | Uint64 | 数据库实例数。 示例值： 2 |
| ENI | 是 | 否 | Uint64 | 弹性网卡实例数。 示例值： 2 |
| SG | 是 | 否 | Uint64 | 被安全组引用数。 示例值： 2 |
| CLB | 是 | 否 | Uint64 | 负载均衡实例数。 示例值： 2 |
| InstanceStatistics | 是 | 否 | Array of InstanceStatistic | 全量实例的绑定统计。 示例值：查看 |
| TotalCount | 是 | 否 | Uint64 | 所有资源的总计数（不包含被安全组引用数）。 示例值： 10 |
DfwOssGetUsgFromSvcRequest
复杂类型: DfwOssGetUsgFromSvcRequest
被如下接口引用：DeleteSvcFromUsgInternal、DescribeUSGFromSvcInternal
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| SvcId | 否 | 否 | String | 原DFW APIv2名称: getUsgFromSvc.svcid 示例值： vpce-kifyia9o |
AddressTemplateSpecification
IP地址模板
被如下接口引用：CreateSecurityGroupPolicies、CreateSecurityGroupWithPolicies、DeleteSecurityGroupPolicies、DescribeSecurityGroupPolicies、DescribeSecurityGroupPolicyTemplates、ModifySecurityGroupPolicies、ReplaceSecurityGroupPolicies、ReplaceSecurityGroupPolicy
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| AddressId | 是 | 否 | String | IP地址ID，例如：ipm-2uw6ujo6。 示例值： ipm-2uw6ujo6 |
| AddressGroupId | 是 | 否 | String | IP地址组ID，例如：ipmg-2uw6ujo6。 示例值： ipmg-2uw6ujo6 |
DfwOssVMPolicy
复杂类型: DfwOssVMPolicy
被如下接口引用：DescribeVmPolicyInternal
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Policy | 否 | 否 | Array of DfwOssPolicies | 原DFW APIv2名称: getVMPolicy.policy 示例值：查看 |
| IsolateLevel | 否 | 否 | Int64 | 原DFW APIv2名称: getVMPolicy.isolateLevel 示例值： 0 |
| Uuid | 否 | 否 | String | 原DFW APIv2名称: getVMPolicy.uuid 示例值： 84f9a2ad-6659-4864-808c-bd17f3c2acea |
| ErrorCode | 否 | 否 | Int64 | 原DFW APIv2名称: getVMPolicy.errorCode 示例值： 0 |
ServiceRoute
服务路由信息
被如下接口引用：DescribeServiceInternal
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Weight | 否 | 否 | Uint64 | 权重 示例值： 12 |
| ProtocolPort | 否 | 否 | Uint64 | 协议端口号 示例值： 21 |
| ZoneId | 否 | 否 | Uint64 | 可用区ID 示例值： 10002 |
| HostIp | 否 | 否 | String | 主机 ip 示例值： 193.0.0.1 |
| PrivateIP | 否 | 否 | String | 内网IP 示例值： 10.0.0.1 |
| ForwardingMode | 否 | 否 | Uint64 | Forwarding模式 示例值： 0 |
VpcOssSubnet
复杂类型: VpcOssSubnet
被如下接口引用：DescribeRoutingTableListDetailInternal
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| CdcFlag | 否 | 否 | Int64 | 原VPC OSS APIv2名称: GetRtbListDetail.bCdc 示例值： 0 |
| DefaultFlag | 否 | 否 | Int64 | 原VPC OSS APIv2名称: GetRtbListDetail.bDefault 示例值： 1 |
| UniqueCdcId | 否 | 否 | String | 原VPC OSS APIv2名称: GetRtbListDetail.uniqCdcId 示例值： cdc-asdqasd |
| UniqueSubnetId | 否 | 否 | String | 对外唯一SubnetId 示例值： subnet-dbrazzr0 |
| DhcpFlag | 否 | 否 | Int64 | 原VPC OSS APIv2名称: GetRtbListDetail.dhcpFlag 示例值： 0 |
| Subnet | 否 | 否 | String | 子网地址 示例值： 172.16.0.0 |
| Name | 否 | 否 | String | 名称 示例值： Default-Subnet |
| Mask | 否 | 否 | String | 掩码 示例值： 255.255.240.0 |
| ZoneId | 否 | 否 | Int64 | 原VPC OSS APIv2名称: GetRtbListDetail.zoneId 示例值： 100002 |
| IntMask | 否 | 否 | Int64 | 整数掩码 示例值： 20 |
| SubnetId | 否 | 否 | Int64 | 整数subnetId 示例值： 1990867 |
SecurityGroupReady
检查网卡安全组是否Ready
被如下接口引用：CheckNetworkInterfaceSecurityGroupReady
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| NetworkInterfaceId | 否 | 是 | String | 网卡唯一ID 示例值： eni-9865478 |
| IsReady | 否 | 是 | Bool | 网卡对应的安全组已经Ready 示例值： True |
FlowLog
流日志
被如下接口引用：CreateAndAttachNetworkInterface、CreateNetworkInterface、DeleteNetworkInterfaces、DescribeFlowLogs、DescribeNetworkInterfaces、DescribeNetworkInterfacesEx、DescribeNetworkInterfacesExtra
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| ResourceType | 是 | 否 | String | 流日志所属资源类型：VPC(私有网络)，SUBNET（子网），NETWORKINTERFACE（网卡），CCN（云联网），NAT（网络地址转换），DCG（专线网关）。 示例值： NETWORKINTERFACE |
| CloudLogId | 是 | 否 | String | 流日志存储ID。 示例值： 99991111-2222-4444-9999-222266663333 |
| CloudLogState | 是 | 否 | String | 流日志存储ID状态。SUCCESS（成功），DELETED（删除）。 示例值： SUCCESS |
| TagSet | 是 | 否 | Array of Tag | 标签列表，例如：[{"Key": "city", "Value": "region"}]。 示例值：查看 |
| StorageType | 是 | 否 | String | 消费端类型：cls、ckafka。 示例值： cls |
| Period | 否 | 否 | Uint64 | 流日志采集周期，只支持CCN类型流日志。取值范围（单位s）：60， 300， 600。 示例值： 300 |
| VpcId | 是 | 否 | String | 私有网络唯一ID。可通过DescribeVpcs接口获取。 示例值： vpc-pq9vxykj |
| ResourceId | 是 | 否 | String | 资源唯一ID。 示例值： eni-78ysaex1 |
| FlowLogDescription | 是 | 否 | String | 流日志描述信息。 示例值： demo |
| Enable | 是 | 否 | Bool | 是否启用，true-启用，false-停用。 示例值： true |
| CreatedTime | 是 | 否 | String | 流日志创建时间。 示例值： 2020-01-30 00:00:00 |
| FlowLogId | 是 | 否 | String | 流日志唯一ID。 示例值： fl-f42uhpkj |
| FlowLogName | 是 | 否 | String | 流日志实例名字。 示例值： test-flowlog |
| TrafficType | 是 | 否 | String | 流日志采集类型，ACCEPT（允许），REJECT（拒绝），ALL（全部）。 示例值： ACCEPT |
| FlowLogStorage | 是 | 否 | FlowLogStorage | 消费端信息，当消费端类型为ckafka时返回。 示例值：查看 |
| CloudLogRegion | 是 | 否 | String | 流日志存储ID对应的地域信息。 示例值： ap-region |
| Region | 是 | 否 | String | 地域。 示例值： ap-region |
VpcIpv6Address
VPC内网IPv6对象。
被如下接口引用：DescribeVpcIpv6Addresses
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Ipv6Address | 是 | 否 | String | VPC内IPv6地址。示例值： CVM/ENI |
| CidrBlock | 是 | 否 | String | 所属子网 IPv6 CIDR。示例值： 192.241.0.0/24 |
| Ipv6AddressType | 是 | 否 | String | IPv6类型。示例值： CVM/ENI |
| CreatedTime | 是 | 否 | String | IPv6申请时间。示例值： 2019-03-11T17:58:07 |
AlgType
ALG协议类型
被如下接口引用：DescribeAddresses、DescribeIp6Addresses
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Ftp | 是 | 否 | Bool | Ftp协议Alg功能是否开启 示例值： Ture |
| Sip | 是 | 否 | Bool | Sip协议Alg功能是否开启 示例值： Ture |
SubNetworkInterface
中继网卡信息
被如下接口引用：CreateSubNetworkInterface
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| NetworkInterfaceDescription | 否 | 否 | String | 网卡备注信息。 示例值： description |
| SubnetId | 是 | 否 | String | 子网实例id。 示例值： sub-34rfgt56 |
| PrivateIpAddresses | 否 | 否 | Array of PrivateIpAddressForSubNetWorkInterface | 内网ip信息，单次最多指定10个，与SecondaryPrivateIpAddressCount至少提供一个。 示例值：查看 |
| SecondaryPrivateIpAddressCount | 否 | 否 | Uint64 | 新申请的内网IP地址个数与PrivateIpAddresses至少提供一个。内网IP地址个数总和不能超过配额数，详见<a href="/document/product/576/18527">弹性网卡使用限制。 示例值： 2 |
| SecurityGroupIds | 否 | 否 | Array of String | 安全组实例列表。 示例值： - |
| Tags | 否 | 否 | Array of Tag | 标签列表。 示例值：查看 |
| VpcId | 是 | 否 | String | 私有网络实例id。 示例值： vpc-m0c2kcun |
| NetworkInterfaceName | 是 | 否 | String | 网卡名称。 示例值： test |
InstanceCapableSet
机型支持能力列表
被如下接口引用：DescribeInstanceCapable
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| CapableType | 否 | 是 | String | 支持能力类型。 示例值： Trunking |
| InstanceFamilySet | 否 | 是 | Array of String | 支持能力的机型列表。 示例值： [ "S5" ] |
DfwOssUSGPolicy
复杂类型: DfwOssUSGPolicy
被如下接口引用：DescribeUSGPolicyInternal
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Version | 否 | 否 | Int64 | 原DFW APIv2名称: getUSGPolicy.version 示例值： 17 |
| UsgId | 否 | 否 | String | 原DFW APIv2名称: getUSGPolicy.usgId 示例值： sg-5q4brrmt |
| ErrorCode | 否 | 否 | Int64 | 原DFW APIv2名称: getUSGPolicy.errorCode 示例值： 0 |
| Inbound | 否 | 否 | Array of DfwOssUSGPolicyItem | 原DFW APIv2名称: getUSGPolicy.inbound 示例值：查看 |
| Outbound | 否 | 否 | Array of DfwOssUSGPolicyItem | 原DFW APIv2名称: getUSGPolicy.outbound 示例值：查看 |
Message
异步任务返回结果信息
被如下接口引用：DescribeTaskResult
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Code | 是 | 否 | Int64 | 错误码 示例值： -1 |
| Detail | 否 | 否 | String | 详细信息 示例值： |
| Error | 是 | 否 | String | 错误信息 示例值： |
NetworkAclEntrySet
网络ACL规则集合
被如下接口引用：DeleteNetworkAclEntries、ModifyNetworkAclEntries
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Ingress | 否 | 否 | Array of NetworkAclEntry | 入站规则。 示例值：查看 |
| Egress | 否 | 否 | Array of NetworkAclEntry | 出站规则。 示例值：查看 |
InstanceReady
用于检查子机及相关的路由表项、安全组是否在母机上下发完成
被如下接口引用：CheckVmReady
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| InstanceId | 否 | 是 | String | 子机实例ID 示例值： token |
| IsReady | 否 | 是 | Bool | 是否Ready 示例值： token |
GatewayFlowMonitorDetail
网关流量监控明细
被如下接口引用：DescribeGatewayFlowMonitorDetail
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| PrivateIpAddress | 是 | 否 | String | 来源IP。示例值： 10.0.1.21 |
| InPkg | 是 | 否 | Uint64 | 入包量。 示例值： 100 |
| OutPkg | 是 | 否 | Uint64 | 出包量。 示例值： 100 |
| InTraffic | 是 | 否 | Uint64 | 入带宽，单位：Byte。示例值： 100 |
| OutTraffic | 是 | 否 | Uint64 | 出带宽，单位：Byte。示例值： 100 |
InternetPriceDetail
公网IP询价出参
被如下接口引用：InquiryPriceAllocateAddresses、InquiryPriceAllocateIp6AddressesBandwidth、InquiryPriceCreateIp6Translators、InquiryPricePublicIp6Addresses
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| UnitPrice | 否 | 否 | Float | 付费单价，单位：元。 示例值： 1 |
| DiscountPrice | 否 | 否 | Float | 打折后单价，单位：元。 示例值： 1 |
| ChargeUnit | 否 | 否 | String | 计价单元，可取值范围： HOUR：表示计价单元是按每小时来计算。当前涉及该计价单元的场景有：流量按小时后付费（TRAFFIC_POSTPAID_BY_HOUR）、带宽按小时后付费（BANDWIDTH_POSTPAID_BY_HOUR）： MONTH：表示计价单元是按每月来计算。当前涉及该计价单元的场景有：带宽按月后付费（BANDWIDTH_POSTPAID_BY_MONTH）、带宽按月预付费（BANDWIDTH_PREPAID_BY_MONTH）、带宽包计费（BANDWIDTH_PACKAGE）。 示例值： HOUR |
RouteTableAssociation
路由表关联关系
被如下接口引用：CreateIpv6Routes、CreateRouteTable、CreateRoutes、DescribeRouteTables
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| SubnetId | 是 | 否 | String | 子网实例ID。 示例值： subnet-8qywqc4y |
| RouteTableId | 是 | 否 | String | 路由表实例ID。 示例值： rtb-q8o2z892 |
DfwOssDryRunFlowInObjectCheckResult
复杂类型：DfwOssDryRunFlowInObjectCheckResult
被如下接口引用：DescribeDryRunFlowInObjectInternal
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Object | 是 | 否 | String | 原DFW APIv2名称: dryrunFlowInObject.object 示例值： 84f9a2ad-6659-4864-808c-bd17f3c2acea |
| CheckResult | 是 | 否 | String | 原DFW APIv2名称: dryrunFlowInObject.check_result 示例值： ACCEPT |
ISPIPv6CidrBlock
返回多运营商IPv6 Cidr Block
被如下接口引用：AssignIpv6CidrBlocks、CreateVpc、DescribeVpcs
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| IPv6CidrBlock | 是 | 否 | String | IPv6 CIdr Block 示例值： 2402:4e00:1717:8200::/56 |
| ISPType | 是 | 否 | String | 网络运营商类型 取值范围:'BGP'-默认, 'CMCC'-运营商, 'CTCC'-运营商, 'CUCC'-运营商 示例值： BGP |
| AddressType | 否 | 否 | String | IPv6 Cidr 的类型：GUA(全球单播地址), ULA(唯一本地地址)示例值： GUA |
NetDetect
网络探测对象。
被如下接口引用：CreateNetDetect、DescribeNetDetects
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| VpcId | 是 | 否 | String | VPC实例ID。形如：vpc-demoag78示例值： vpc-67wlqf6v |
| VpcName | 是 | 否 | String | VPC实例名称。示例值： demo |
| SubnetId | 是 | 否 | String | 子网实例ID。形如：subnet-demoag78。 示例值： subnet-8qywqc4y |
| TagSet | 否 | 是 | Array of Tag | Tag信息 示例值：查看 |
| SubnetName | 是 | 否 | String | 子网实例名称。 示例值： demo |
| NetDetectId | 是 | 否 | String | 网络探测实例ID。形如：netd-demoag78。 示例值： netd-7s4wt576 |
| NetDetectName | 是 | 否 | String | 网络探测名称，最大长度不能超过60个字节。 示例值： demo |
| DetectDestinationIp | 是 | 否 | Array of String | 探测目的IPv4地址数组，最多两个。 示例值： ['1.1.1.3', '1.1.1.8'] |
| DetectSourceIp | 是 | 否 | Array of String | 系统自动分配的探测源IPv4数组。长度为2。 示例值： ['1.1.1.3', '1.1.1.8'] |
| NextHopType | 是 | 否 | String | 下一跳类型，目前我们支持的类型有： VPN：VPN网关； DIRECTCONNECT：专线网关； PEERCONNECTION：对等连接； NAT：NAT网关； NORMAL_CVM：普通云服务器； 示例值： CVM |
| NextHopDestination | 是 | 否 | String | 下一跳目的网关，取值与“下一跳类型”相关： 下一跳类型为VPN，取值VPN网关ID，形如：vpngw-demoag78； 下一跳类型为DIRECTCONNECT，取值专线网关ID，形如：dcg-demoag78； 下一跳类型为PEERCONNECTION，取值对等连接ID，形如：pcx-demoag78； 下一跳类型为NAT，取值Nat网关，形如：nat-demoag78； 下一跳类型为NORMAL_CVM，取值云服务器IPv4地址，形如：10.0.0.12； 示例值： 10.0.0.198 |
| NextHopName | 是 | 是 | String | 下一跳网关名称。 示例值： demo |
| NetDetectDescription | 是 | 是 | String | 网络探测描述。 示例值： demo |
| CreateTime | 是 | 是 | Datetime | 创建时间。 示例值： 2018-06-21 11:32:29 |
| Status | 否 | 否 | String | NFV网络探测状态。 示例值： RUNNING |
ConflictSource
冲突资源信息。
被如下接口引用：CheckAssistantCidr
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| ConflictSourceId | 是 | 否 | String | 冲突资源ID 示例值： rtb-4t7fr3fi |
| SourceItem | 是 | 否 | String | 冲突资源 示例值： 10.0.0.0/16 |
| ConflictItemSet | 是 | 否 | Array of ConflictItem | 冲突资源条目信息 示例值：查看 |
ResourceDashboard
VPC资源看板（各资源个数）
被如下接口引用：DescribeVpcResourceDashboard
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| VpcId | 是 | 否 | String | Vpc实例ID，例如：vpc-f1xjkw1b。 示例值： vpc-bq4bzxpj |
| SubnetId | 是 | 否 | String | 子网实例ID，例如：subnet-bthucmmy。 示例值： subnet-bthucmmy |
| Classiclink | 是 | 否 | Uint64 | 基础网络互通。 示例值： 0 |
| Dcg | 是 | 否 | Uint64 | 专线网关。 示例值： 1 |
| Pcx | 是 | 否 | Uint64 | 对等连接。 示例值： 0 |
| Ip | 是 | 否 | Uint64 | 当前已使用的IP总数。 示例值： 0 |
| Nat | 是 | 否 | Uint64 | NAT网关。 示例值： 1 |
| Vpngw | 是 | 否 | Uint64 | VPN网关。 示例值： 0 |
| FlowLog | 是 | 否 | Uint64 | 流日志。 示例值： 0 |
| NetworkDetect | 是 | 否 | Uint64 | 网络探测。 示例值： 0 |
| NetworkACL | 是 | 否 | Uint64 | 网络ACL。 示例值： 0 |
| CVM | 是 | 否 | Uint64 | 云主机。 示例值： 2 |
| LB | 是 | 否 | Uint64 | 负载均衡。 示例值： 0 |
| CDB | 是 | 否 | Uint64 | 关系型数据库。 示例值： 0 |
| Cmem | 是 | 否 | Uint64 | 云数据库 DB for Memcached。 示例值： 0 |
| CTSDB | 是 | 否 | Uint64 | 时序数据库。 示例值： 0 |
| MariaDB | 是 | 否 | Uint64 | 数据库 DB for MariaDB（TDSQL）。 示例值： 0 |
| SQLServer | 是 | 否 | Uint64 | 数据库 DB for SQL Server。 示例值： 0 |
| Postgres | 是 | 否 | Uint64 | 云数据库 DB for PostgreSQL。 示例值： 0 |
| NAS | 是 | 否 | Uint64 | 网络附加存储。 示例值： 0 |
| Greenplumn | 是 | 否 | Uint64 | Snova云数据仓库。 示例值： 0 |
| Ckafka | 是 | 否 | Uint64 | 消息队列 CKAFKA。 示例值： 0 |
| Grocery | 是 | 否 | Uint64 | Grocery。 示例值： 0 |
| HSM | 是 | 否 | Uint64 | 数据加密服务。 示例值： 0 |
| Tcaplus | 是 | 否 | Uint64 | 游戏存储 Tcaplus。 示例值： 0 |
| Cnas | 是 | 否 | Uint64 | Cnas。 示例值： 0 |
| TiDB | 是 | 否 | Uint64 | HTAP 数据库 TiDB。 示例值： 0 |
| Emr | 是 | 否 | Uint64 | EMR 集群。 示例值： 0 |
| SEAL | 是 | 否 | Uint64 | SEAL。 示例值： 0 |
| CFS | 是 | 否 | Uint64 | 文件存储 CFS。 示例值： 0 |
| Oracle | 是 | 否 | Uint64 | Oracle。 示例值： 0 |
| ElasticSearch | 是 | 否 | Uint64 | ElasticSearch服务。 示例值： 0 |
| TBaaS | 是 | 否 | Uint64 | 区块链服务。 示例值： 0 |
| Itop | 是 | 否 | Uint64 | Itop。 示例值： 0 |
| DBAudit | 是 | 否 | Uint64 | 云数据库审计。 示例值： 0 |
| CynosDBPostgres | 是 | 否 | Uint64 | 企业级云数据库 CynosDB for Postgres。 示例值： 0 |
| Redis | 是 | 否 | Uint64 | 数据库 DB for Redis。 示例值： 0 |
| MongoDB | 是 | 否 | Uint64 | 数据库 DB for MongoDB。 示例值： 0 |
| DCDB | 是 | 否 | Uint64 | 分布式数据库 DB for TDSQL。 示例值： 0 |
| CynosDBMySQL | 是 | 否 | Uint64 | 企业级云数据库 CynosDB for MySQL。 示例值： 0 |
| Subnet | 是 | 否 | Uint64 | 子网。 示例值： 1 |
| RouteTable | 是 | 否 | Uint64 | 路由表。 示例值： 1 |
| JNS | 否 | 否 | Uint64 | JNS 服务 示例值： 2 |
| ENI | 否 | 否 | Uint64 | 弹性网卡 示例值： 2 |
| CDM | 否 | 否 | Uint64 | CDM 示例值： 2 |
| CCN | 否 | 否 | Uint64 | 云联网 示例值： 2 |
| HAVIP | 否 | 否 | Uint64 | 高可用虚拟Ip 示例值： 2 |
| IPv6 | 否 | 否 | Uint64 | IPv6 示例值： 2 |
| LocalGateway | 否 | 否 | Uint64 | 本地网关 示例值： 2 |
| OAA | 否 | 否 | Uint64 | OAA 示例值： 2 |
| VPCEndPoint | 否 | 否 | Uint64 | 终端节点 示例值： 2 |
DfwOssUSGQuota
复杂类型: DfwOssUSGQuota
被如下接口引用：DescribeUSGQuotaInternal
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| ReferedUsgCount | 是 | 否 | Uint64 | 原VPC OSS APIv2名称: getUSGById. referedUsgCount 示例值： 1 |
| CvmVifCount | 是 | 否 | Uint64 | 原VPC OSS APIv2名称: getUSGById. cvmVifCount 示例值： 1 |
| ExtendedPolicyCount | 是 | 否 | Uint64 | 原VPC OSS APIv2名称: getUSGById. extendedPolicyCount 示例值： 1 |
| PolicyCount | 是 | 否 | Uint64 | 原VPC OSS APIv2名称: getUSGById. policyCount 示例值： 1 |
| SvcCount | 是 | 否 | Uint64 | 原VPC OSS APIv2名称: getUSGById. svcCount 示例值： 1 |
| UsgInstanceCount | 是 | 否 | Uint64 | 原VPC OSS APIv2名称: getUSGById. usgInstanceCount 示例值： 1 |
| UsgCount | 是 | 否 | Uint64 | 原VPC OSS APIv2名称: getUSGById. usgCount 示例值： 1 |
| InstanceUsgCount | 是 | 否 | Uint64 | 原VPC OSS APIv2名称: getUSGById. instanceUsgCount 示例值： 1 |
InternetPrice
公网询价出参
被如下接口引用：InquiryPriceAllocateAddresses、InquiryPriceAllocateIp6AddressesBandwidth、InquiryPriceCreateIp6Translators、InquiryPricePublicIp6Addresses
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| AddressPrice | 否 | 否 | InternetPriceDetail | 公网IP询价详细参数。 示例值：查看 |
Subnet
子网对象
被如下接口引用：CreateAssistantCidr、CreateNetworkAcl、CreateSubnet、CreateSubnets、CreateVpc、DescribeAssistantCidr、DescribeNetworkAcls、DescribeSubnets、DescribeVpcs、ModifyAssistantCidr
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| VpcId | 是 | 否 | String | VPC实例ID。示例值： vpc-m0c2kcun |
| SubnetId | 是 | 否 | String | 子网实例ID，例如：subnet-bthucmmy。示例值： subnet-bthucmmy |
| SubnetName | 是 | 否 | String | 子网名称。 示例值： demo |
| HighPriorityRouteTableId | 否 | 否 | String | 子网关联的高优路由表实例ID，例如：hprtb-hd4tl8cg。 示例值： demo |
| ISPType | 否 | 否 | String | 运营商类型。'BGP'-默认, 'CMCC, 'CTCC', 'CUCC'。 示例值： BGP |
| CidrBlock | 是 | 否 | String | 子网的 IPv4 CIDR。示例值： 10.0.0.0/24 |
| IsDefault | 是 | 否 | Bool | 是否默认子网。 示例值： true |
| EnableBroadcast | 是 | 否 | Bool | 是否开启广播。 示例值： true |
| Zone | 是 | 否 | String | 可用区。 示例值： region |
| RouteTableId | 否 | 否 | String | 路由表实例ID，例如：rtb-l2h8d7c2。 示例值： rtb-l2h8d7c2 |
| CreatedTime | 否 | 否 | String | 创建时间。 示例值： 2018-04-04T10:15:16+08:00 |
| AvailableIpAddressCount | 是 | 否 | Uint64 | 可用IP数。示例值： 254 |
| Ipv6CidrBlock | 否 | 否 | String | 子网的 IPv6 CIDR。示例值： 3402:4e00:20:1200::/64 |
| NetworkAclId | 否 | 否 | String | 关联ACLID示例值： acl-l2h8d7c2 |
| IsRemoteVpcSnat | 否 | 否 | Bool | 是否为 SNAT 地址池子网。示例值： true |
| TotalIpAddressCount | 是 | 否 | Uint64 | 子网IP总数。示例值： 254 |
| TagSet | 是 | 否 | Array of Tag | 标签键值对。 示例值：查看 |
| Type | 否 | 否 | Uint64 | 子网类型。 示例值： 0/9 |
| VmNum | 否 | 是 | Uint64 | Vm数量。 示例值： 2 |
| ZoneId | 否 | 是 | Uint64 | 可用区ID。 示例值： 50001 |
| LocalZone | 否 | 否 | Bool | 是否是本地区域 示例值： 1 |
| IsCdcSubnet | 否 | 否 | Uint64 | 是否是cdc管控子网 示例值： 0 |
| CdcId | 否 | 否 | String | cdc Id 示例值： cluster-gbo27yc4 |
| BmsNum | 否 | 否 | Uint64 | 裸金属数量 示例值： 2 |
| IsShare | 否 | 否 | Bool | 是否是共享资源 示例值： True |
| Region | 否 | 否 | String | 地域。 示例值： sz |
| AddressType | 否 | 否 | String | 地址类型 示例值： BGP |
| GatewaySet | 否 | 否 | Array of GatewaySet | 网关地址 示例值：查看 |
CcnRegionBandwidthLimit
云联网（CCN）地域出带宽上限
被如下接口引用：DescribeCcnRegionBandwidthLimits、GetCcnRegionBandwidthLimits、SetCcnRegionBandwidthLimits
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Region | 是 | 否 | String | 地域，例如：ap-region 示例值： region |
| BandwidthLimit | 是 | 否 | Uint64 | 出带宽上限，单位：Mbps 示例值： 10 |
| IsBm | 否 | 否 | Bool | 是否黑石地域，默认false。示例值： true |
| DstRegion | 否 | 是 | String | 目的地域，例如：ap-region 示例值： ap-region |
| DstIsBm | 否 | 否 | Bool | 目的地域是否为黑石地域，默认false。示例值： true |
Ip6Translator
IPV6转换实例信息
被如下接口引用：DescribeIp6Translators
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Ip6TranslatorId | 是 | 否 | String | IPV6转换实例唯一ID，形如ip6-37xao8t 示例值： ip6-mhnrv51i |
| Ip6TranslatorName | 是 | 否 | String | IPV6转换实例名称 示例值： demo |
| Vip6 | 是 | 否 | String | IPV6地址 示例值： 2402:4e00:40:40::2:2a6 |
| IspName | 是 | 否 | String | IPV6转换地址所属运营商 示例值： BGP |
| TranslatorStatus | 是 | 否 | String | 转换实例状态，限于CREATING,RUNNING,DELETING,MODIFYING 示例值： RUNNING |
| CreatedTime | 是 | 否 | Datetime_iso | IPV6转换实例创建时间 示例值： 2020-01-30 00:00:00 |
| Ip6RuleCount | 是 | 否 | Int64 | 绑定的IPV6转换规则数量 示例值： 2 |
| Ip6RuleSet | 是 | 否 | Array of Ip6Rule | IPV6转换规则信息 示例值：查看 |
| CreatedTimeLocal | 否 | 否 | Datetime | IPV6转换实例创建本地时间 示例值： 2023-07-13T11:12:06 |
OldRouteSet
旧路由集合
被如下接口引用：ReplaceRoutes
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| RouteId | 否 | 否 | Uint64 | 路由Id 示例值： 16820 |
| DestinationCidrBlock | 否 | 否 | String | 目的网段 示例值： 169.254.128.0/17 |
| GatewayType | 否 | 否 | String | 网关类型 示例值： NORMAL_CVM |
| GatewayId | 否 | 否 | String | 网关Id 示例值： 172.16.16.37 |
| PublishedToVbc | 否 | 否 | Bool | 是否发布到云联网 示例值： true |
| RouteItemId | 否 | 否 | String | 路由唯一策略ID。 示例值： rti-9bjer08h |
| DestinationIpv6CidrBlock | 否 | 否 | String | 创建IPv6目的网段，取值不能在私有网络网段内，例如：2402:4e00:1000:810b::/64。 示例值： 3402:4e00:20:1200::/56 |
| CreatedTime | 否 | 否 | String | 创建时间 示例值： 2021-03-02 14:41:15 |
| RouteTableId | 否 | 否 | String | rtb-azd4dt1c 示例值： 路由表实例ID，例如：rtb-azd4dt1c。 |
| RouteDescription | 否 | 否 | String | 路由描述 示例值： demo |
NetDetectIpState
网络探测目的IP的验证结果。
被如下接口引用：CheckNetDetectState、DescribeNetDetectStates
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| DetectDestinationIp | 是 | 否 | String | 探测目的IPv4地址。 示例值： ['1.1.1.3', '1.1.1.8'] |
| State | 是 | 否 | Int64 | 探测结果。 0：成功； -1：查询不到路由丢包； -2：外出ACL丢包； -3：IN ACL丢包； -4：其他错误； 示例值： 0 |
| Delay | 是 | 否 | Uint64 | 时延，单位毫秒 示例值： 0 |
| PacketLossRate | 是 | 否 | Uint64 | 丢包率 示例值： 0 |
SubnetNum
子网数字ID
被如下接口引用：DescribeSubnetIds
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| VpcId | 是 | 否 | String | VPC实例ID。 示例值： vpc-demoag78 |
| VpcNumId | 是 | 否 | Uint64 | VPC实例数字ID。 示例值： 10 |
| SubnetId | 是 | 否 | String | 子网实例ID。 示例值： subnet-demoag78 |
| SubnetNumId | 是 | 否 | Uint64 | 子网实例数字ID。 示例值： 4643 |
| SubnetName | 否 | 否 | String | 子网名称，最大长度不能超过60个字节。 示例值： 4643 |
CcnLimit
云联网配额
被如下接口引用：DescribeCcnLimits
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Type | 是 | 否 | String | 云联网配额类型 示例值： 1 |
| Value | 是 | 否 | Uint64 | 云联网配额数值 示例值： 10 |
CustomerGatewayIdInfo
VPN对端网关信息
被如下接口引用：CreateVpnConnection、DescribeVpnConnections
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| CustomerGatewayId | 否 | 否 | String | 对端网关ID 示例值： cgw-nv9arh5n |
| UserGwAddr | 否 | 否 | String | 对端网关公网IP 示例值： 11.11.12.10 |
| Name | 否 | 否 | String | 对端网关名称 示例值： vpn-1 |
CidrForCcn
用于发布云联网的cidr信息
被如下接口引用：CreateIpv6Routes、CreateRouteTable、CreateRoutes、DescribeRouteTables
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Cidr | 否 | 否 | String | local cidr值。 示例值： 10.0.0.0/16 |
| PublishedToVbc | 否 | 否 | Bool | 是否发布到了云联网。 示例值： True |
| AssistantType | 否 | 否 | String | local cidr类型：NORMAL/DOCKER。 示例值： NORMAL |
DfwOssGetUSGCountFromSGRequest
复杂类型: DfwOssGetUSGCountFromSGRequest
被如下接口引用：DescribeUSGCountFromSgInternal、DescribeUSGQuotaInternal
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| SgId | 否 | 否 | String | 原DFW APIv2名称: getUSGQuota.sgId 示例值： 132134871 |
| Project | 否 | 否 | String | 原DFW APIv2名称: getUSGQuota.project 示例值： 132134871 |
InstanceStatistic
用于描述实例的统计信息
被如下接口引用：DescribeSecurityGroupAssociationStatistics
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| InstanceType | 是 | 否 | String | 实例的类型 示例值： CVM |
| InstanceCount | 是 | 否 | Uint64 | 实例的个数 示例值： 10 |
DfwOssUSGOperateResult
复杂类型: DfwOssUSGOperateResult
被如下接口引用：CreateUSGRuleInternal、DeleteUSGInternal、DeleteUSGRuleInternal
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| UsgId | 否 | 否 | String | 原DFW APIv2名称: insertUSGRule.usgId 示例值： sg-dn7qcw21 |
| ErrorCode | 否 | 否 | Int64 | 原DFW APIv2名称: insertUSGRule.errorCode 示例值： 0 |
| ErrorInfo | 否 | 否 | String | 原DFW APIv2名称: insertUSGRule.errorInfo 示例值： success |
PrivateIpAddressSpecification
内网IP信息
被如下接口引用：AssignPrivateIpAddresses、CreateAndAttachNetworkInterface、CreateNetworkInterface、CreateNetworkInterfaceEx、DeleteNetworkInterfaces、DescribeNetworkInterfaces、DescribeNetworkInterfacesEx、DescribeNetworkInterfacesExtra、ModifyPrivateIpAddressesAttribute、UnassignPrivateIpAddresses
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Primary | 否 | 否 | Bool | 是否是主IP。 示例值： false |
| PublicIpAddress | 否 | 否 | String | 公网IP地址。 示例值： 123.10.100.171 |
| AddressId | 否 | 否 | String | EIP实例ID，例如：eip-11112222。 示例值： eip-29mdigub |
| Description | 否 | 否 | String | 内网IP描述信息。 示例值： demo |
| IsWanIpBlocked | 否 | 否 | Bool | 公网IP是否被封堵。 示例值： false |
| State | 否 | 否 | String | IP状态： PENDING：生产中 MIGRATING：迁移中 DELETING：删除中 AVAILABLE：可用的 示例值： AVAILABLE |
| ResourceId | 否 | 否 | String | 保留IP指定绑定的资源ID。 示例值： cluster-12345678 |
| QosLevel | 否 | 否 | String | IP服务质量等级，可选值：PT（云金）、AU（云银）、AG(云铜）、DEFAULT（默认）。 示例值： PT |
| PrivateIpAddress | 是 | 否 | String | 内网IP地址。 示例值： 192.168.0.10 |
| PrivateIpState | 否 | 否 | String | 已废弃字段 示例值： AVAILABLE |
UsedDetailDownload
共享流量包的用量明细文件生成历史
被如下接口引用：DescribeDownloadSpecificTrafficPackageUsedDetails
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Id | 是 | 否 | Int64 | 生成历史唯一ID 示例值： 5 |
| TrafficPackageId | 是 | 否 | String | 共享流量包唯一ID 示例值： tfp-f7a3qh6x |
| StartTime | 是 | 否 | Datetime | 开始时间 示例值： 2021-10-10 10:00:00 |
| EndTime | 是 | 否 | Datetime | 结束时间 示例值： 2021-10-10 10:00:00 |
| DownloadUrl | 是 | 是 | String | 下载链接 示例值： https://ip-address-repo.cos.ap-region.mycloud.com |
| Filename | 是 | 否 | String | 文件名称 示例值： cos |
| Status | 是 | 否 | String | 任务状态. RUNNING-正在生成， SUCCESS-成功， FAIL-失败 示例值： RUNNING |
| ErrorMsg | 是 | 是 | String | 错误信息 示例值： time out |
| ExpiredAt | 是 | 是 | Datetime | 下载链接过期时间 示例值： 2021-10-10 10:00:00 |
| CreatedAt | 是 | 否 | Datetime | 文件生成时间 示例值： 2021-10-10 10:00:00 |
| IsExpired | 是 | 是 | Bool | 下载链接是否已经过期 示例值： True |
DfwOssDeleteUSGRuleRequest
复杂类型: DfwOssDeleteUSGRuleRequest
被如下接口引用：DeleteUSGRuleInternal
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Indexes | 否 | 否 | Array of Int64 | 原DFW APIv2名称: deleteUSGRule.indexes 示例值： [1, 2] |
| UsgId | 否 | 否 | String | 原DFW APIv2名称: deleteUSGRule.usgId 示例值： 487487 |
| Direction | 否 | 否 | String | 原DFW APIv2名称: deleteUSGRule.direction 示例值： inbound |
| Version | 否 | 否 | Int64 | 原DFW APIv2名称: deleteUSGRule.version 示例值： 12 |
DfwOssFlows
复杂类型: DfwOssFlows
被如下接口引用：DescribeDryRunFlowInObjectInternal
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| SrcIp | 否 | 否 | String | 原DFW APIv2名称: dryrunFlowInObject.srcip 示例值： 10.0.0.0 |
| DstIp | 否 | 否 | String | 原DFW APIv2名称: dryrunFlowInObject.dstip 示例值： 10.0.0.0 |
| Protocol | 否 | 否 | String | 原DFW APIv2名称: dryrunFlowInObject.protocol 示例值： tcp |
| DstPort | 否 | 否 | Int64 | 原DFW APIv2名称: dryrunFlowInObject.dstport 示例值： 80 |
NatGatewayQuota
NAT网关配额
被如下接口引用：DescribeNatGatewayQuota
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| BandwidthQuota | 是 | 否 | Uint64 | NAT网关带宽配额 示例值： 5000 |
Service
服务信息
被如下接口引用：DescribeServiceInternal
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| VpcId | 否 | 否 | String | vpc id 示例值： vpc-m0c2kcun |
| RouteSet | 否 | 否 | Array of ServiceRoute | 路由信息集合 示例值：查看 |
| GroupId | 否 | 否 | Array of Uint64 | 分组id 示例值： 5 |
| SetId | 否 | 否 | Uint64 | Set id 示例值： 0 |
| StickyTimeout | 否 | 否 | Uint64 | 会话保持超时时间 示例值： 0 |
| VipSetId | 否 | 否 | Uint64 | VIP集合id 示例值： 1 |
| VpcGatewayIp | 否 | 否 | String | 经专线访问的vpcgwip 示例值： 10.112.98.185 |
| VirtualPort | 否 | 否 | Uint64 | Vport端口号 示例值： 23 |
| HealthFlag | 否 | 否 | Uint64 | Health标识 示例值： 0 |
| SubnetRouteAlgorithm | 否 | 否 | Uint64 | hash 算法 示例值： 0 |
| BypassFlag | 否 | 否 | Uint64 | bypass 标识 示例值： 0 |
| ResetFlag | 否 | 否 | Uint64 | RST报文标识 示例值： 0 |
| Type | 否 | 否 | Uint64 | 类型 示例值： 1 |
| Protocol | 否 | 否 | String | 协议 示例值： udp |
| IpType | 否 | 否 | Uint64 | IP Type 示例值： 29 |
| ClassicVpcGatewayId | 否 | 否 | String | 经classiclink访问该vip的vpcgw集群 示例值： vpcgw-7hk7255d |
| VpcNumId | 否 | 否 | Int64 | Vpc数字Id 示例值： 122211 |
| VpcGatewayAttrFlag | 否 | 否 | Uint64 | 当vpcgw集群类型为3（按照RS可用区选择的vpcgw逻辑集群）时，标记是否按照vpcid + vip粒度的集群Id属性转发 示例值： 0 |
| SnatFlag | 否 | 否 | Uint64 | snat标识 示例值： 0 |
| StickyMaxCount | 否 | 否 | Uint64 | 会话保持表项最大值 示例值： 1 |
| RemoteVpcId | 否 | 否 | Uint64 | 远端VPCID 示例值： 0 |
| VpcGatewayId | 否 | 否 | String | 经cvm访问是的vpcgw集群id 示例值： vpcgw-7hk7255d |
| Business | 否 | 否 | String | 业务类型标识 示例值： dockerMaster |
| VpcGatewayZoneId | 否 | 否 | Uint64 | 当vpcgw集群类型为3（按照RS可用区选择的vpcgw逻辑集群）时，用来返回rs的可用区 示例值： 0 |
| FakeToaIp | 否 | 是 | String | fakeToaIp用于填充假的客户端 IP 示例值： 192.168.0.1 |
| ToaHostIpFlag | 否 | 否 | Uint64 | toa中是否携带client的母机ip标识 示例值： 0 |
| LbType | 否 | 否 | Uint64 | 是否是lb规则 示例值： 0 |
| VipVpcGatewayId | 否 | 否 | String | 切换vpcGwIp, 按vip所在子网的zone，就近选择vpcGwIp所对应的vpcgwid 示例值： vpcgw-7hk7255d |
| Vip | 否 | 否 | String | VIP信息 示例值： 172.16.48.216 |
| StickyFlag | 否 | 否 | Uint64 | 会话保持标识 示例值： 0 |
| RsZoneVpcGatewayId | 否 | 否 | Uint64 | 当vpcgw集群类型为3（按照RS可用区选择的vpcgw逻辑集群）时，标记是否按照vpcid + vip粒度转发的集群Id（bVpcgwAttrFlag=1时返回集群Id否则返回0表示关闭按照集群Id转发 示例值： 0 |
| DelPipRouteFlag | 否 | 否 | Int64 | 原VPC OSS APIv2名称: AddService. bDelPipRoute 示例值： 0 |
DfwOssUSGQuotaResult
复杂类型: DfwOssUSGQuotaResult
被如下接口引用：DescribeUSGQuotaInternal
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| SgId | 否 | 否 | String | 原DFW APIv2名称: getUSGQuota.sgId 示例值： 251197522 |
| Quota | 否 | 否 | DfwOssUSGQuota | 原DFW APIv2名称: getUSGQuota.quota 示例值：查看 |
AccountAttribute
账户属性对象
被如下接口引用：DescribeAccountAttributes
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| AttributeName | 是 | 否 | String | 属性名 示例值： supported-platforms |
| AttributeValues | 是 | 否 | Array of String | 属性值 示例值： ["VPC"] |
BgpConfigAndAsn
VPN通道BGP配置
被如下接口引用：CreateVpnConnection、DescribeVpnConnections
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| TunnelCidr | 否 | 否 | String | BGP通道CIDR 示例值： 169.254.128.0/30 |
| LocalBgpIp | 否 | 否 | String | 本端BGP IP 示例值： 169.254.128.1 |
| RemoteBgpIp | 否 | 否 | String | 对端BGP IP 示例值： 169.254.128.2 |
| LocalBgpAsn | 否 | 否 | String | 本端BGP ASN号 示例值： 31451 |
| RemoteBgpAsn | 否 | 否 | String | 对端BGP ASN号 示例值： 31452 |
CidrDetailSet
非标网段类型
被如下接口引用：DescribeNmsCidrs
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| AddrSegment | 否 | 否 | String | 非标网段地址 示例值： 10.0.0.0/8 |
| AddressType | 否 | 否 | String | 网络类型 示例值： Overlay |
| CreateTime | 否 | 否 | Datetime | 创建时间 示例值： 2024-05-22 11:58:26 |
| IsReserved | 否 | 否 | Uint64 | 是否是保留地址 示例值： 0 |
| Ver | 否 | 否 | String | 地址类型 示例值： IPv4 |
Ip6Rule
IPV6转换规则
被如下接口引用：DescribeIp6Translators
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Ip6RuleId | 是 | 否 | String | IPV6转换规则唯一ID，形如rule6-7v3vwgec 示例值： rule6-7v3vwgec |
| Ip6RuleName | 是 | 否 | String | IPV6转换规则名称 示例值： demo |
| Vip6 | 是 | 否 | String | IPV6地址 示例值： 3402:4e00:20:1200::/64 |
| Vport6 | 是 | 否 | Int64 | IPV6端口号 示例值： 443 |
| Protocol | 是 | 否 | String | 协议类型，支持TCP/UDP 示例值： TCP |
| Vip | 是 | 否 | String | IPV4地址 示例值： 10.0.0.14 |
| Vport | 是 | 否 | Int64 | IPV4端口号 示例值： 443 |
| RuleStatus | 是 | 否 | String | 转换规则状态，限于CREATING,RUNNING,DELETING,MODIFYING 示例值： RUNNING |
| CreatedTime | 是 | 否 | Datetime_iso | 转换规则创建时间 示例值： 2019-01-10T16:29:37 |
CrossSubNetworkInterface
跨租户中继网卡信息
被如下接口引用：CreateCrossSubNetworkInterface、DescribeCrossSubNetworkInterfaces
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| SecondaryPrivateIpAddressCount | 否 | 否 | Int64 | 申请内网IP的个数。 示例值： 2 |
| CreatedTime | 否 | 否 | String | 创建时间 示例值： 2022-02-22 10:45:25 |
| SecurityGroupIds | 否 | 否 | Array of String | 安全组。 示例值： ["sg-nukm37ni"] |
| BusinessType | 否 | 否 | Uint64 | 安全组业务类型 示例值： 1 |
| VlanId | 否 | 否 | Int64 | Vlan ID。 示例值： 1001 |
| NetworkInterfaceState | 否 | 否 | String | 弹性网卡状态：PENDING：创建中AVAILABLE：可用的ATTACHING：绑定中DETACHING：解绑中DELETING：删除中INUSE：已绑定示例值： AVAILABLE |
| BusinessOwner | 是 | 否 | String | 业务类型归属。 示例值： NFV |
| State | 否 | 否 | String | 弹性网卡状态：PENDING：创建中AVAILABLE：可用的ATTACHING：绑定中DETACHING：解绑中DELETING：删除中示例值： AVAILABLE |
| MacAddress | 否 | 否 | String | MAC地址。 示例值： 20:90:6F:70:7D:74 |
| VpcId | 是 | 否 | String | VPC实例ID。 示例值： vpc-m0c2kcun |
| NetworkInterfaceDescription | 否 | 否 | String | 网卡备注。 示例值： demo |
| SubnetId | 否 | 否 | String | 子网实例ID。 示例值： subnet-jx7x5riw |
| NetworkInterfaceId | 否 | 否 | String | 网卡实例ID。 示例值： eni-3efr45tg |
| TrunkingNetworkInterfaceId | 否 | 否 | String | 中继网卡所在的父网卡实例ID。 示例值： eni-3efr45tt |
| SecurityGroupStatisticsVisible | 否 | 否 | Bool | 是否支持安全组统计输出。 示例值： False |
| ElasticNetworkCardName | 否 | 否 | String | 网卡接口名 示例值： seni_vFspq39W |
| NetworkInterfaceName | 是 | 否 | String | 网卡名称。 示例值： demo |
| Business | 是 | 否 | String | 业务类型。 示例值： NFV |
| IsReservedAddress | 否 | 否 | Bool | 是否使用保留网段。 示例值： true |
| PrivateIpAddressSet | 否 | 否 | Array of PrivateIpAddressForSubNetWorkInterface | 内网IP信息。 示例值：查看 |
VpnGatewayQuota
VPN网关配额对象
被如下接口引用：CreateVpnGateway、DescribeVpnGatewayQuota、DescribeVpnGateways
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Bandwidth | 是 | 否 | Uint64 | 带宽配额 示例值： 100 |
| Cname | 是 | 否 | String | 配额名称 示例值： 大型 |
| Name | 是 | 否 | String | 配额英文名称 示例值： newlarge |
| MaxConnection | 否 | 是 | Array of Uint64 | SSL最大链接数 示例值： [5,10,20,50,100] |
AclRuleId
本端IP转换ACL规则ID复杂类型
被如下接口引用：DeleteLocalIpTranslationAclRule
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| AclRuleId | 是 | 否 | Int64 | ACL规则ID 示例值： 6 |
DfwOssDelAddrFromSvcRequest
复杂类型: DfwOssDelAddrFromSvcRequest
被如下接口引用：CreateAddrToSvcInternal、DeleteAddrFromSvcInternal
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| SvcId | 否 | 否 | String | 原DFW APIv2名称: delAddrFromSvc.svcid 示例值： 487487 |
| VpcId | 否 | 否 | Int64 | 整数vpcId 示例值： 1200 |
| Vip | 否 | 否 | String | 原DFW APIv2名称: delAddrFromSvc.vip 示例值： 12.2.2.3 |
| Protocol | 否 | 否 | Int64 | 原DFW APIv2名称: delAddrFromSvc.protocol 示例值： 0 |
| VirtualPort | 否 | 否 | Int64 | 原DFW APIv2名称: delAddrFromSvc.vport 示例值： 3600 |
VpcInfo
VPN对应VPC信息
被如下接口引用：CreateVpnConnection、DescribeVpnConnections
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| VpcId | 否 | 否 | String | VPC实例ID 示例值： vpc-q9s92j57 |
| VpcCidr | 否 | 否 | String | VPC CIDR 示例值： 172.16.0.0/12 |
| Name | 否 | 否 | String | VPC名称 示例值： vpc-01 |
LocalIpTranslationAclRule
本端IP转换ACL规则复杂类型
被如下接口引用：CreateLocalIpTranslationAclRule
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Protocol | 是 | 否 | String | 协议 示例值： tcp |
| SourcePort | 是 | 否 | String | 源端口 示例值： 80 |
| DestinationCidr | 是 | 否 | String | 目的IP 示例值： 1.1.1.0/16 |
| DestinationPort | 是 | 否 | String | 目的端口 示例值： 80 |
| Action | 否 | 否 | Int64 | 0 或 1 示例值： 0 |
VpcOssServiceRequest
复杂类型: VpcOssServiceRequest
被如下接口引用：DeleteServiceInternal
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| VirtualPort | 否 | 否 | Int64 | 原VPC OSS APIv2名称: DelService.vport 示例值： 22 |
| Sip | 否 | 否 | String | 原VPC OSS APIv2名称: DelService.sip 示例值： 1.1.1.1 |
| GroupId | 否 | 否 | Int64 | 原VPC OSS APIv2名称: DelService.groupId 示例值： 1 |
| VpcId | 否 | 否 | Int64 | 整数vpcId 示例值： 1 |
| UniqueVpcId | 否 | 否 | String | 对外唯一VpcId 示例值： vpc-jmaywf6r |
| Type | 否 | 否 | Int64 | 原VPC OSS APIv2名称: DelService.type 示例值： 0 |
| Protocol | 否 | 否 | String | 原VPC OSS APIv2名称: DelService.proto 示例值： tcp |
| Vip | 否 | 否 | String | 原VPC OSS APIv2名称: DelService.vip 示例值： 172.16.0.18 |
| RemoteVpcId | 否 | 否 | Int64 | 原VPC OSS APIv2名称: DelService.remoteVpcId 示例值： 1 |
| DeleteRouteFlag | 否 | 否 | Int64 | 原VPC OSS APIv2名称: DelService.bDelRoute 示例值： 0 |
FilterObject
过滤器键值对
被如下接口引用：DescribeClassicLinkInstances、DescribeVpnGateways
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Name | 是 | 否 | String | 属性名称, 若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。 示例值： vpc-id |
| Values | 是 | 否 | Array of String | 属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。 示例值： ["vpc-pnpcflil"] |
DfwOssUpdateUsgOfSvcAddr
复杂类型: DfwOssUpdateUsgOfSvcAddr
被如下接口引用：UpdateUsgOfSvcAddrInternal
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| UsgIdList | 否 | 否 | Array of String | 原DFW APIv2名称: updateUsgOfSvcAddr.usgids 示例值： ['sg-bb536gh1'] |
| VpcId | 否 | 否 | Int64 | 原DFW APIv2名称: updateUsgOfSvcAddr.vpcid 示例值： 76084 |
| Vip | 否 | 否 | String | 原DFW APIv2名称: updateUsgOfSvcAddr.vip 示例值： 10.1.2.16 |
| VirtualPort | 否 | 否 | Int64 | 原DFW APIv2名称: updateUsgOfSvcAddr.vport 示例值： 27017 |
| Protocol | 否 | 否 | Int64 | 原DFW APIv2名称: updateUsgOfSvcAddr.protocol 示例值： 6 |
NatGatewayAvailabilityInfo
NAT网关资源可用状态
被如下接口引用：DescribeNatGatewayAvailability
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| ResourceType | 是 | 否 | String | 资源产品类型 示例值： StandardPublicNat |
| Availability | 是 | 否 | String | 资源可用状态 示例值： Available |
ServiceTemplate
协议端口模板
被如下接口引用：CreateServiceTemplate、CreateServiceTemplateGroup、DescribeServiceTemplateGroups、DescribeServiceTemplates
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| ServiceTemplateId | 是 | 否 | String | 协议端口实例ID，例如：ppm-f5n1f8da。 示例值： ppm-f5n1f8da |
| ServiceTemplateName | 是 | 否 | String | 模板名称。 示例值： name |
| ServiceSet | 否 | 否 | Array of String | 协议端口信息。 示例值： ["tcp:80"] |
| CreatedTime | 否 | 否 | String | 创建时间。 示例值： 2021-03-02 14:41:15 |
| ServiceExtraSet | 否 | 否 | Array of ServicesInfo | 服务模板信息 示例值：查看 |
| TagSet | 否 | 否 | Array of Tag | 标签信息 示例值：查看 |
NatGateway
NAT网关对象。
被如下接口引用：CreateNatGateway、DescribeNatGateways
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| NatGatewayId | 是 | 否 | String | NAT网关的ID。 示例值： "nat-demoag78" |
| NatGatewayName | 是 | 否 | String | NAT网关的名称。 示例值： "demo" |
| CreatedTime | 是 | 否 | String | NAT网关创建的时间。 示例值： "2021-05-24 19:28:31" |
| State | 是 | 否 | String | NAT网关的状态。 'PENDING'：生产中，'DELETING'：删除中，'AVAILABLE'：运行中，'UPDATING'：升级中， ‘FAILED’：失败。 示例值： "AVAILABLE" |
| InternetMaxBandwidthOut | 是 | 否 | Uint64 | 网关最大外网出带宽(单位:Mbps)。 示例值： 10 |
| MaxConcurrentConnection | 是 | 否 | Uint64 | 网关并发连接上限。 示例值： 10000000 |
| PublicIpAddressSet | 是 | 否 | Array of NatGatewayAddress | 绑定NAT网关的公网IP对象数组。 示例值：查看 |
| NetworkState | 是 | 否 | String | NAT网关网络状态。“AVAILABLE”:运行中, “UNAVAILABLE”:不可用, “INSUFFICIENT”:欠费停服。 示例值： "AVAILABLE" |
| DestinationIpPortTranslationNatRuleSet | 是 | 否 | Array of DestinationIpPortTranslationNatRule | NAT网关的端口转发规则。 示例值：查看 |
| VpcId | 是 | 否 | String | VPC实例ID。 示例值： "vpc-demoag78" |
| Zone | 是 | 否 | String | NAT网关所在的可用区。 示例值： "ap-region-2" |
| GatewayType | 否 | 是 | String | 底层网关类型，取值为：NORMAL、HYPER。 示例值： NORMAL |
| TagSet | 是 | 否 | Array of Tag | 标签键值对。 示例值：查看 |
| SourceIpTranslationNatRuleSet | 否 | 否 | Array of SourceIpTranslationNatRule | NAT网关的SNAT规则。 示例值：查看 |
| StrictSnatMode | 否 | 否 | Bool | 是否仅允许匹配SNAT规则的流量进行转发 示例值： false |
| NatType | 是 | 否 | String | NAT业务类型 示例值： "NAT" |
| RestrictState | 是 | 否 | String | NAT网关是否被封禁 示例值： "NORMAL" |
| SecurityGroupSet | 是 | 否 | Array of String | NAT网关绑定的安全组列表 示例值： ["sg-9865478"] |
| ExclusiveGatewayBandwidth | 否 | 否 | Uint64 | 独享型NAT所在的网关集群的带宽(单位:Mbps) 示例值： 50000 |
| DedicatedClusterId | 是 | 否 | String | CDC唯一ID。 示例值： cluster-gbo27yc4 |
| SubnetId | 是 | 否 | String | 子网实例ID。 示例值： subnet-hj3he929 |
| NatProductVersion | 是 | 否 | Uint64 | NAT网关类型，1表示传统型NAT网关，2表示标准型NAT网关 示例值： 1 |
| InternetMaxBandwidthIn | 否 | 否 | Uint64 | 网关最大外网入带宽(单位:Mbps)。 示例值： 10 |
| DirectConnectGatewayIds | 是 | 否 | Array of String | 绑定的专线网关ID。 示例值： ["dcg-9865478"] |
| SmartScheduleMode | 是 | 否 | Bool | 是否启用根据目的网段选择SNAT使用的EIP功能 示例值： false |
| IsExclusive | 是 | 否 | Bool | 是否独享型NAT。 示例值： false |
| SharedCount | 是 | 否 | Uint64 | 共享型NAT所关联子实例的个数。 示例值： 0 |
| CreatedTimeIso | 否 | 是 | Datetime_iso | NAT网关创建的时间。 示例值： 2025-12-16T10:06:17+08:00 |
| FailureInfo | 否 | 否 | String | 实例创建失败信息 示例值： 公网IP售罄 |
| DeletionProtectionEnabled | 否 | 否 | Bool | NAT实例是否开启删除保护 示例值： false |
AddressBasic
EIP基本信息
被如下接口引用：DescribeAddressesHistory
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| AddressIp | 否 | 否 | String | 外网IP地址 示例值： 10.23.32.2 |
| AddressId | 是 | 否 | String | EIP的ID，是EIP的唯一标识。示例值： eip-d97psd1o |
| AddressType | 是 | 否 | String | eip资源类型，包括"CalcIP","WanIP","EIP","AnycastEIP"。其中"CalcIP"表示设备ip，“WanIP”表示普通公网ip，“EIP”表示弹性公网ip，“AnycastEip”表示加速EIP 示例值： EIP |
| InternetServiceProvider | 是 | 否 | String | EIP运营商信息，包括"CMCC","CTCC","CUCC","BGP"，其中"CMCC"表示移动运营商，"CTCC"表示电信运营商，"CUCC"表示联通运营商，"BGP"表示BGP对接运营商 示例值： BGP |
| Status | 是 | 否 | String | EIP使用状态，"used"表示该ip地址在当前地域已被占用，"unused"表示该ip地址在当前地域未被占用 示例值： Used |
| AnycastZone | 是 | 否 | String | Anycast 发布域是加速 IP 地址发布的地域，即 Anycast CLB 的 VIP 所发布的 POP 接入点，客户端接入最近的 POP 接入点。目前 Anycast CLB 支持以下发布域： 发布域 A(ANYCAST_ZONE_A)：主要是欧美地区，VIP 将同时在在、、、、多伦多、硅谷、法兰克福、弗吉尼亚和莫斯科发布。 发布域 B(ANYCAST_ZONE_B)：主要是和东南亚地区，VIP 将同时在、、、、新加坡、首尔、孟买、曼谷和东京发布。 示例值： ap-region-1 |
| Address | 否 | 否 | String | 外网IP地址。 示例值： eip-37xao8t |
DfwOssPolicies
复杂类型: DfwOssPolicies
被如下接口引用：AttachPolicyToVMInternal、DeletePolicyFromVmInternal、DescribeVmPolicyInternal
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 否 | 否 | String | 原DFW APIv2名称: delPolicyFromVM.action 示例值： ACCEPT |
| Ip | 否 | 否 | String | 原DFW APIv2名称: delPolicyFromVM.ip 示例值： 10.0.0.0/8 |
| Protocol | 否 | 否 | String | 原DFW APIv2名称: delPolicyFromVM.protocol 示例值： tcp |
| Port | 否 | 否 | String | 原DFW APIv2名称: delPolicyFromVM.port 示例值： 80 |
| Direction | 否 | 否 | String | 原DFW APIv2名称: delPolicyFromVM.direction 示例值： INPUT |
NatGatewayDestinationIpPortTranslationNatRule
NAT网关的端口转发规则
被如下接口引用：DescribeNatGatewayDestinationIpPortTranslationNatRules
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| IpProtocol | 否 | 否 | String | 网络协议，可选值：TCP、UDP。示例值： TCP |
| PublicIpAddress | 是 | 否 | String | 弹性IP。 示例值： jkt.jkt.jkt.jkt |
| PublicPort | 是 | 否 | Uint64 | 公网端口。 示例值： 443 |
| PrivateIpAddress | 是 | 否 | String | 内网地址。 示例值： 192.168.1.2 |
| PrivatePort | 是 | 否 | Uint64 | 内网端口。 示例值： 443 |
| Description | 否 | 否 | String | NAT网关转发规则描述。 示例值： 端口转发样例 |
| NatGatewayId | 是 | 是 | String | NAT网关的ID。 示例值： nat-3isn9hr0 |
| VpcId | 是 | 是 | String | 私有网络VPC的ID。 示例值： vpc-rkzpefgh |
| CreatedTime | 是 | 是 | String | NAT网关转发规则创建时间。 示例值： "2021-05-24 19:28:31" |
| CreatedTimeIso | 否 | 否 | Datetime_iso | NAT网关转发规则创建时间。 示例值： 2025-12-16T10:06:17+08:00 |
AddressInventoryInfo
资源库存信息
被如下接口引用：DescribeAddressInventory
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| AddressType | 是 | 否 | String | 资源产品类型 示例值： EIP |
| Availability | 是 | 否 | String | 资源可用状态 Purchasable：可购买 Soldout：资源售罄 Unavailable：未投放资源 示例值： Purchasable |
| InternetServiceProvider | 是 | 否 | String | 资源运营商类型 示例值： BGP |
| Zone | 是 | 否 | String | 资源所在可用区 示例值： ap-mock-1 |
| NetworkGroup | 是 | 否 | String | 资源所在网络组 示例值： ap-mock |
| Egress | 否 | 是 | String | 资源所属网络出口 示例值： center_egress1 |
| ResourceType | 否 | 是 | String | 资源产品子类型 示例值： "" |
| AddressCount | 是 | 否 | Int64 | 资源可用余量 示例值： 1 |
NetworkAclEntry
网络ACL规则。
被如下接口引用：CreateNetworkAcl、DeleteNetworkAclEntries、DescribeNetworkAcls、ModifyNetworkAclEntries
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Port | 否 | 否 | String | 端口(all, 单个port, range)。当Protocol为ALL或ICMP时，不能指定Port。使用-指定端口范围，如：10-20。 示例值： 8080 |
| Ipv6CidrBlock | 否 | 否 | String | 网段或IPv6(互斥)。 示例值： 3402:4e00:20:1200::/56 |
| Priority | 否 | 否 | Int64 | 优先级，从1开始。 示例值： 1 |
| NetworkAclIpv6EntryId | 否 | 否 | String | IPv6网络ACL条目唯一ID。当修改ACL条目时，NetworkAclIpv4EntryId和NetworkAclIpv6EntryId至少提供一个。 示例值： acli46-0pngbwph |
| NetworkAclDirection | 否 | 否 | String | 取值INGRESS或EGRESS。 示例值： INGRESS |
| Protocol | 否 | 否 | String | 协议, 取值: TCP,UDP, ICMP, ALL。 示例值： TCP |
| CidrBlock | 否 | 否 | String | 网段或IP(互斥)。增量创建ACL规则时，CidrBlock和Ipv6CidrBlock至少提供一个。 示例值： 10.0.0.0/24 |
| Action | 否 | 否 | String | ACCEPT 或 DROP。 示例值： ACCEPT |
| Description | 否 | 否 | String | 规则描述，最大长度100。 示例值： demo |
| ModifyTime | 否 | 否 | String | 修改时间。 示例值： 2018-04-25 10:26:26 |
| NetworkAclIpv4EntryId | 否 | 否 | String | IPv4网络ACL条目唯一ID。当修改ACL条目时，NetworkAclIpv4EntryId和NetworkAclIpv6EntryID至少提供一个。 示例值： acli43-0pngbwph |
AssistantCidr
VPC辅助CIDR信息。
被如下接口引用：CreateAssistantCidr、CreateVpc、DescribeAssistantCidr、DescribeVpcs、ModifyAssistantCidr
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| VpcId | 是 | 否 | String | VPC实例ID。形如：vpc-6v2ht8q5示例值： vpc-napeigw5 |
| CidrBlock | 是 | 否 | String | 辅助CIDR。形如：172.16.0.0/16示例值： 192.241.0.0/24 |
| AssistantType | 是 | 否 | Int64 | 辅助CIDR类型（0：普通辅助CIDR，1：容器辅助CIDR），默认都是0。 示例值： 0: 'NORMAL', 1: 'DOCKER' |
| SubnetSet | 是 | 是 | Array of Subnet | 辅助CIDR拆分的子网。 示例值：查看 |
| Region | 否 | 否 | String | 地域信息。 示例值： sz |
LocalIpTranslationNatRule
本端IP转换复杂类型
被如下接口引用：CreateLocalIpTranslationNatRule、CreatePeerIpTranslationNatRule、DeleteLocalIpTranslationNatRule、DeletePeerIpTranslationNatRule、DescribeLocalIpTranslationNatRules、DescribePeerIpTranslationNatRules
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| OriginalIp | 是 | 否 | String | 原始IP 示例值： 10.0.0.5 |
| TranslationIp | 是 | 否 | String | 映射IP 示例值： 2.2.2.2 |
| Description | 是 | 是 | String | 描述 示例值： for_demo |
Vpc
私有网络(VPC)对象。
被如下接口引用：CreateVpc、DescribeVpcs
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| VpcName | 是 | 否 | String | VPC名称。示例值： demo |
| VpcId | 是 | 否 | String | VPC实例ID，例如：vpc-azd4dt1c。示例值： vpc-azd4dt1c |
| CidrBlock | 是 | 否 | String | VPC的IPv4 CIDR。示例值： 10.0.0.0/16 |
| IsDefault | 否 | 否 | Bool | 是否默认VPC。示例值： true |
| EnableMulticast | 是 | 否 | Bool | 是否开启组播。 示例值： true |
| CreatedTime | 否 | 否 | String | 创建时间。 示例值： 2021-01-03 22:25:45 |
| DnsServerSet | 是 | 否 | Array of String | DNS列表。示例值： - |
| DomainName | 是 | 否 | String | DHCP域名选项值。示例值： demo |
| DhcpOptionsId | 是 | 否 | String | DHCP选项集ID。示例值： - |
| EnableDhcp | 是 | 否 | Bool | 是否开启DHCP。示例值： false |
| Ipv6CidrBlock | 否 | 否 | String | VPC的IPv6 CIDR。示例值： - |
| TagSet | 是 | 否 | Array of Tag | 标签键值对 示例值：查看 |
| AssistantCidrSet | 否 | 是 | Array of AssistantCidr | 辅助CIDR 示例值：查看 |
| BmsNum | 否 | 是 | Int64 | Bms数量。 示例值： 2 |
| VpcNumId | 否 | 是 | Int64 | vpc数字Id。 示例值： 2 |
| ExtendCidrSet | 否 | 是 | Array of ExtendCidr | 扩展cidr列表。 示例值：查看 |
| IsShare | 否 | 否 | Bool | 是否是共享资源 示例值： True |
| EnableCdcPublish | 否 | 否 | Bool | 发布cdc 子网到云联网的开关。true: 发布, false: 不发布。 示例值： False |
| EnableRouteVpcPublish | 否 | 否 | Bool | vpc关联云联网时路由发布策略， true：开启cidr路由发布，false：开启subnet子网路由发布。创建vpc时默认为子网路由发布 示例值： True |
| EnableRouteVpcPublishIpv6 | 否 | 否 | Bool | 发布ipv6子网到云联网的开关。true: 发布, false: 不发布。 示例值： False |
| CdcId | 否 | 否 | String | Cdc唯一 Id。 示例值： cdc-2loean7x |
| VpcFlag | 否 | 否 | Uint64 | 是否自研VPC：0否，1是。 示例值： 1 |
| Region | 否 | 否 | String | 地域。 示例值： sz |
| EnableMultiCcn | 否 | 否 | Bool | 是否支持多云联网 示例值： False |
| Ipv6CidrBlockSet | 否 | 否 | Array of ISPIPv6CidrBlock | 返回多运营商IPv6 Cidr Block 示例值：查看 |
NetworkInterfaceExtendIp
弹性网卡扩展ip段
被如下接口引用：DescribeNetworkInterfaceExtendIps
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| VpcId | 是 | 否 | Uint64 | Vpc整型id 示例值： 6757 |
| UniqVpcId | 是 | 否 | String | Vpc唯一id 示例值： vpc-67wlqf6v |
| EniId | 是 | 否 | Uint64 | 弹性网卡整型id 示例值： 324 |
| UniqEniId | 是 | 否 | String | 弹性网卡唯一id 示例值： eni-hhabo1ev |
| Ip | 是 | 否 | String | 扩展ip 示例值： 10.2.3.12 |
ItemPrice
单项计费价格信息
被如下接口引用：InquiryPriceCreateVpcPeerConnection、InquiryPriceCreateVpnGateway、InquiryPriceNatGateway、InquiryPriceResetVpnGatewayInternetMaxBandwidth、InquiryPriceUpdateCcnBandwidth
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| UnitPrice | 否 | 否 | Float | 按量计费后付费单价，单位：元。 示例值： 1.0 |
| ChargeUnit | 否 | 否 | String | 按量计费后付费计价单元，可取值范围： HOUR：表示计价单元是按每小时来计算。当前涉及该计价单元的场景有：实例按小时后付费（POSTPAID_BY_HOUR）、带宽按小时后付费（BANDWIDTH_POSTPAID_BY_HOUR）： GB：表示计价单元是按每GB来计算。当前涉及该计价单元的场景有：流量按小时后付费（TRAFFIC_POSTPAID_BY_HOUR）。 示例值： HOUR |
| OriginalPrice | 否 | 否 | Float | 预付费商品的原价，单位：元。 示例值： 1.0 |
| DiscountPrice | 否 | 否 | Float | 预付费商品的折扣价，单位：元。 示例值： 0.5 |
VpcOssUpdatePeer
复杂类型: VpcOssUpdatePeer
被如下接口引用：UpdateVpcPeerInternal
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| SrcVpcSubnet | 否 | 否 | String | 原VPC OSS APIv2名称: UpdateVpcPeer.sVpcSubnet 示例值： 172.16.0.0 |
| OldName | 否 | 否 | String | 原VPC OSS APIv2名称: UpdateVpcPeer.oldName 示例值： DDDD |
| SrcVpcId | 否 | 否 | Int64 | 原VPC OSS APIv2名称: UpdateVpcPeer.sVpcId 示例值： 78257 |
| LocalBandwidth | 否 | 否 | Int64 | 原VPC OSS APIv2名称: UpdateVpcPeer.localBandwidth 示例值： 0 |
| OldDestVpcIntMask | 否 | 否 | Int64 | 原VPC OSS APIv2名称: UpdateVpcPeer.oldDVpcIntMask 示例值： 16 |
| OldSrcExpireTime | 否 | 否 | String | 原VPC OSS APIv2名称: UpdateVpcPeer.oldSExpireTime 示例值： 2021-12-31 19:41:49 |
| VirtualSafeGroupIp | 否 | 否 | String | 原VPC OSS APIv2名称: UpdateVpcPeer.vsgIp 示例值： 0.0.0.0 |
| DestViewFlag | 否 | 否 | Int64 | 原VPC OSS APIv2名称: UpdateVpcPeer.dViewFlag 示例值： 1 |
| OldState | 否 | 否 | Int64 | 原VPC OSS APIv2名称: UpdateVpcPeer.oldState 示例值： 1 |
| OwedFlag | 否 | 否 | Int64 | 原VPC OSS APIv2名称: UpdateVpcPeer.owedFlag 示例值： 0 |
| NewAfcFlag | 否 | 否 | Int64 | 原VPC OSS APIv2名称: UpdateVpcPeer.bNewAfc 示例值： 0 |
| OldWanOutLimit | 否 | 否 | Int64 | 原VPC OSS APIv2名称: UpdateVpcPeer.oldWanOutLimit 示例值： 0 |
| Type | 否 | 否 | Int64 | 原VPC OSS APIv2名称: UpdateVpcPeer.type 示例值： 0 |
| OldLastState | 否 | 否 | Int64 | 原VPC OSS APIv2名称: UpdateVpcPeer.oldLastState 示例值： 0 |
| OldVirtualSafeGroupIp | 否 | 否 | String | 原VPC OSS APIv2名称: UpdateVpcPeer.oldVsgIp 示例值： 0.0.0.0 |
| UniqueDestVpcId | 否 | 否 | String | 原VPC OSS APIv2名称: UpdateVpcPeer.uniqDVpcId 示例值： vpc-n05ss3vl |
| SrcOwner | 否 | 否 | String | 原VPC OSS APIv2名称: UpdateVpcPeer.sOwner 示例值： 251198225 |
| State | 否 | 否 | Int64 | 原VPC OSS APIv2名称: UpdateVpcPeer.state 示例值： 1 |
| OldSrcVpcIntMask | 否 | 否 | Int64 | 原VPC OSS APIv2名称: UpdateVpcPeer.oldSVpcIntMask 示例值： 16 |
| UniqueSrcVpcId | 否 | 否 | String | 原VPC OSS APIv2名称: UpdateVpcPeer.uniqSVpcId 示例值： vpc-jmaywf6r |
| DestVpcId | 否 | 否 | Int64 | 原VPC OSS APIv2名称: UpdateVpcPeer.dVpcId 示例值： 76644 |
| OldNewAfcFlag | 否 | 否 | Int64 | 原VPC OSS APIv2名称: UpdateVpcPeer.oldBNewAfc 示例值： 0 |
| DestVpcIntMask | 否 | 否 | Int64 | 原VPC OSS APIv2名称: UpdateVpcPeer.dVpcIntMask 示例值： 16 |
| OldSrcVpcSubnet | 否 | 否 | String | 原VPC OSS APIv2名称: UpdateVpcPeer.oldSVpcSubnet 示例值： 172.16.0.0 |
| DestRegion | 否 | 否 | Int64 | 原VPC OSS APIv2名称: UpdateVpcPeer.dRegion 示例值： 0 |
| OldDestViewFlag | 否 | 否 | Int64 | 原VPC OSS APIv2名称: UpdateVpcPeer.oldDViewFlag 示例值： 1 |
| SrcRegion | 否 | 否 | Int64 | 原VPC OSS APIv2名称: UpdateVpcPeer.sRegion 示例值： 0 |
| Bandwidth | 否 | 否 | Int64 | 原VPC OSS APIv2名称: UpdateVpcPeer.bandwidth 示例值： 0 |
| OldZoneVpcPeerFlag | 否 | 否 | Int64 | 原VPC OSS APIv2名称: UpdateVpcPeer.oldBZoneVpcPeer 示例值： 0 |
| OldOwedFlag | 否 | 否 | Int64 | 原VPC OSS APIv2名称: UpdateVpcPeer.oldOwedFlag 示例值： 0 |
| PublishDockerCidrFlag | 否 | 否 | Int64 | 原VPC OSS APIv2名称: UpdateVpcPeer.bPublishDockerCidr 示例值： 0 |
| OldDestVpcSubnet | 否 | 否 | String | 原VPC OSS APIv2名称: UpdateVpcPeer.oldDVpcSubnet 示例值： 10.0.0.0 |
| LastState | 否 | 否 | Int64 | 原VPC OSS APIv2名称: UpdateVpcPeer.lastState 示例值： 0 |
| SrcViewFlag | 否 | 否 | Int64 | 原VPC OSS APIv2名称: UpdateVpcPeer.sViewFlag 示例值： 1 |
| DestVpcSubnet | 否 | 否 | String | 原VPC OSS APIv2名称: UpdateVpcPeer.dVpcSubnet 示例值： 10.0.0.0 |
| CreateTime | 否 | 否 | String | 原VPC OSS APIv2名称: UpdateVpcPeer.createTime 示例值： 2021-12-31 19:41:49 |
| OldDestExpireTime | 否 | 否 | String | 原VPC OSS APIv2名称: UpdateVpcPeer.oldDExpireTime 示例值： 2021-12-31 19:41:49 |
| SrcExpireTime | 否 | 否 | String | 原VPC OSS APIv2名称: UpdateVpcPeer.sExpireTime 示例值： 2021-12-31 19:41:49 |
| VpcPeerId | 否 | 否 | Int64 | 原VPC OSS APIv2名称: UpdateVpcPeer.vpcPeerId 示例值： 26574 |
| Name | 否 | 否 | String | 名称 示例值： DDDD |
| UniqueVpcPeerId | 否 | 否 | String | 原VPC OSS APIv2名称: UpdateVpcPeer.uniqVpcPeerId 示例值： pcx-fh7xs34s |
| SrcVpcIntMask | 否 | 否 | Int64 | 原VPC OSS APIv2名称: UpdateVpcPeer.sVpcIntMask 示例值： 16 |
| OldSrcViewFlag | 否 | 否 | Int64 | 原VPC OSS APIv2名称: UpdateVpcPeer.oldSViewFlag 示例值： 1 |
| DestExpireTime | 否 | 否 | String | 原VPC OSS APIv2名称: UpdateVpcPeer.dExpireTime 示例值： 2021-12-31 19:41:49 |
| DestOwner | 否 | 否 | String | 原VPC OSS APIv2名称: UpdateVpcPeer.dOwner 示例值： 251198225 |
| Owner | 否 | 否 | String | 用户AppId 示例值： 251198225 |
| OldLocalBandwidth | 否 | 否 | Int64 | 原VPC OSS APIv2名称: UpdateVpcPeer.oldLocalBandwidth 示例值： 0 |
| WanOutLimit | 否 | 否 | Int64 | 原VPC OSS APIv2名称: UpdateVpcPeer.wanOutLimit 示例值： 0 |
| ZoneVpcPeerFlag | 否 | 否 | Int64 | 原VPC OSS APIv2名称: UpdateVpcPeer.bZoneVpcPeer 示例值： 0 |
| NfvFlag | 否 | 否 | Int64 | 原VPC OSS APIv2名称: UpdateVpcPeer.bNfv 示例值： 0 |
| OldPublishDockerCidrFlag | 否 | 否 | Int64 | 原VPC OSS APIv2名称: UpdateVpcPeer.oldBPublishDockerCidr 示例值： 0 |
| OldBandwidth | 否 | 否 | Int64 | 原VPC OSS APIv2名称: UpdateVpcPeer.oldBandwidth 示例值： 0 |
| ImageId | 否 | 否 | String | 原VPC OSS APIv2名称: UpdateVpcPeer.imageId 示例值： xx |
| AfcVpcPeerGlobalId | 否 | 否 | Int64 | 原VPC OSS APIv2名称: UpdateVpcPeer.afcVpcPeerGlobalId 示例值： 0 |
SecurityGroupPolicySet
安全组规则集合
被如下接口引用：CreateSecurityGroupPolicies、CreateSecurityGroupWithPolicies、DeleteSecurityGroupPolicies、DescribeSecurityGroupPolicies、ModifySecurityGroupPolicies、ReplaceSecurityGroupPolicies、ReplaceSecurityGroupPolicy
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Version | 否 | 否 | String | 安全组规则当前版本。用户每次更新安全规则版本会自动加1，防止更新的路由规则已过期，不填不考虑冲突。 示例值： 10 |
| Egress | 否 | 否 | Array of SecurityGroupPolicy | 出站规则。 示例值：查看 |
| Ingress | 否 | 否 | Array of SecurityGroupPolicy | 入站规则。 示例值：查看 |
| PolicyStatistics | 否 | 否 | PolicyStatistics | 安全组策略条目统计。只用于出参。 示例值：查看 |
CcnBandwidthInfo
用于描述云联网地域间限速带宽实例的信息
被如下接口引用：GetCcnRegionBandwidthLimits
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| CcnId | 是 | 是 | String | 带宽所属的云联网ID。 示例值： ccn-ef5nufih |
| CreatedTime | 是 | 是 | String | 实例的创建时间。 示例值： 2018-12-18 20:11:37 |
| ExpiredTime | 是 | 是 | String | 实例的过期时间 示例值： 2019-01-18 20:11:37 |
| RegionFlowControlId | 是 | 是 | String | 带宽实例的唯一ID。 示例值： fcr-6fda09za |
| RenewFlag | 是 | 是 | String | 带宽是否自动续费的标记。 示例值： NOTIFY_AND_AUTO_RENEW |
| CcnRegionBandwidthLimit | 是 | 是 | CcnRegionBandwidthLimit | 描述带宽的地域和限速上限信息。 示例值：查看 |
AddressPrice
调整带宽询价结果。
被如下接口引用：InquiryPriceModifyAddressesBandwidth
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| ChargeUnit | 否 | 否 | String | 计费单位 示例值： HOUR |
| UnitPrice | 否 | 否 | Float | 单价 示例值： 21 |
| DiscountPrice | 否 | 否 | Float | 折扣价格 示例值： 21 |
ZoneInfo
EIP可用区列表信息
被如下接口引用：DescribeAvailableZone
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Zone | 是 | 否 | String | 可用区名称，例如，ap-region-1 示例值： ap-region-2 |
| ZoneName | 是 | 否 | String | 可用区描述，例如，一区 示例值： ap-region-2 |
| ZoneId | 是 | 否 | Int64 | 可用区ID 示例值： 50001 |
| ZoneState | 是 | 否 | String | 可用区状态，目前只有两种状态，分别是UNAVAILABLE和AVAILABLE 示例值： UNAVAILABLE |
DefaultVpcSubnet
默认VPC和子网
被如下接口引用：CreateDefaultVpc
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| VpcId | 是 | 否 | String | 默认VpcId 示例值： vpc-6vbg797r |
| SubnetId | 是 | 否 | String | 默认SubnetId 示例值： subnet-3opmksyg |
| VpcName | 否 | 否 | String | 默认Vpc名字。 示例值： Default-VPC |
| CidrBlock | 否 | 否 | String | 默认子网网段。 示例值： 172.16.0.0/16 |
| DhcpOptionsId | 否 | 否 | String | DHCP选项集ID。示例值： dopt-7t8toql2 |
| DnsServerSet | 否 | 否 | Array of String | DNS列表。示例值： ['183.60.82.98'] |
| DomainName | 否 | 否 | String | DHCP域名选项值。示例值： demo |
| SubnetName | 否 | 否 | String | 子网名称 示例值： demo |
VpcPrivateIpAddress
VPC内网IP对象。
被如下接口引用：DescribeVpcPrivateIpAddresses
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| PrivateIpAddress | 是 | 否 | String | VPC内网IP。示例值： 192.168.12.3 |
| CidrBlock | 是 | 否 | String | 所属子网CIDR。示例值： 192.241.0.0/24 |
| PrivateIpAddressType | 是 | 否 | String | 内网IP类型。示例值： CVM/ENI |
| CreatedTime | 是 | 否 | Datetime | IP申请时间。示例值： 2020-06-06 10:00:00 |
ExtendCidr
扩展cidr。
被如下接口引用：CreateVpc、DescribeVpcs
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| ExtendCidrBlock | 是 | 否 | String | 扩展cidr。 示例值： 192.241.0.0/24 |
ResourceStatisticsItem
资源统计项。
被如下接口引用：DescribeFlowLogs、DescribeSubnetResourceDashboard
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| ResourceCount | 是 | 否 | Uint64 | 资源个数。 示例值： 100 |
| ResourceType | 是 | 否 | String | 资源类型。比如，CVM，ENI等。 示例值： CVM |
| ResourceName | 是 | 否 | String | 资源名称。 示例值： 云服务器 |
DfwOssAddSvcAddrToUSGResult
复杂类型: DfwOssAddSvcAddrToUSGResult
被如下接口引用：CreateSvcAddrToUSGInternal
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| SvcAddrId | 否 | 否 | String | 原DFW APIv2名称: addSvcAddrToUSG.svcAddrId 示例值： 76084_10.1.2.16_27017_6 |
| ErrorCode | 否 | 否 | Int64 | 原DFW APIv2名称: addSvcAddrToUSG.errorCode 示例值： 0 |
| ErrorInfo | 否 | 否 | String | 原DFW APIv2名称: addSvcAddrToUSG.errorInfo 示例值： success |
DfwOssAddObjectsToUSGRequest
复杂类型: DfwOssAddObjectsToUSGRequest
被如下接口引用：AttachObjectToUSGInternal
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Vms | 否 | 否 | Array of String | 原DFW APIv2名称: addObjectsToUSG.vms 示例值： ['84f9a2ad-6659-4864-808c-bd17f3c2acea'] |
| VIFS | 否 | 否 | Array of String | 原DFW APIv2名称: addObjectsToUSG.vifs 示例值： ['xxx'] |
| Services | 否 | 否 | Array of String | 原DFW APIv2名称: addObjectsToUSG.svcs 示例值： ['xxx'] |
| Order | 否 | 否 | Int64 | 原DFW APIv2名称: addObjectsToUSG.order 示例值： 1 |
| UsgId | 否 | 否 | String | 原DFW APIv2名称: addObjectsToUSG.usgId 示例值： sg-aosmqpxs |
IpAddressStates
占用ip的资源信息
被如下接口引用：DescribeUsedIpAddress
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| ResourceType | 是 | 否 | String | 资源类型 示例值： ENI |
| ResourceId | 是 | 否 | String | 资源ID 示例值： eni-bjekqff1 |
| VpcId | 是 | 否 | String | VPC实例ID。 示例值： vpc-mcqaoy0f |
| SubnetId | 是 | 否 | String | 子网实例ID。 示例值： subnet-j4oluywm |
| IpAddress | 是 | 否 | String | IP地址。 示例值： 172.16.0.16 |
DfwOssGetUSGPolicyRequest
复杂类型: DfwOssGetUSGPolicyRequest
被如下接口引用：DescribeUSGPolicyInternal
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| UsgId | 否 | 否 | String | 原DFW APIv2名称: getUSGPolicy.usgId 示例值： sg-aassaa |
InstanceChargePrepaid
预付费（包年包月）计费对象。
被如下接口引用：CreateVpnGateway、InquiryPriceCreateVpnGateway
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Period | 是 | 否 | Uint64 | 购买实例的时长，单位：月。取值范围：1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36。 示例值： 5 |
| RenewFlag | 否 | 否 | String | 自动续费标识。取值范围： NOTIFY_AND_AUTO_RENEW：通知过期且自动续费， NOTIFY_AND_MANUAL_RENEW：通知过期不自动续费。默认：NOTIFY_AND_MANUAL_RENEW 示例值： NOTIFY_AND_AUTO_RENEW |
NewVpnGatewayQuota
VPN规格
被如下接口引用：DescribeVpnGatewayQuota
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| IPSEC | 否 | 是 | Array of VpnGatewayQuota | IPSEC规格 示例值：查看 |
| SSL | 否 | 是 | Array of VpnGatewayQuota | SSL规格 示例值：查看 |
SubNetworkInterfaceOut
中继网卡信息
被如下接口引用：CreateSubNetworkInterface
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| ElasticNetworkCardName | 否 | 否 | String | 网卡接口名 示例值： seni_vFspq39W |
| NetworkInterfaceId | 是 | 否 | String | 中继网卡实例id。 示例值： eni-3efr45tg |
| NetworkInterfaceName | 是 | 否 | String | 网卡名称。 示例值： demo |
| NetworkInterfaceDescription | 是 | 否 | String | 网卡备注。 示例值： demo |
| PrivateIpAddressSet | 是 | 否 | Array of PrivateIpAddressForSubNetWorkInterface | 内网地址信息。 示例值：查看 |
| NetworkInterfaceState | 否 | 否 | String | 弹性网卡状态：PENDING：创建中AVAILABLE：可用的ATTACHING：绑定中DETACHING：解绑中DELETING：删除中INUSE：已绑定示例值： AVAILABLE |
| TagSet | 是 | 否 | Array of Tag | 标签信息。 示例值：查看 |
| VpcId | 是 | 否 | String | 私有网络实例id。 示例值： vpc-m0c2kcun |
| SubnetId | 是 | 否 | String | 子网实例id。 示例值： subnet-3efr45tg |
| MacAddress | 是 | 否 | String | MAC地址。 示例值： 20:90:6F:3E:79:24 |
| GroupSet | 是 | 否 | Array of String | 安全组列表。 示例值： ["sg-nswq8wkq"] |
| State | 是 | 否 | String | 网卡状态：PENDING：创建中AVAILABLE：可用的ATTACHING：绑定中DETACHING：解绑中DELETING：删除中示例值： AVAILABLE |
| CreatedTime | 是 | 否 | String | 创建时间。 示例值： 2022-02-11 17:46:10 |
| VlanId | 是 | 否 | Uint64 | Vlan Id。 示例值： 727 |
DfwOssAddSvcToUsgRequest
复杂类型: DfwOssAddSvcToUsgRequest
被如下接口引用：CreateSvcToUsgInternal
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| VirtualPort | 否 | 否 | Int64 | 原DFW APIv2名称: addSvcToUsg.vport 示例值： 3600 |
| UniqCdcId | 否 | 否 | String | 原DFW APIv2名称: addSvcToUsg.uniqCdcId 示例值： cdc-aosq293w |
| UsgIdList | 否 | 否 | Array of String | 原DFW APIv2名称: addSvcToUsg.usgids 示例值： ['sg-asdqkq'] |
| SvcId | 否 | 否 | String | 原DFW APIv2名称: addSvcToUsg.svcid 示例值： 487487 |
| Type | 否 | 否 | Int64 | 原DFW APIv2名称: addSvcToUsg.type 示例值： 1 |
| Vip | 否 | 否 | String | 原DFW APIv2名称: addSvcToUsg.vip 示例值： 12.2.2.3 |
| Protocol | 否 | 否 | Int64 | 原DFW APIv2名称: addSvcToUsg.protocol 示例值： 0 |
| Location | 否 | 否 | String | 原DFW APIv2名称: addSvcToUsg.location 示例值： tgw |
| VpcId | 否 | 否 | Int64 | 整数vpcId 示例值： 1200 |
| AppId | 否 | 否 | String | 原DFW APIv2名称: addSvcToUsg.appid 示例值： 487122 |
DfwOssGetUSGRequest
复杂类型: DfwOssGetUSGRequest
被如下接口引用：DescribeUSGInternal
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Id | 否 | 否 | String | 原VPC OSS APIv2名称: getUSGById.id 示例值： sg-aassaa |
CcnInstance
云联网（CCN）关联实例（Instance）对象。
被如下接口引用：AcceptAttachCcnInstances、AttachCcnInstances、DetachCcnInstances、RejectAttachCcnInstances
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| InstanceType | 否 | 否 | String | 关联实例类型，可选值：VPC：私有网络DIRECTCONNECT：专线网关BMVPC：黑石私有网络示例值： VPC |
| InstanceId | 是 | 否 | String | 关联实例ID。 示例值： vpc-lt6ork07 |
| InstanceRegion | 是 | 否 | String | 关联实例ID所属大区，例如：ap-region。 示例值： ap-region |
HaVipSet
HaVip绑定子机网卡信息
被如下接口引用：FlushHaVip
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| VpcId | 是 | 否 | String | VPC实例ID。 示例值： vpc-67wlqf6v |
| Vip | 是 | 否 | String | 虚拟IP地址。 示例值： 10.2.3.12 |
| IfnName | 否 | 否 | String | 网卡接口名称。 示例值： veth_21CF51f0 |
| MacAddress | 否 | 否 | String | 网卡MAC地址。 示例值： 20:90:6F:69:CA:7F |
VpcOssRouteForUpdateRouteWeightInternal
复杂类型: VpcOssRouteForUpdateRouteWeightInternal
被如下接口引用：UpdateRouteWeightInternal
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| PrivateIp | 否 | 否 | String | 原VPC OSS APIv2名称: UpdateRouteWeight.pip 示例值： 10.19.0.121 |
| ProtocolPort | 否 | 否 | Int64 | 原VPC OSS APIv2名称: UpdateRouteWeight.pport 示例值： 8080 |
| Weight | 否 | 否 | Int64 | 原VPC OSS APIv2名称: UpdateRouteWeight.weight 示例值： 10 |
DfwOssAddSvcAddrToUSG
复杂类型: DfwOssAddSvcAddrToUSG
被如下接口引用：CreateSvcAddrToUSGInternal
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| UsgId | 否 | 否 | String | 原DFW APIv2名称: addSvcAddrToUSG.usgId 示例值： sg-bb536gh1 |
| VpcId | 否 | 否 | Int64 | 整数vpcId 示例值： 76084 |
| Vip | 否 | 否 | String | 原DFW APIv2名称: addSvcAddrToUSG.vip 示例值： 10.1.2.16 |
| VirtualPort | 否 | 否 | Int64 | 原DFW APIv2名称: addSvcAddrToUSG.vport 示例值： 27017 |
| Protocol | 否 | 否 | Int64 | 原DFW APIv2名称: addSvcAddrToUSG.protocol 示例值： 6 |
| Order | 否 | 否 | Int64 | 原DFW APIv2名称: addSvcAddrToUSG.order 示例值： 1 |
DfwOssGetUSGFromVMRequest
复杂类型: DfwOssGetUSGFromVMRequest
被如下接口引用：DescribeVmPolicyInternal
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Uuid | 否 | 否 | String | 原DFW APIv2名称: getVMPolicy.uuid 示例值： 84f9a2ad-6659-4864-808c-bd17f3c2acea |
CustomerGatewayVendor
对端网关厂商信息对象。
被如下接口引用：DescribeCustomerGatewayVendors、DownloadCustomerGatewayConfiguration
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Platform | 是 | 否 | String | 平台。 示例值： comware |
| SoftwareVersion | 是 | 否 | String | 软件版本。 示例值： V1.0 |
| VendorName | 是 | 否 | String | 供应商名称。 示例值： h3c |
ServiceTemplateSpecification
协议端口模板
被如下接口引用：CreateSecurityGroupPolicies、CreateSecurityGroupWithPolicies、DeleteSecurityGroupPolicies、DescribeSecurityGroupPolicies、DescribeSecurityGroupPolicyTemplates、ModifySecurityGroupPolicies、ReplaceSecurityGroupPolicies、ReplaceSecurityGroupPolicy
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| ServiceId | 是 | 否 | String | 协议端口ID，例如：ppm-f5n1f8da。 示例值： ppm-f5n1f8da |
| ServiceGroupId | 是 | 否 | String | 协议端口组ID，例如：ppmg-f5n1f8da。 示例值： ppmg-f5n1f8da |
DryRunFlowInSecurityGroupResult
检查流在安全组是否通过结果
被如下接口引用：DescribeDryRunFlowInSecurityGroup
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| FlowIndex | 是 | 否 | Uint64 | 输入的flow数组下标 示例值： 1 |
| FlowCheckResult | 是 | 否 | Array of NetFlowDryRunCheckResult | 指定流的检查结果 示例值：查看 |
DfwOssUpdateUsgOfSvc
复杂类型: DfwOssUpdateUsgOfSvc
被如下接口引用：UpdateUsgOfSvcInternal
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| UsgIdList | 否 | 否 | Array of String | 原DFW APIv2名称: updateUsgOfSvc.usgids 示例值： ['sg-bb536gh1'] |
| SvcId | 否 | 否 | String | 原DFW APIv2名称: updateUsgOfSvc.svcid 示例值： cdb-bb536gh1 |
ModifyBandwidthPrice
调整带宽询价结果。
被如下接口引用：InquiryPriceModifyAddressesBandwidth
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| AddressPrice | 否 | 否 | AddressPrice | 调整带宽询价结果。 示例值：查看 |
VpcOssEniLimit
复杂类型: VpcOssEniLimit
被如下接口引用：DescribeEniLimitInternal
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| LowerCpu | 否 | 否 | Int64 | 原VPC OSS APIv2名称: GetEniLimit.lowerCpu 示例值： 16 |
| Owner | 否 | 否 | String | 用户AppId 示例值： default |
| Type | 否 | 否 | Int64 | 原VPC OSS APIv2名称: GetEniLimit.type 示例值： 0 |
| CreateTime | 否 | 否 | String | 原VPC OSS APIv2名称: GetEniLimit.createTime 示例值： 2020-09-22 17:29:55 |
| LowerMem | 否 | 否 | Int64 | 原VPC OSS APIv2名称: GetEniLimit.lowerMem 示例值： 0 |
| UpperCpu | 否 | 否 | Int64 | 原VPC OSS APIv2名称: GetEniLimit.upperCpu 示例值： 1000000 |
| EniLimitId | 否 | 否 | Int64 | 原VPC OSS APIv2名称: GetEniLimit.eniLimitId 示例值： 326 |
| UpperMem | 否 | 否 | Int64 | 原VPC OSS APIv2名称: GetEniLimit.upperMem 示例值： 1000000 |
| Val | 否 | 否 | Int64 | 原VPC OSS APIv2名称: GetEniLimit.val 示例值： 8 |
| InstanceFamily | 否 | 否 | String | 原VPC OSS APIv2名称: GetEniLimit.instanceFamily 示例值： D1 |
| InstanceId | 否 | 否 | String | 原VPC OSS APIv2名称: GetEniLimit.instanceId 示例值： default |
NetFlowDryRunCheckResult
指定流在指定安全组的检查结果
被如下接口引用：DescribeDryRunFlowInSecurityGroup
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| SecurityGroupId | 是 | 否 | String | 安全组ID 示例值： sg-mps1dadx |
| CheckResult | 是 | 否 | String | 检查结果，取值：ACCEPT / DROP 示例值： ACCEPT |
VpnInstanceStatistics
用户全地域VPN相关实例分布信息列表
被如下接口引用：DescribeCustomerGatewayInstanceStatistics、DescribeVpnConnectionInstanceStatistics、DescribeVpnGatewayInstanceStatistics、DescribeVpnGatewaySslClientInstanceStatistics、DescribeVpnGatewaySslServerInstanceStatistics
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Region | 是 | 否 | String | 地域 示例值： ap-bangkok |
| TotalCount | 是 | 否 | Uint64 | 当前地域用户所拥有的VPNGW个数 示例值： 10 |
DestinationIpPortTranslationNatRule
NAT网关的端口转发规则
被如下接口引用：CreateNatGateway、CreateNatGatewayDestinationIpPortTranslationNatRule、DeleteNatGatewayDestinationIpPortTranslationNatRule、DescribeNatGateways、ModifyNatGatewayDestinationIpPortTranslationNatRule
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| IpProtocol | 是 | 否 | String | 网络协议，可选值：TCP、UDP。示例值： TCP |
| PublicIpAddress | 是 | 否 | String | 弹性IP。 示例值： 20.20.20.20 |
| PublicPort | 是 | 否 | Uint64 | 公网端口。 示例值： 80 |
| PrivateIpAddress | 是 | 否 | String | 内网地址。 示例值： 10.10.10.10 |
| PrivatePort | 是 | 否 | Uint64 | 内网端口。 示例值： 80 |
| Description | 是 | 否 | String | NAT网关转发规则描述。 示例值： for_demo |
VpcGateway
VPC下的网关信息
被如下接口引用：DescribeVpcGateways
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| SubnetId | 是 | 否 | String | 子网实例ID。 示例值： subnet-8qywqc4y |
| Pip | 是 | 否 | String | 内网IP地址。 示例值： 10.12.2.12 |
| WanIp | 是 | 否 | String | 公网IP地址。 示例值： 10.12.2.12 |
BandwidthLimitForCcnAlarmOnly
云联网（CCN）地域出带宽上限
被如下接口引用：BandwidthLimitForCcnAlarmOnly
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Region | 是 | 否 | String | 地域，例如：ap-region。 示例值： region |
| BandwidthLimit | 是 | 否 | Uint64 | 出带宽上限，单位：Mbps。 示例值： 100 |
| VbcId | 是 | 否 | Uint64 | 整型ID。 示例值： 65535 |
| CcnId | 是 | 否 | String | 实例ID。 示例值： ccn-245ecr35 |
Price
价格
被如下接口引用：InquiryPriceCreateVpcPeerConnection、InquiryPriceCreateVpnGateway、InquiryPriceNatGateway、InquiryPriceResetVpnGatewayInternetMaxBandwidth
AvailabilitySet
资源余量详情
被如下接口引用：DescribeAddressAvailability
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| AddressCount | 否 | 是 | Int64 | 数量 示例值： 1 |
| AddressType | 否 | 是 | String | IP类型 示例值： EIP |
| ApplicableForCLB | 否 | 是 | Bool | clb 示例值： False |
| ResourceType | 否 | 是 | String | 资源类型 示例值： EIP |
| Availability | 否 | 是 | String | 可用性 示例值： Available |
| InternetServiceProvider | 否 | 是 | String | 线路类型 示例值： BGP' |
| Zone | 否 | 是 | String | 可用区 示例值： cqyfm7 |
| NetworkGroup | 否 | 是 | String | 网络分组 示例值： cq |
EipStatistics
描述EIP统计信息的结构
被如下接口引用：DescribeEipStatistics
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Region | 是 | 否 | String | 地域英文标识 示例值： sz |
| RegionName | 是 | 否 | String | 地域名称 示例值： sz |
| TotalCount | 是 | 否 | Int64 | 地域EIP总数 示例值： 10 |
ServiceTypes
支持的Pass服务类型
被如下接口引用：DescribeVpcEndPointServiceType
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| ServiceType | 是 | 否 | String | 后端支持的PAAS服务类型 示例值： CLB,CDB,CRS |
| RoleFlag | 是 | 否 | Bool | 该服务后台查询是否涉及服务角色 示例值： True,False |
SecurityGroupLimitSet
用户安全组配额限制。
被如下接口引用：DescribeSecurityGroupLimits
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| SecurityGroupLimit | 是 | 否 | Uint64 | 每个项目每个地域可创建安全组数 示例值： 100 |
| SecurityGroupPolicyLimit | 是 | 否 | Uint64 | 安全组下的最大规则数 示例值： 100 |
| ReferedSecurityGroupLimit | 是 | 否 | Uint64 | 安全组下嵌套安全组规则数 示例值： 100 |
| SecurityGroupInstanceLimit | 是 | 否 | Uint64 | 单安全组关联实例数 示例值： 100 |
| InstanceSecurityGroupLimit | 是 | 否 | Uint64 | 实例关联安全组数 示例值： 100 |
| SecurityGroupReferedCvmAndEniLimit | 是 | 否 | Uint64 | 安全组关联网卡配额 示例值： 100 |
| SecurityGroupReferedSvcLimit | 是 | 否 | Uint64 | 安全组关联服务配额 示例值： 100 |
| SecurityGroupExtendedPolicyLimit | 是 | 否 | Uint64 | 安全组扩展策略配额 示例值： 100 |