文档中心知识库API Explorer
文档中心›ZCF›ZStack Cloud›探索更多›CLI命令使用手册ZCF
文档目录

路由资源

概览

VPC路由器：一个定制的云主机，用于提供多种网络服务。

功能特点

  • VPC路由器可提供的网络服务包括：虚拟IP、弹性IP、IPsec隧道、端口转发、负载均衡、DHCP等。
  • 支持为VPC路由器设置组播路由。
  • VPC路由器可灵活挂载或卸载VPC网络或其他公有网络。
  • VPC路由器拥有高于云主机的资源优先级，当物理机负载率过高，出现资源竞争时，资源优先级顺序为（从低到高）：优先级为正常的云主机 < 优先级为高的云主机 < VPC路由器。例如：当物理机出现CPU资源竞争时， 较于普通云主机，VPC路由器具备更高的CPU资源抢夺能力。

注意事项

  • 创建VPC路由器前，须提前创建路由器规格所需的公有网络和管理网络、路由器镜像资源。
  • 基于路由器规格直接创建的VPC路由器，拥有公有网络和管理网络，且路由器规格定义的公有网络和管理网络，不可卸载。
  • 建议单个VPC路由器上的VPC网络和公有网络数量不超过23个。网络数量过多可能会造成VPC路由器性能下降，影响相关网络服务质量。
  • 由于所有网络服务共享物理网卡的带宽，单个VPC路由器上承载过多虚拟IP可能造成网络性能瓶颈。建议使用虚拟IP创建网络服务时，根据实际业务带宽需求，合理规划虚拟IP数量。

清单

属性

名字 描述 可选的 可选的参数值 起始支持版本
uuid 请参见资源结构 0.6
name 请参见资源结构 0.6
description 请参见资源结构 是 0.6
agentPort 0.6
allocatorStrategy 分配策略
  • DefaultHostAllocatorStrategy
  • LastHostPreferredAllocatorStrategy
  • LeastVmPreferredHostAllocatorStrategy
  • MinimumCPUUsageHostAllocatorStrategy
  • MinimumMemoryUsageHostAllocatorStrategy
  • MaxInstancePerHostHostAllocatorStrategy
 0.6
applianceVmType 特殊云主机的类型 0.6
clusterUuid 集群uuid 0.6
zoneUuid 区域uuid 0.6
cpuNum CPU数量 0.6
cpuSpeed 0.6
defaultL3NetworkUuid 默认三层网络uuid 0.6
defaultRouteL3NetworkUuid 路由器云主机提供默认路由（default routing）的L3网络的uuid 0.6
hostUuid 物理主机uuid 0.6
lastHostUuid 上次所在物理主机uuid 0.6
imageUuid 镜像uuid 0.6
rootVolumeUuid 根云盘uuid 0.6
instanceOfferingUuid 计算规格uuid 0.6
managementNetworkUuid 管理网络uuid 0.6
publicNetworkUuid 公有网络uuid 0.6
memorySize 内存大小 0.6
hypervisorType 云主机管理程序类型 0.6
platform 0.6
state 可用状态
  • Enabled
  • Disabled
 0.6
status 连接状态 0.6
groupBy
createDate 请参见资源结构 0.6
lastOpDate 请参见资源结构 0.6
type 类型
  • UserVm
  • ApplianceVm
 0.6

示例

