附录

相关Model对象定义

Vpc

参数名称	类型	描述
vpcId	String	VPC的ID
name	String	名称
cidr	String	网段及子网掩码
ipv6Cidr	String	VPC的IPv6网段
description	String	描述
isDefault	Boolean	是否为默认VPC，true:是，false:否
relay	Boolean	是否开启VPC中继，true:是，false:否
secondaryCidr	List<String>	VPC的辅助网段CIDR列表
tags	List<TagModel>	VPC绑定的标签集合

ShowVpcModel

参数名称	类型	描述
vpcId	String	VPC的ID
name	String	名称
cidr	String	网段及子网掩码
ipv6Cidr	String	VPC的IPv6网段
description	String	描述
isDefault	Boolean	是否为默认VPC，true:是，false:否
relay	Boolean	是否开启VPC中继，true:是，false:否
subnets	List<Subnet>	VPC中包含的子网
secondaryCidr	List<String>	VPC的辅助网段CIDR列表
tags	List<TagModel>	VPC绑定的标签集合

VpcPrivateIpAddress

参数名称	类型	描述
cidr	String	所属子网CIDR
privateIpAddress	String	VPC内网IP
privateIpAddressType	String	VPC内网IP的类型
createdTime	String	创建时间

ResourceIp

参数名称	类型	描述
ip	String	VPC内网IP
resourceType	String	VPC内网IP所属产品

Subnet

参数名称	类型	描述
subnetId	String	子网ID
name	String	子网名称
zoneName	String	可用区名称
cidr	String	子网CIDR
ipv6Cidr	String	子网的IPv6网段
vpcId	String	子网所属VPC的ID
subnetType	String	子网类型，"BCC”、"BCC_NAT”、”BBC”
description	String	描述
availableIp	Integer	子网内可用IP数
availableUnreservedIp	Integer	子网内除预留网段外的可用IP数
createdTime	String	子网的创建时间
tags	List<TagModel>	子网绑定的标签列表

SubnetDetail

参数名称	类型	描述
subnetId	String	子网ID
name	String	子网名称
zoneName	String	可用区名称
cidr	String	子网CIDR
ipv6Cidr	String	子网的IPv6网段
vpcId	String	子网所属VPC的ID
subnetType	String	子网类型，"BCC”、"BCC_NAT”、”BBC”
description	String	描述
availableIp	Integer	子网内可用IP数
availableUnreservedIp	Integer	子网内除预留网段外的可用IP数
createdTime	String	子网的创建时间
tags	List<TagModel>	子网绑定的标签列表

IpReserve

参数名称	类型	描述
ipReserveId	String	预留网段的ID
subnetId	String	预留网段所在的子网ID
ipCidr	String	预留网段的IP或CIDR
ipVersion	String	预留网段的IP版本
description	String	预留网段的描述
createdTime	String	预留网段实例创建时间
updatedTime	String	预留网段实例更新时间

RouteRule

参数名称	类型	描述
routeRuleId	String	路由规则ID
routeTableId	String	路由表ID
sourceAddress	String	源网段
destinationAddress	String	目标网段
nexthopId	String	下一跳ID，当nexthopType是本地网关类型时，该字段可以为空
nexthopType	String	路由类型。Bcc类型是"custom"；VPN类型是"vpn"；NAT类型是"nat”；专线网关类型是"dcGateway";对等连接类型是"peerConn";IPv6网关类型是"ipv6gateway"; 系统默认类型是"sys”,VPC为每个子网自动生成一条默认路由规则，该类型的路由规则id是空，不可编辑和删除。
pathType	String	单线或多线路由。单线为"normal"，多线取值为ecmp或ha:active或ha:standby
description	String	描述

NextHop

参数名称	类型	描述
nexthopId	String	下一跳ID
nexthopType	String	路由类型。目前只支持专线网关类型："dcGateway"
pathType	String	多线模式。负载均衡取值为ecmp；主备模式取值ha:active、ha:standby，分别表示主、备路由

SecurityGroupModel

参数名称	类型	描述
id	String	安全组ID
name	String	名称,支持大小写字母、数字、中文以及-_ /.特殊字符，必须以字母开头，长度1-65。
desc	String	描述
vpcId	String	私有网络VPC ID
createdTime	String	安全组创建时间
sgVersion	Long	安全组版本号
rules	List<SecurityGroupRuleModel>	安全组规则
tags	List<TagModel>	安全组绑定的标签列表

SecurityGroupRuleModel

