文档中心私有网络API 文档私有网络 API 2017对象属性说明

对象属性说明

最近更新时间：2019-11-26 19:11:45

前往 GitHub 编辑 我的收藏

本页目录：

1. 私有网络相关属性

属性	类型	说明
vpcId	String	系统分配的 vpcId，例如：gz_vpc_266
unVpcId	String	系统分配新的 vpcID，由 vpcId 升级而来，为了兼容这两种 ID 系统都支持，推荐使用新的 ID，例如：vpc-2ari9m7h
vpcName	String	VPC 名称，支持1-60个中文、英文大小写的字母、数字和下划线分隔符
cidrBlock	String	VPC 网段,可选值 10.0.0.0/16、172.16.0.0/16和192.168.0.0/16及它们包含的子网，详见 VPC 网段规划说明
createTime	String	私有网络创建时间，例如：2016-05-18 15:01:46

2. 子网相关属性

属性	类型	说明
subnetId	String	系统分配的子网 ID，例如：gz_subnet_18720
unSubnetId	String	系统分配新的子网 ID，由子网 ID 升级而来，为了兼容这两种 ID 系统都支持，推荐使用这种新的 ID，例如：subnet-2ari9m7h
subnetName	String	VPC 名称，支持1-60个中文、英文大小写的字母、数字和下划线分隔符,例如：计费平台私有网络
cidrBlock	String	VPC 网段,可选值 10.0.0.0/16、172.16.0.0/16和192.168.0.0/16及它们包含的子网，详见 VPC 网段规划说明
zoneId	String	可用区 ID，详见可用区管理
createTime	String	子网创建时间，例如：2016-05-18 15:01:46

3. 路由表相关属性

属性	类型	说明
routeTableName	String	路由表名称，支持1-60个中文、英文大小写的字母、数字和下划线分隔符
destinationCidrBlock	String	目的网段，取值不能在私有网络网段内，例如：112.20.51.0/24
nextType	String	下一跳类型，目前我们支持的类型有：0：公网网关；1：VPN 网关； 3：专线网关；4：对等连接；7：sslvpn;8:NAT 网关
nextHub	String	下一跳地址，这里只需要指定不同下一跳类型的网关 ID（推荐使用新 ID），系统会自动匹配到下一跳地址。

4. 网络 ACL 相关属性

属性	类型	说明
networkAclId	String	系统分配的网络 ACL ID，例如：acl-4n9efgju
networkAclName	String	网络 ACL 名称，支持1-60个中文、英文大小写的字母、数字和下划线分隔符
ruleDirection	Int	网络 ACL 策略方向，0：出方向；1：入方向
networkAclEntrySet	Array	ACL 策略，详见网络 ACL 接口文档

5. IPsec VPN 网关属性

属性	类型	说明
vpnGwId	String	系统分配的 VPN 网关 ID，例如：95
unVpnGwId	String	系统分配新的 VPN 网关ID，由 vpnGwId 升级而来，为了兼容这两种 ID 系统都支持，推荐使用新的网关 ID，例如：vpngw-nhg87nmg
vpnGwName	String	VPN 网关名称，支持1-60个中文、英文大小写的字母、数字和下划线分隔符
vpnGwAddress	String	VPN 网关公网IP地址，例如：115.159.26.189
bandwidth	Int	VPN 网关带宽,例如5,10,20...，单位Mb,详见 VPN 网关规格说明文档
expireTime	String	VPN 网关到期时间
isAutoRenewals	Bool	是否开启自动续费。true:开启；false:不开启。默认是 true
state	Int	VPN 网关状态；0：创建中；1：创建失败；2：修改中；3：修改失败；4：删除中；5：删除失败；6：运行中
createTime	String	VPN 网关创建时间，例如：2016-05-18 15:01:46

6. VPN 通道属性

属性	类型	说明
vpnConnId	String	系统分配的 VPN 通道 ID，例如：534
unVpnConnId	String	系统分配新的 VPN 通道 ID，由 vpnConnId 升级而来，为了兼容这两种 ID 系统都支持，推荐使用新的通道 ID，例如：vpnx-pvjmedgm
vpnConnName	String	VPN 通道，支持1-60个中文、英文大小写的字母、数字和下划线分隔符
preSharedKey	String	预共享密钥
spdAcl	Array	SPD 策略规则,细粒度的流量配置，详见VPN通道接口文档
IKE	Array	IKE 配置，详见 VPN 通道接口文档
IPsec	Array	IPsec 配置，详见 VPN 通道接口文档
state	Int	VPN 通道状态；0：创建中；1：创建失败；2：修改中；3：修改失败；4：删除中；5：删除失败；6：运行中
createTime	String	VPN 通道创建时间，例如：2016-05-18 15:01:46

7. 对端网关属性

属性	类型	说明
userGwId	String	系统分配的对端网关 ID，例如：404
unUserGwId	String	系统分配新的对端网关 ID，由 userGwId 升级而来，为了兼容这两种 ID 系统都支持，推荐使用新的对端网关ID，例如：cgw-7ihaps8r
userGwName	String	对端网关名称
userGwAddr	String	对端网关公网IP地址,不能是私有地址，也不能是广播地址或者组播地址
createTime	String	对端网关创建时间，例如：2016-05-18 15:01:46

8. SSL VPN 网关属性