{
    "inventories": [
        {
            "agentPort": 7272,
            "allVolumes": [
                {
                    "actualSize": 293641216,
                    "createDate": "Nov 10, 2017 2:59:57 PM",
                    "description": "Root volume for VM[uuid:f90177b78a3d4f399f32bf84af32afde]",
                    "deviceId": 0,
                    "format": "qcow2",
                    "installPath": "/Cloud_ps_nxs/rootVolumes/acct-36c27e8ff05c4780bf6d2fa65700f22e/vol-47401aeef0b54ec\
f90b831f2e250c098/47401aeef0b54ecf90b831f2e250c098.qcow2",
                    "isShareable": false,
                    "lastOpDate": "Nov 10, 2017 2:59:57 PM",
                    "name": "ROOT-for-vrouter.l3.L3-路由器-2.e293d6",
                    "primaryStorageUuid": "cae8726c90784ba0946f852952731268",
                    "rootImageUuid": "ef614d2e1db7536a8fb8260a05074ae4",
                    "size": 8589934592,
                    "state": "Enabled",
                    "status": "Ready",
                    "type": "Root",
                    "uuid": "47401aeef0b54ecf90b831f2e250c098",
                    "vmInstanceUuid": "f90177b78a3d4f399f32bf84af32afde"
                }
            ],
            "allocatorStrategy": "LeastVmPreferredHostAllocatorStrategy",
            "applianceVmType": "vrouter",
            "clusterUuid": "967a353c2893409dab9312cf3033a98c",
            "cpuNum": 1,
            "cpuSpeed": 0,
            "createDate": "Nov 10, 2017 2:59:57 PM",
            "defaultRouteL3NetworkUuid": "cdb7f3151c50453ba0e8c89356e250f6",
            "hostUuid": "aec5230c3eee40e4998bec50a1c2eae8",
            "hypervisorType": "KVM",
            "imageUuid": "ef614d2e1db7536a8fb8260a05074ae4",
            "instanceOfferingUuid": "fa550cb9bdcc4fd397ae37f9ddf4c390",
            "lastHostUuid": "aec5230c3eee40e4998bec50a1c2eae8",
            "lastOpDate": "Nov 16, 2017 11:07:30 AM",
            "managementNetworkUuid": "cdb7f3151c50453ba0e8c89356e250f6",
            "memorySize": 1073741824,
            "name": "vrouter.l3.L3-路由器-2.e293d6",
            "platform": "Linux",
            "publicNetworkUuid": "cdb7f3151c50453ba0e8c89356e250f6",
            "rootVolumeUuid": "47401aeef0b54ecf90b831f2e250c098",
            "state": "Running",
            "status": "Connected",
            "type": "ApplianceVm",
            "uuid": "f90177b78a3d4f399f32bf84af32afde",
            "vmNics": [
                {
                    "createDate": "Nov 10, 2017 2:59:57 PM",
                    "deviceId": 1,
                    "gateway": "192.168.23.1",
                    "ip": "192.168.23.1",
                    "l3NetworkUuid": "e293d67b0e4a4b438f15b768cacb6eaf",
                    "lastOpDate": "Nov 10, 2017 2:59:57 PM",
                    "mac": "fa:63:dd:7a:56:01",
                    "metaData": "4",
                    "netmask": "255.255.255.0",
                    "uuid": "281f9ac039c44bb18337217543e551ea",
                    "vmInstanceUuid": "f90177b78a3d4f399f32bf84af32afde"
                },
                {
                    "createDate": "Nov 10, 2017 2:59:57 PM",
                    "deviceId": 0,
                    "gateway": "10.0.0.1",
                    "ip": "10.141.26.16",
                    "l3NetworkUuid": "cdb7f3151c50453ba0e8c89356e250f6",
                    "lastOpDate": "Nov 10, 2017 2:59:57 PM",
                    "mac": "fa:31:50:c4:d3:00",
                    "metaData": "3",
                    "netmask": "255.0.0.0",
                    "uuid": "402dc6bf37734753be3661be3d120652",
                    "vmInstanceUuid": "f90177b78a3d4f399f32bf84af32afde"
                }
            ],
            "zoneUuid": "e59b71e99d8a4ea1952b578388b8cd1d"
        }
    ],
    "success": true
}

操作（Operations）

查询路由器（QueryVirtualRouterVm）

管理员可以使用QueryVirtualRouterVm查询路由器。例如：
QueryVirtualRouterVm uuid=efb08e965ba4414fa7320e968178d442
QueryVirtualRouterVm host.uuid=1fc14d00738e468f9aeb791516e97c6a

原生域查询（Primitive Fields of Query）

请参见 appliance vm inventory

嵌套和扩展域查询（Nested and Expanded Fields of Query）

域（Field） 清单（Inventory） 描述 起始支持版本
vmNics VM nic inventory 路由器设备的网卡 0.6
allVolumes volume inventory 路由器设备的云盘 0.6
host host inventory 运行路由器设备的物理主机 0.6
cluster cluster inventory 路由器设备所属的集群 0.6
image image inventory 用于创建路由器设备的镜像 0.6
zone zone inventory 路由器设备所属的区域 0.6
rootVolume volume inventory 路由器设备的根云盘 0.6
virtualRouterOffering virtual router offering inventory 路由器设备的计算规格 0.6
eip EIP inventory 路由器设备提供服务的EIP 0.6
vip VIP inventory 路由器设备提供服务的VIP 0.6
portForwarding port forwarding rule inventory 路由器设备提供服务的端口转发 0.6
loadBalancer loadbalancer inventory 路由器设备提供服务的负载均衡 0.6