参数名称	类型	描述	是否必须
remark	String	备注	否
direction	String	入站/出站，取值ingress或egress。	是
ethertype	String	网络类型，取值IPv4或IPv6。值为空时表示默认取值IPv4。	否
portRange	String	端口范围，可以指定80等单个端口，值为空时默认取值1-65535。	否
protocol	String	协议类型，tcp、udp或icmp，值为空时默认取值all。	否
sourceGroupId	String	源安全组ID	否
sourceIp	String	源IP地址，与sourceGroupId不能同时设定值。	否
destGroupId	String	目的安全组ID	否
destIp	String	目的IP地址，与destGroupId不能同时设定值。	否
securityGroupId	String	安全组ID	否
securityGroupRuleId	String	安全组规则ID	否
createdTime	String	安全组规则创建时间	否
updatedTime	String	安全组规则修改时间	否

EnterpriseSecurityGroupModel

参数名称	类型	描述
id	String	企业安全组ID
name	String	名称,支持大小写字母、数字、中文以及-_ /.特殊字符，必须以字母开头，长度1-65。
desc	String	描述
createdTime	String	企业安全组创建时间
updatedTime	String	企业安全组更新时间
rules	List<EnterpriseSecurityGroupRuleModel>	企业安全组规则
tags	List<TagModel>	企业安全组绑定的标签列表

EnterpriseSecurityGroupRuleModel

参数名称	类型	描述
remark	String	备注，长度1-255。
direction	String	入站/出站，取值ingress或egress。
ethertype	String	网络类型，取值IPv4或IPv6。值为空时表示默认取值IPv4。
portRange	String	目的端口范围，支持连续端口（比如“1-80”）和离散端口（比如“80,7000,8000”，英文逗号隔开，离散值数量不超过15个），值为空时默认取值1-65535。
sourcePortRange	String	源端口范围，支持连续端口（比如“1-80”）和离散端口（比如“80,7000,8000”，英文逗号隔开，离散值数量不超过15个），值为空时默认取值1-65535。
protocol	String	协议类型，tcp、udp或icmp，值为空时默认取值all。
sourceIp	String	源IP地址，all表示全部。
destIp	String	目的IP地址，all表示全部。
localIp	String	本端IP地址，all表示全部。
remoteIpSet	String	远端IP地址组
remoteIpGroup	String	远端IP地址族
action	String	允许/拒绝，取值allow或deny。
priority	Integer	优先级，取值范围1-1000。
enterpriseSecurityGroupRuleId	String	企业安全组规则ID
createdTime	String	企业安全组规则创建时间
updatedTime	String	企业安全组规则修改时间

AclEntry

参数名称	类型	描述
subnetId	String	子网ID
subnetName	String	子网名称
subnetCidr	String	子网的CIDR
aclRules	List<AclRule>	ACL规则集合

AclRule

参数名称	类型	描述
id	String	ACL规则ID
subnetId	String	子网的ID
description	String	备注
protocol	String	协议，包括all tcp udp icmp
sourceIpAddress	String	源IP,可以为all
destinationIpAddress	String	目的IP,可以为all
sourcePort	String	源端口,例如1-65535，或8080
destinationPort	String	目的端口,例如1-65535，或8080
position	String	优先级 1-5000且不能与已有条目重复。数值越小，优先级越高，规则匹配顺序为按优先级由高到低匹配
direction	String	规则的入站ingress 规则的出站egress
ipVersion	Integer	acl规则的版本。4表示IPv4 6表示IPv6
action	String	策略，包括allow和deny

AclRuleRequest

参数名称	类型	是否必需	参数位置	描述
subnetId	String	是	RequestBody参数	子网的ID
description	String	否	RequestBody参数	备注
protocol	String	是	RequestBody参数	协议，包括all tcp udp icmp
sourceIpAddress	String	是	RequestBody参数	源IP
destinationIpAddress	String	是	RequestBody参数	目的IP
sourcePort	String	是	RequestBody参数	源端口，例如1-65535，或8080
destinationPort	String	是	RequestBody参数	目的端口，例如1-65535，或8080
position	Integer	是	RequestBody参数	优先级 1-5000且不能与已有条目重复。数值越小，优先级越高，规则匹配顺序为按优先级由高到低匹配
direction	String	是	RequestBody参数	规则的入站ingress 规则的出站egress
ipversion	Integer	否	RequestBody参数	默认为4。如果添加IPv6规则，则该值为6必传
action	String	是	RequestBody参数	策略，包括allow和deny

Billing

参数名称	类型	描述
paymentTiming	String	付款时间，预支付（Prepaid）和后支付（Postpaid），创建订单需要设置，续费订单无需设置
reservation	Reservation	保留信息，支付方式为后支付时不需要设置，预支付时必须设置