属性	类型	说明
sslVpnId	String	系统分配的 SSL VPN 网关 ID，例如：vpngw-nhg87nmg
sslVpnName	String	SSL VPN 名称，支持1-60个中文、英文大小写的字母、数字和下划线分隔符
sslVpnAddress	String	SSL VPN 网关公网IP地址，例如：115.159.26.189
bandwidth	Int	SSL VPN 网关带宽,支持5,10,20,50,100，单位Mb,详见 VPN 网关规格说明文档
sslVpnPort	String	SSL VPN 端口
ipPool.n	Array	SSL VPN终端IP池，终端IP会从这个IP池分配IP，例如ipPool.0=183.162.10.1
acl	Array	SSL VPN 域的 ACL 策略信息，详见 SSL VPN 接口文档
expireTime	String	SSL VPN 网关到期时间
isAutoRenewals	Bool	是否开启自动续费。true:开启；false:不开启。默认是 true
state	Int	ssl SSL VPN 状态；0：创建中；1：创建失败；2：修改中；3：修改失败；4：删除中；5：删除失败；6：运行中
createTime	String	ssl SSL VPN 创建时间，例如：2016-05-18 15:01:46

9. 对等连接相关属性

属性	类型	说明
peeringConnectionId	String	系统分配的对等连接 ID，例如：pcx-55i0gr4s
peeringConnectionName	String	对等连接名称，支持1-60个中文、英文大小写的字母、数字和下划线分隔符
vpcId	String	发起方 vpcId，例如：vpc-55i0gr4s
uin	String	发起方 QQ 号码
region	String	发起方地域，支持的地域详见对等连接接口文档
peerVpcId	String	接收方 vpcId，例如：vpc-55i0gr4s
peerUin	String	接收方 QQ 号码
peerRegion	String	接收方地域，支持的地域详见对等连接接口文档
bandwidth	String	对等连接带宽，支持的带宽详见对等连接接口文档
state	Int	对等连接状态；0：待接收；1：运行中；2：过期；3：拒绝；4：删除中；5：创建失败
createTime	String	对等连接创建时间，例如：2016-05-18 15:01:46

10. 专线网关相关属性

属性	类型	说明
directConnectGatewayId	String	专线网关 ID，例如：dcg-rw6a1ozr
directConnectGatewayName	String	对等连接名称，支持1-60个中文、英文大小写的字母、数字和下划线分隔符
type	Int	专线网关类型，0:非 NAT；1：NAT，默认为非 NAT 网关
natRule	Array	网络地址转换规则，详见专线网关接口文档
aclRule	Array	网络 ACL 策略组，详见专线网关接口文档
createTime	String	专线网关创建时间，例如：2016-05-18 15:01:46

11. NAT 网关相关属性

属性	类型	说明
natId	String	系统分配的 NAT 网关 ID，例如：nat-dhfpwhtm
natName	String	NAT 网关名称，支持1-60个中文、英文大小写的字母、数字和下划线分隔符
maxConcurrent	Int	网关并发连接上限，例如：100、300、1000，单位为万
bandwidth	Int	网关最大外网出带宽(单位:Mbps)，详见 NAT 网关接口文档
state	Int	NAT网关状态；0：运行中；1：不可用；2：欠费停服；
createTime	String	NAT 网关创建时间，例如：2016-05-18 15:01:46

12. 弹性网卡相关属性

属性	类型	说明
networkInterfaceId	String	系统分配的弹性网卡 ID，例如：eni-9r7vukmh
eniName	String	弹性网卡名称，支持1-60个中文、英文大小写的字母、数字和下划线分隔符
eniDescrption	String	弹性网卡描述，25个字符以内
primary	Bool	弹性网卡类型，true:主网卡；false:普通网卡
macAddress	String	弹性网卡 mac 地址，例如：02:81:60:cb:27:37
vpcId	String	弹性网卡所属的私有网络 ID，例如：vpc-2ari9m7h
subnetId	String	弹性网卡所属的子网 ID，例如：subnet-2ari9m7h
createTime	String	弹性网卡创建时间，例如：2016-05-18 15:01:46

13. 私有网络与基础网络互通相关属性

属性	类型	说明
classicLinkId	String	系统分配的互通 ID，例如：vcx-8kbdxt2h
vpcId	String	私有网络 ID，例如：gz_vpc_164
instanceId	String	与 VPC 互通的基础网络云服务器资源 ID，例如：ins-dgd54d
createTime	String	基础网络设备与 VPC 互通创建时间，例如：2016-05-18 15:01:46

14. 流日志相关属性

属性	类型	说明
vpcId	String	系统分配的 vpcId，例如：gz_vpc_266
flowLogName	String	流日志名称。
flowLogDescription	String	流日志描述，默认为"",可选项。
resourceType	String	流日志所属资源类型，VPC\|SUBNET\|NETWORKINTERFACE。
resourceId	String	资源唯一 ID，例如 vpc-puz6fg, subnet-5o8ycyt, eni-08dhim。
trafficType	String	流日志采集类型，ACCEPT\|REJECT\|ALL。
cloudLogId	String	流日志存储 ID, 暂时只支持日志服务 ID，例如 d44e4cf0-c3e2-48d9-bb64-c5f0337ef2b0。
flowLogId	String	流日志唯一 ID，示例：fl-q1b26f3d。
createdTime	String	流日志创建时间。

上一篇: 签名方法下一篇: 使用示例

文档反馈

文档活动

目录