重连路由器（ReconnectVirtualRouter）

管理员可以使用ReconnectVirtualRouter重连路由器。例如：
ReconnectVirtualRouter vmInstanceUuid=698c538be5414ac7b04b19f4daa29f74

参数（Parameters）

名字 描述 可选的 可选的参数值 起始支持版本
vmInstanceUuid 路由器设备uuid 0.6
userTags 用户标签，请参见 创建用户标签(CreateUserTag)；资源类型是 VirtualRouterVmVO 是 0.6
systemTags 系统标签，请参见 创建系统标签(CreateSystemTag)； 资源类型是 VirtualRouterVmVO 是 0.6
timeout 是

创建路由器规格（CreateVirtualRouterOffering）

管理员可以使用CreateVirtualRouterOffering创建路由器规格。例如：
CreateVirtualRouterOffering name=VROffering zoneUuid=fad9475e374a471e8e95eca6177f7075 \
cpuNum=1 memorySize=1073741824 imageUuid=fd59830722741bf49d25398f34723cb8 \
managementNetworkUuid=10a60c0bc05b418c9f9f3d86ba65280a

参数（Parameters）

名字 描述 可选的 可选的参数值 起始支持版本
managementNetworkUuid 管理L3网络uuid 0.6
zoneUuid 区域uuid 0.6
imageUuid 镜像uuid 0.6
publicNetworkUuid 公有L3网络uuid 是 0.6
isDefault 默认 是 0.6
name 资源名称 0.6
description 资源的详细描述 是 0.6
cpuNum CPU数量 0.6
memorySize 内存大小 0.6
allocatorStrategy 分配策略 是
  • DefaultHostAllocatorStrategy
  • LastHostPreferredAllocatorStrategy
  • LeastVmPreferredHostAllocatorStrategy
  • MinimumCPUUsageHostAllocatorStrategy
  • MinimumMemoryUsageHostAllocatorStrategy
  • MaxInstancePerHostHostAllocatorStrategy
  • DesignatedHostAllocatorStrategy
 0.6
sortKey 排序主键 是 0.6
type 类型 是
  • UserVm
  • ApplianceVm
 0.6
resourceUuid 资源uuid 是 0.6
userTags 用户标签，请参见 创建用户标签(CreateUserTag)；资源类型是 VirtualRouterOfferingVO 是 0.6
systemTags 系统标签，请参见 创建系统标签(CreateSystemTag)； 资源类型是 VirtualRouterOfferingVO 是 0.6
timeout 是

查询路由器规格（QueryVirtualRouterOffering）

管理员可以使用QueryVirtualRouterOffering查询路由器规格。例如：
QueryVirtualRouterOffering imageUuid=f354eb04fb7b3732a9a9de825d68eb5c
QueryVirtualRouterOffering managementL3Network.uuid=a3b2fce8f82b4422a575220a35d6ebbd

原生域查询（Primitive Fields of Query）

请参见 virtual router offering inventory

嵌套和扩展域查询（Nested and Expanded Fields of Query）

域（Field） 清单（Inventory） 描述 起始支持版本
image image inventory 规格包含的镜像 0.6
managementL3Network L3 network inventory 规格包含的管理L3网络 0.6
publicL3Network L3 network inventory 规格包含的公有L3网络 0.6
zone zone inventory 规格所属的区域 0.6

更新路由器规格（UpdateVirtualRouterOffering）

管理员可以使用UpdateVirtualRouterOffering更新路由器规格。例如：
UpdateVirtualRouterOffering uuid=d8f2a1a9eb6146848943e78f7cca6a43

参数（Parameters）