Reservation

参数名称	类型	描述
reservationLength	Integer	时长，[1,2,3,4,5,6,7,8,9,12,24,36]
reservationTimeUnit	String	时间单位，month，当前仅支持按月

PeerConn

参数名称	类型	描述
peerConnId	String	对等连接的ID
role	String	对等连接角色 initiator发起端 acceptor接收端
status	PeerConnStatus	对等连接状态
bandwidthInMbps	String	对等连接的带宽
description	String	对等连接备注
localIfId	String	对等连接本端接口ID
localIfName	String	对等连接本端接口名称
localVpcId	String	对等连接本端VPC的ID
localRegion	String	对等连接本端区域
peerVpcId	String	对等连接对端VPC的ID
peerRegion	String	对等连接对端区域
peerAccountId	String	对等连接对端的账户ID
paymentTiming	String	对等连接的付费类型
dnsStatus	DnsStatus	DNS同步状态
createdTime	String	对等连接的创建时间
expiredTime	String	过期时间，只有预付费产品此参数才有值

PeerConnStatus

参数名称	类型	描述
creating	String	创建中
consulting	String	协商中
consult_failed	String	协商失败
active	String	可用
down	String	不可用
starting	String	启动中
stopping	String	停止中
deleting	String	删除中
deleted	String	已删除
expired	String	已到期
error	String	异常
updating	String	更新中

DnsStatus

参数名称	类型	描述
close	String	关闭同步
wait	String	等待同步
syncing	String	同步中
open	String	开启同步
closing	String	关闭同步中

NAT

参数名称	类型	描述
id	String	NAT网关的ID
name	String	NAT网关名称
natType	String	NAT网关类型，enhanced表示增强型，normal表示普通型
vpcId	String	NAT网关所属VPC的ID
spec	String	NAT网关的大小，有small(最多支持绑定5个公网IP)、medium(最多支持绑定10个公网IP)、large(最多支持绑定15个公网IP)三种，仅适用于普通型NAT网关
eips	List<String>	NAT网关绑定的Snat EIP的IP地址列表
dnatEips	List<String>	NAT网关绑定的Dnat EIP的IP地址列表
bindEips	List<String>	NAT网关绑定的EIP的IP地址列表，仅适用于增强型NAT网关
status	NatStatus	NAT网关的状态
paymentTiming	String	付费方式 预付费Prepaid 后付费Postpaid
expiredTime	String	过期时间
createTime	String	创建时间

NatStatus

状态	描述
active	运行中
updating	更新中
unconfigured	未配置
down	不可用
building	创建中
error	状态异常
deleting	删除中
deleted	已删除
starting	启动中
configuring	配置中
rebooting	重启中
stopping	停止中

SnatRule

参数名称	类型	描述
ruleId	String	规则ID
ruleName	String	规则名称，由大小写字母、数字以及-_ /.特殊字符组成，必须以字母开头，长度1-65
publicIpsAddress	List<String>	公网IP列表，关联在NAT网关SNAT上的EIP或共享带宽中的IPs
sourceCIDR	String	内网IP/网段
status	String	规则状态

DnatRule

参数名称	类型	描述
ruleId	String	规则ID
ruleName	String	DNAT规则名称，由大小写字母、数字以及-_ /.特殊字符组成，必须以字母开头，长度1-65
publicIpAddress	String	公网IP，关联在NAT网关DNAT上的EIP或共享带宽中的IP
privateIpAddress	String	内网IP
protocol	String	协议，支持TCP、UDP、all
publicPort	String	公网IP端口（1-65535）
privatePort	String	内网IP端口（1-65535）
status	String	规则状态
privatePortRange	String	内网端口范围
publicPortRange	String	公网端口范围

TagModel

参数名称	类型	描述
tagKey	String	标签的键，可包含大小写字母、数字、中文以及-_ /.特殊字符，长度1-65
tagValue	String	标签的值，可包含大小写字母、数字、中文以及-_ /.特殊字符，长度0-65

Vpn

参数名称	类型	描述
vpnId	String	VPN的ID
vpnName	String	名称
type	String	网关类型，取值[IPSec, SSL]
description	String	描述
status	String	vpn状态，active：可用，building：创建中，unconfigured：未配置
expiredTime	String	到期时间
paymentTiming	String	计费类型
eip	String	公网IP
maxConnection	Integer	SSL-VPN最大客户端连接数
bandwidthInMbps	Integer	EIP带宽
vpcId	String	VPC的ID
vpnConnNum	Integer	隧道数量
vpnConns	List<VpnConn>	VPN隧道列表
sslVpnServer	SslVpnServer	SSL-VPN服务端
deleteProtect	Boolean	是否开启释放保护
tags	List<TagModel>	VPN绑定的标签集合
createTime	String	创建时间

VpnConn

参数名称	类型	描述
vpnId	String	VPN的ID
vpnConnId	String	隧道的ID
vpnConnName	String	隧道的名称
localIp	String	本地IP
secretKey	String	共享秘钥
localSubnets	List<String>	本端网络CIDR列表
remoteIp	String	对端VPN网关公网IP
remoteSubnets	List<String>	对端网络CIDR列表
description	String	描述
status	String	VPN隧道的状态
createdTime	String	创建时间
healthStatus	String	联通状态
ikeConfig	IkeConfig	IKE配置
ipsecConfig	IpsecConfig	IPSec配置

SslVpnServer

参数名称	类型	描述
vpnId	String	VPN的ID
sslVpnServerId	String	SSL-VPN服务端ID
sslVpnServerName	String	SSL-VPN服务端的名称
interfaceType	String	SSL-VPN服务端接口类型
status	String	SSL-VPN服务端状态
localSubnets	List<String>	本端网络CIDR列表
remoteSubnet	String	客户端网络CIDR
clientDns	String	客户端的DNS地址
maxConnection	Integer	SSL-VPN最大客户端连接数

SslVpnUserVo

参数名称	类型	描述
userName	String	用户名
userId	String	用户ID
description	String	描述

SslVpnUser

参数名称	类型	是否必需	参数位置	描述
userName	String	是	RequestBody参数	用户名，大小写字母、数字以及-_/.特殊字符，必须以字母开头，长度1-65
password	String	是	RequestBody参数	密码，8～17位字符，英文、数字和符号必须同时存在，符号仅限!@#$%^*(_
description	String	否	RequestBody参数	描述

IkeConfig

参数名称	类型	描述
ikeVersion	String	版本，取值范围：v1/v2
ikeMode	String	协商模式，取值范围：main/aggressive
ikeEncAlg	String	加密算法，取值范围：aes/aes192/aes256/3des
ikeAuthAlg	String	认证算法，取值范围：sha1/md5
ikePfs	String	DH分组，取值范围：group2/group5/group14/group24
ikeLifeTime	String	SA生命周期,取值范围：60-86400

IpsecConfig

参数名称	类型	描述
ipsecEncAlg	String	加密算法，取值范围：aes/aes192/aes256/3des
ipsecAuthAlg	String	认证算法，取值范围：sha1/md5
ipsecPfs	String	DH分组，取值范围：group2/group5/group14/group24
ipsecLifetime	String	SA生命周期,取值范围：180-86400

Eni

参数名称	类型	描述
eniId	String	弹性网卡的ID
name	String	弹性网卡的名称
zoneName	String	弹性网卡所属的可用区
description	String	弹性网卡的描述
instanceId	String	挂载的云主机ID
macAddress	String	弹性网卡的mac地址
vpcId	String	弹性网卡的VPC ID
subnetId	String	弹性网卡的子网ID
status	String	弹性网卡的状态
privateIpSet	List<PrivateIP>	弹性网卡的IPv4 IP集合
ipv6PrivateIpSet	List<PrivateIP>	弹性网卡的IPv6 IP集合

HaVip

参数名称	类型	描述
haVipId	String	高可用虚拟IP的ID
name	String	高可用虚拟IP的名称
description	String	高可用虚拟IP的描述
vpcId	String	高可用虚拟IP所在VPC的ID
subnetId	String	高可用虚拟IP所在子网的ID
status	String	高可用虚拟IP的状态，"available"表示可用，"binded"表示已绑定实例
privateIpAddress	String	高可用虚拟IP内网地址
publicIpAddress	String	高可用虚拟IP公网地址
createdTime	String	高可用虚拟IP实例创建时间

HaVipBindedInstance

参数名称	类型	描述
instanceId	String	绑定的实例ID
instanceType	String	绑定的实例类型，"SERVER"表示云服务器（BCC/BBC/DCC），"ENI"表示弹性网卡
master	Boolean	主备标识，true表示主，false表示备

Endpoint

参数名称	类型	描述
endpointId	String	服务网卡的ID
name	String	服务网卡的名称
ipAddress	String	服务网卡IP
status	String	服务网卡状态，取值：available/unavailable，分别表示：可挂载/不可挂载
service	String	服务唯一域名
subnetId	String	子网ID
description	String	描述
createTime	String	创建时间
vpcId	String	VPC的ID
productType	String	付费类型

PrivateIP