名字 描述 可选的 可选的参数值 起始支持版本
isDefault 默认 是 0.6
imageUuid 镜像UUID 是 0.6
uuid 资源的UUID，唯一标示该资源 0.6
name 资源名称 是 0.6
description 资源的详细描述 是 0.6
allocatorStrategy 是
  • DefaultHostAllocatorStrategy
  • LastHostPreferredAllocatorStrategy
  • LeastVmPreferredHostAllocatorStrategy
  • MinimumCPUUsageHostAllocatorStrategy
  • MinimumMemoryUsageHostAllocatorStrategy
  • MaxInstancePerHostHostAllocatorStrategy
 2.3
systemTags 系统标签，请参见 创建系统标签(CreateSystemTag)； 资源类型是 VirtualRouterOfferingVO 是 0.6
userTags 用户标签，请参见 创建用户标签(CreateUserTag)；资源类型是 VirtualRouterOfferingVO 是 0.6
timeout

查询路由器设备（QueryApplianceVm）

管理员可以使用QueryApplianceVm查询路由器设备。例如：
QueryApplianceVm uuid=efb08e965ba4414fa7320e968178d442
QueryApplianceVm vmNics.vmInstanceUuid=efb08e965ba4414fa7320e968178d442

原生域查询（Primitive Fields of Query）

请参见 appliance vm inventory

嵌套和扩展域查询（Nested and Expanded Fields of Query）

域（Field） 清单（Inventory） 描述 起始支持版本
vmNics VM nic inventory 路由器设备的网卡 0.6
allVolumes volume inventory 路由器设备的云盘 0.6
host host inventory 运行路由器设备的物理主机 0.6
cluster cluster inventory 路由器设备所属的集群 0.6
image image inventory 用于创建路由器设备的镜像 0.6
zone zone inventory 路由器设备所属的区域 0.6
rootVolume volume inventory 路由器设备的根云盘 0.6
virtualRouterOffering virtual router offering inventory 路由器设备的计算规格 0.6
eip EIP inventory 路由器设备提供服务的EIP 0.6
vip VIP inventory 路由器设备提供服务的VIP 0.6
portForwarding port forwarding rule inventory 路由器设备提供服务的端口转发 0.6

获取路由器可加载外部网络（GetAttachablePublicL3ForVRouter）

管理员可以使用GetAttachablePublicL3ForVRouter获取路由器可加载的公有网络和系统网络，将自动排除地址冲突的网络。例如：
GetAttachablePublicL3ForVRouter vmInstanceUuid=698c538be5414ac7b04b19f4daa29f74

参数（Parameters）

名字 描述 可选的 可选的参数值 起始支持版本
vmInstanceUuid 路由器设备uuid 2.2
userTags 用户标签，请参见 创建用户标签(CreateUserTag)；资源类型是 VirtualRouterVmVO 是 2.2
systemTags 系统标签，请参见 创建系统标签(CreateSystemTag)； 资源类型是 VirtualRouterVmVO 是 2.2
timeout 是

路由器路由表

创建路由器路由表（CreateVRouterRouteTable）

管理员可以使用CreateVRouterRouteTable创建路由器路由表。例如：
CreateVRouterRouteTable name=VRouterRouteTable1

参数（Parameters）

名字 描述 可选的 可选的参数值 起始支持版本
name 资源名称 2.1
description 资源的详细描述 是 2.1
resourceUuid 资源uuid 是 2.1
userTags 用户标签，请参见 创建用户标签(CreateUserTag)；资源类型是 VirtualRouterVRouterRouteTableRefVO 是 2.1
systemTags 系统标签，请参见 创建系统标签(CreateSystemTag)； 资源类型是 VirtualRouterVRouterRouteTableRefVO 是 2.1
timeout 是

删除路由器路由表（DeleteVRouterRouteTable）

管理员可以使用DeleteVRouterRouteTable删除路由器路由表。例如：
DeleteVRouterRouteTable uuid=c62422b8f644482ea930b84e3200ead9

参数（Parameters）

名字 描述 可选的 可选的参数值 起始支持版本
uuid 路由器路由表uuid 2.1
deleteMode 请参见 删除资源(Delete Resources) 是
  • Permissive
  • Enforcing
 2.1
userTags 用户标签，请参见 创建用户标签(CreateUserTag)；资源类型是 VirtualRouterVRouterRouteTableRefVO 是 2.1
systemTags 系统标签，请参见 创建系统标签(CreateSystemTag)； 资源类型是VirtualRouterVRouterRouteTableRefVO 是 2.1
timeout 是

查询路由器路由表（QueryVRouterRouteTable）