参数名称	类型	描述
publicIpAddress	String	弹性网卡的公网IP地址，即EIP地址
primary	Boolean	是否是主IP
privateIpAddress	String	弹性网卡的内网Ip地址

EgressOnlyRule

参数名称	类型	描述
egressOnlyRuleId	String	只出不进策略的ID
cidr	String	只出不进策略的cidr

RateLimitRule

参数名称	类型	描述
rateLimitRuleId	String	IPv6限速策略的ID
ipv6Address	String	限速的IPv6地址
ingressBandwidthInMbps	Integer	入口带宽
egressBandwidthInMbps	Integer	出口带宽

DnatRuleRequest

参数名称	类型	描述
ruleName	String	名称，由大小写字母、数字以及-_ /.特殊字符组成，必须以字母开头，长度1-65，非必填
publicIpAddress	String	公网IP，关联在NAT网关DNAT上的EIP或共享带宽中的IP
privateIpAddress	String	内网IP
protocol	String	协议，支持TCP、UDP、all
publicPort	Integer	公网端口(1-65535)，协议为TCP、UDP时有效，不能与端口范围同时指定
privatePort	Integer	内网端口(1-65535)，协议为TCP、UDP时有效，不能与端口范围同时指定
publicPortRange	String	公网端口范围，如“80-90”，协议为TCP、UDP时有效，不能与单个端口同时指定
privatePortRange	String	内网端口范围，如“80-90”，协议为TCP、UDP时有效，不能与单个端口同时指定

SnatRuleRequest

参数名称	类型	描述
ruleName	String	名称，由大小写字母、数字以及-_ /.特殊字符组成，必须以字母开头，长度1-65
publicIpsAddress	List<String>	公网IP列表，关联在NAT网关SNAT上的EIP或共享带宽中的IPs
sourceCIDR	String	内网IP/网段

EtGateway

参数名称	类型	描述
etGatewayId	String	专线网关id
name	String	专线网关名称
status	String	专线网关状态
speed	Integer	出口带宽
createTime	String	创建时间
description	String	专线网关描述
vpcId	String	虚拟网络id
etId	String	专线id
channelId	String	专线通道id
localCidrs	List<String>	IPv4云端网络
enableIpv6	Integer	IPv6功能是否开启，1是0否
ipv6LocalCidrs	List<String>	IPv6云端网络
tags	List<TagModel>	专线网关绑定的标签集合

Probe

参数名称	类型	描述
probeId	String	探测ID
description	String	探测描述
destIp	String	目的地址
destPort	Integer	目的端口
frequency	Integer	探测频率
name	String	探测名称
payload	String	探测内容实体
protocol	String	探测类型。TCP、UDP、ICMP、DNS
sourceIps	List<String>	探测源地址
status	String	状态，active可用
subnetId	String	所属子网ID
vpcId	String	所属VPC ID

TemplateIpAddressInfo

参数名称	类型	描述
ipAddress	String	参数模板IP地址，可为具体IP地址或者CIDR块
description	String	参数模板IP地址，具体描述

IpSet

参数名称	类型	描述
ipSetId	String	IP地址组的ID
name	String	IP地址组的名称
description	String	IP地址组的描述
ipVersion	String	ipVersion，取值IPv4或IPv6
ipAddressInfo	List<TemplateIpAddressInfo>	参数模板IP地址信息
bindedInstanceNum	Integer	IP地址组绑定实例数量

IpCollectionBindedInstance

参数名称	类型	描述
instanceId	String	参数模板绑定的实例ID
instanceType	String	参数模板绑定的实例类型，目前暂时仅"ESG"，表示企业安全组

IpGroup

参数名称	类型	描述
ipGroupId	String	IP地址族的ID
name	String	IP地址族的名称
description	String	IP地址族的描述
ipVersion	String	ipVersion，取值IPv4或IPv6
ipSetIds	List<String>	关联的IP地址组ID列表
bindedInstanceNum	Integer	IP地址族绑定实例数量

GlrItem

参数名称	类型	描述
glrId	String	限速规则ID
ipVersion	String	IP协议版本，取值"4"
name	String	限速规则名称
description	String	描述信息
serviceType	String	服务类型： perrconn-对等连接 et-专线网关 csn-云智能网
subServiceType	String	子服务类型，当serviceType是csn时该字段存在值： LOCAL 实例带宽 PEER_CLOUD 云间互通 PEER_EDGE 云边互通
resourceId	String	资源ID
direction	String	流量方向
cidr	String	CIDR
bandwidth	Integer	带宽
enable	Boolean	是否启用
createdTime	String	创建时间
updatedTime	String	修改时间