管理员可以使用QueryVRouterRouteTable查询路由器路由表。例如：
QueryVRouterRouteTable uuid=a15ee6c9eba744308f5c32b6f93069fb
QueryVRouterRouteTable attachedRouterRef.virtualRouterVmUuid=efb08e965ba4414fa7320e968178d442

原生域查询（Primitive Fields of Query）

请参见 vrouter route table inventory

嵌套和扩展域查询（Nested and Expanded Fields of Query）

域（Field） 清单（Inventory） 描述 起始支持版本
attachedRouterRef attachedRouterRef inventory
attachedRouterRefs attachedRouterRefs inventory
routeEntries routeEntries inventory

获取路由器实时路由表（GetVRouterRouteTable）

管理员可以使用GetVRouterRouteTable获取路由器实时路由表。例如：
GetVRouterRouteTable virtualRouterVmUuid=698c538be5414ac7b04b19f4daa29f74

参数（Parameters）

名字 描述 可选的 可选的参数值 起始支持版本
virtualRouterVmUuid 路由器设备uuid 2.1
userTags 用户标签，请参见 创建用户标签(CreateUserTag)；资源类型是 VirtualRouterVRouterRouteTableRefVO 是 2.1
systemTags 系统标签，请参见 创建系统标签(CreateSystemTag)； 资源类型是 VirtualRouterVRouterRouteTableRefVO 是 2.1
timeout 是

添加路由器路由条目（AddVRouterRouteEntry）

管理员可以使用AddVRouterRouteEntry添加路由器路由条目。例如：
AddVRouterRouteEntry routeTableUuid=315d780fe5ea495394d59db9a2177b19 destination=192.168.19.0/24

参数（Parameters）

名字 描述 可选的 可选的参数值 起始支持版本
description 资源的详细描述 是 2.1
type 类型，允许用户添加“静态路由”、“黑洞路由”两种类型，系统会根据是否填下一条地址自动判断类型 是
  • UserStatic
  • UserBlackhole
 2.1
routeTableUuid 路由器路由表uuid 2.1
destination 目标网络地址，使用网络地址CIDR格式，如果用户填写的不是标准CIDR格式，系统会自动转换 2.1
target 下一条地址，为一个路由器设备目前可以直接到达的IP地址，如果不可以直接到达，将会进行递归路由 是 2.1
distance 路由优先级，在最小匹配下如果有多条路由规则匹配，优先级数字小的规则将会被匹配 2.1
resourceUuid 资源uuid 是 2.1
userTags 用户标签，请参见 创建用户标签(CreateUserTag)；资源类型是 VirtualRouterVRouterRouteTableRefVO 是 2.1
systemTags 系统标签，请参见 创建系统标签(CreateSystemTag)； 资源类型是 VirtualRouterVRouterRouteTableRefVO 是 2.1
timeout 是

删除路由器路由条目（DeleteVRouterRouteEntry）

管理员可以使用DeleteVRouterRouteEntry删除路由器路由条目。例如：
DeleteVRouterRouteEntry uuid=92b15177f2a84ec39c962613e926c247 \
routeTableUuid=315d780fe5ea495394d59db9a2177b19

参数（Parameters）

名字 描述 可选的 可选的参数值 起始支持版本
uuid 路由器路由条目uuid 2.1
routeTableUuid 路由器路由表uuid 2.1
deleteMode 请参见 删除资源(Delete Resources) 是
  • Permissive
  • Enforcing
 2.1
userTags 用户标签，请参见 创建用户标签(CreateUserTag)；资源类型是 VirtualRouterVRouterRouteTableRefVO 是 2.1
systemTags 系统标签，请参见 创建系统标签(CreateSystemTag)； 资源类型是VirtualRouterVRouterRouteTableRefVO 是 2.1
timeout 是

查询路由器路由条目（QueryVRouterRouteEntry）

管理员可以使用QueryVRouterRouteEntry查询路由器路由条目。例如：
QueryVRouterRouteEntry uuid=3a9783d1da514c7983c56040bf6b04f2
QueryVRouterRouteEntry vrouterRouteTable.uuid=a15ee6c9eba744308f5c32b6f93069fb

原生域查询（Primitive Fields of Query）

请参见 vrouter route entry inventory

嵌套和扩展域查询（Nested and Expanded Fields of Query）

域（Field） 清单（Inventory） 描述 起始支持版本
vrouterRouteTable vrouterRouteTable inventory 路由条目所在的路由器路由表 2.1

绑定路由表到路由器设备（AttachVRouterRouteTableToVRouter）

管理员可以使用AttachVRouterRouteTableToVRouter绑定路由表到路由器设备。例如：
AttachVRouterRouteTableToVRouter virtualRouterVmUuid=698c538be5414ac7b04b19f4daa29f74 \
routeTableUuid=315d780fe5ea495394d59db9a2177b19

参数（Parameters）

名字 描述 可选的 可选的参数值 起始支持版本
routeTableUuid 路由表uuid 2.1
virtualRouterVmUuid 路由器设备uuid 2.1
userTags 用户标签，请参见 创建用户标签(CreateUserTag)；资源类型是 VirtualRouterVRouterRouteTableRefVO 是 2.1
systemTags 系统标签，请参见 创建系统标签(CreateSystemTag)； 资源类型是 VirtualRouterVRouterRouteTableRefVO 是 2.1
timeout 是

解绑路由器路由表（DetachVRouterRouteTableFromVRouter）

管理员可以使用DetachVRouterRouteTableFromVRouter解绑路由器路由表。例如：
DetachVRouterRouteTableFromVRouter virtualRouterVmUuid=698c538be5414ac7b04b19f4daa29f74 \
routeTableUuid=315d780fe5ea495394d59db9a2177b19

参数（Parameters）

名字 描述 可选的 可选的参数值 起始支持版本
routeTableUuid 路由器路由表uuid 2.1
virtualRouterVmUuid 路由器设备uuid 2.1
userTags 用户标签，请参见 创建用户标签(CreateUserTag)；资源类型是 VirtualRouterVRouterRouteTableRefVO 是 2.1
systemTags 系统标签，请参见 创建系统标签(CreateSystemTag)； 资源类型是 VirtualRouterVRouterRouteTableRefVO 是 2.1
timeout 是

查询绑定关系（QueryVirtualRouterVRouterRouteTableRef）

管理员可以使用QueryVirtualRouterVRouterRouteTableRef查询绑定关系。例如：
QueryVirtualRouterVRouterRouteTableRef routeTableUuid=a15ee6c9eba744308f5c32b6f93069fb
QueryVirtualRouterVRouterRouteTableRef vrouterRouteTable.uuid=a15ee6c9eba744308f5c32b6f93069fb

原生域查询（Primitive Fields of Query）

请参见virtual router vrouter route table ref inventory

嵌套和扩展域查询（Nested and Expanded Fields of Query）

域（Field） 清单（Inventory） 描述 起始支持版本
vrouterRouteTable vrouterRouteTable inventory 2.1
virtualRouterVm virtualRouterVm inventory 2.1

标签（Tags）

系统标签（System Tags）

命令并行度（Parallel Command Level）

管理员可以限制在一个路由器云主机上并行执行命令的最大数量。
标签 描述 示例 起始支持版本
commandsParallelismDegree::{parallelismDegree} 在一个路由器云主机上并行执行命令的最大数量 commandsParallelismDegree::100 0.6
这个标签既可以在路由器规格上创建，也可以在路由器云主机上创建； 如果是在路由器规格上创建的，从这个路由器规格创建的所有路由器云主机都将继承这个标签。
  • 对于路由器规格请使用resourceType=InstanceOfferingVO创建标签。
  • 对于路由器云主机请使用resourceType=VmInstanceVO创建标签。

客户L3网络（Guest L3 Network）

管理员可以将路由器规格绑定到一个客户L3网络，以指定在该客户L3网络上创建路由器云主机的时候使用哪一个路由器规格。
标签 描述 示例 起始支持版本
guestL3Network::{guestL3NetworkUuid} 客户L3网络的uuid guestL3Network::dd56c5c209a74b669b3fe6115a611d57 0.6
例如：
CreateSystemTag resourceType=InstanceOfferingVO resourceUuid=YOUR_VR_OFFERING_UUID \
tag=guestL3Network::YOUR_L3_NETWORK_UUID
上一篇三层网络下一篇VPC
CLI命令使用手册 | 4.8.38 | ZStack Cloud · ZCF | ZStack 资源中心