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

策略路由

概述

通过配置一组策略路由规则集，将目标端口-源端口、目标IP地址-源IP地址进行匹配，并配置路由表和路由条目，将用户业务数据流量按指定路由路径发送到目标地址。

清单

策略路由规则集清单(PolicyRouteRuleSet Inventory)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 请参见 资源属性 3.6.0
name 请参见 资源属性 3.6.0
description 请参见 资源属性 是 3.6.0
rules 策略路由集规则 3.6.0
groupBy 以字段分组，相当于MySQL中的group by关键字。例如groupBy=type 是 3.6.0
createDate 请参见 资源属性 3.6.0
lastOpDate 请参见 资源属性 3.6.0
userTags 用户标签，请参见 创建用户标签(CreateUserTag) 是 3.6.0
systemTags 系统标签，请参见 创建系统标签(CreateSystemTag) 是 3.6.0
示例
{
  "inventories": [
    {
      "name": "name",
      "description": "example-des",
      "rules": [
        {
          "uuid": "2e05ab3c36323487baea2414005817ee",
          "ruleNumber": 1.0,
          "ruleSetUuid": "4c86543d473f3127885b3ffc8be5ec88",
          "tableUuid": "d2ad1f7ad9aa354e8da24829bbd31a05",
          "destIp": "192.168.1.1",
          "sourceIp": "10.0.0.1",
          "destPort": "22",
          "sourcePort": "80",
          "protocol": "tcp",
          "state": "enable"
        }
      ]
    }
  ]
}

策略路由规则集网络关联清单(PolicyRouteRuleSetL3Ref Inventory)

名字 描述 可选的 可选的参数值 起始支持版本
id 3.6.0
l3NetworkUuid 三层网络UUID 3.6.0
ruleSetUuid 策略路由规则集uuid 3.6.0
groupBy 以字段分组，相当于MySQL中的group by关键字。例如groupBy=type 是 3.6.0
createDate 请参见 资源属性 3.6.0
lastOpDate 请参见 资源属性 3.6.0
userTags 用户标签，请参见 创建用户标签(CreateUserTag) 是 3.6.0
systemTags 系统标签，请参见 创建系统标签(CreateSystemTag) 是 3.6.0
示例
{
  "inventories": [
    {
      "id": 1.0,
      "l3NetworkUuid": "764cba1766563fd683ef1fcf76c7295c",
      "ruleSetUuid": "ddb87b28f0253810b753fc9ae62ebd31"
    }
  ]
}

策略路由规则集与单节点路由器关联清单(PolicyRouteRuleSetVRouterRef Inventory)

名字 描述 可选的 可选的参数值 起始支持版本
id 3.6.0
vRouterUuid 路由器uuid 3.6.0
ruleSetUuid 策略路由规则集uuid 3.6.0
groupBy 以字段分组，相当于MySQL中的group by关键字。例如groupBy=type 是 3.6.0
createDate 请参见 资源属性 3.6.0
lastOpDate 请参见 资源属性 3.6.0
userTags 用户标签，请参见 创建用户标签(CreateUserTag) 是 3.6.0
systemTags 系统标签，请参见 创建系统标签(CreateSystemTag) 是 3.6.0
示例
{
  "inventories": [
    {
      "id": 1.0,
      "vRouterUuid": "8715faa19cb03995a864330766fdc77c",
      "ruleSetUuid": "2e27f9015ad3357996546fd51c2d808e"
    }
  ]
}

策略路由表清单(PolicyRouteTable Inventory)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 请参见 资源属性 3.6.0
tableNumber 表名 3.6.0
routes 规则 3.6.0
groupBy 以字段分组，相当于MySQL中的group by关键字。例如groupBy=type 是 3.6.0
createDate 请参见 资源属性 3.6.0
lastOpDate 请参见 资源属性 3.6.0
userTags 用户标签，请参见 创建用户标签(CreateUserTag) 是 3.6.0
systemTags 系统标签，请参见 创建系统标签(CreateSystemTag) 是 3.6.0
示例
{
  "inventories": [
    {
      "uuid": "6e39025e9eb432fda488f19e7104fdf0",
      "tableNumber": 1.0,
      "description": "example-des",
      "routes": [
        {
          "tableUuid": "90f075232c383565ac3dbc09554c4152",
          "destinationCidr": "192.168.1.0/24",
          "nextHopIp": "192.168.1.1",
          "distance": 1.0
        }
      ]
    }
  ]
}

策略路由表与单节点路由器关联清单(PolicyRouteTableVRouterRef Inventory)

名字 描述 可选的 可选的参数值 起始支持版本
id 3.6.0
tableUuid 策略路由表uuid 3.6.0
vRouterUuid 路由器uuid 3.6.0
groupBy 以字段分组，相当于MySQL中的group by关键字。例如groupBy=type 是 3.6.0
createDate 请参见 资源属性 3.6.0
lastOpDate 请参见 资源属性 3.6.0
userTags 用户标签，请参见 创建用户标签(CreateUserTag) 是 3.6.0
systemTags 系统标签，请参见 创建系统标签(CreateSystemTag) 是 3.6.0
示例
{
  "inventories": [
    {
      "id": 1.0,
      "tableUuid": "cc3bb710f9d43cedb044213253363604",
      "vRouterUuid": "f281299552813438acc3c5a400802a78"
    }
  ]
}

策略路由清单(PolicyRouteTableRouteEntry Inventory)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 请参见 资源属性 3.6.0
tableUuid 策略路由表uuid 3.6.0
destinationCidr 目标cidr 3.6.0
nextHopIp 下一跳ip 3.6.0
distance 优先级 3.6.0
groupBy 以字段分组，相当于MySQL中的group by关键字。例如groupBy=type 是 3.6.0
createDate 请参见 资源属性 3.6.0
lastOpDate 请参见 资源属性 3.6.0
userTags 用户标签，请参见 创建用户标签(CreateUserTag) 是 3.6.0
systemTags 系统标签，请参见 创建系统标签(CreateSystemTag) 是 3.6.0
示例
{
  "inventories": [
    {
      "tableUuid": "49bf5678360b38058ab7096715e219f4",
      "destinationCidr": "192.168.1.0/24",
      "nextHopIp": "192.168.1.1",
      "distance": 1.0
    }
  ]
}

策略路由规则清单(PolicyRouteRule Inventory)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 请参见 资源属性 3.6.0
ruleNumber 优先级 3.6.0
ruleSetUuid 策略路由规则集uuid 3.6.0
tableUuid 策略路由表uuid 3.6.0
destIp 目标ip 3.6.0
sourceIp 源ip 3.6.0
destPort 目标端口 3.6.0
sourcePort 源端口 3.6.0
groupBy 以字段分组，相当于MySQL中的group by关键字。例如groupBy=type 是 3.6.0
createDate 请参见 资源属性 3.6.0
lastOpDate 请参见 资源属性 3.6.0
userTags 用户标签，请参见 创建用户标签(CreateUserTag) 是 3.6.0
systemTags 系统标签，请参见 创建系统标签(CreateSystemTag) 是 3.6.0
示例
{
  "inventories": [
    {
      "uuid": "538840755c1a36e0b79f1d04097b252e",
      "ruleNumber": 1.0,
      "ruleSetUuid": "7cb413c84b243290a7105e8c21f42b59",
      "tableUuid": "d29940b692f33c0eaf96b0193029636c",
      "destIp": "192.168.1.1",
      "sourceIp": "80",
      "destPort": "22",
      "protocol": "tcp",
      "state": "enable"
    }
  ]
}

操作（Operations）

创建策略路由规则集(CreatePolicyRouteRuleSet)

用户可以使用CreatePolicyRouteRuleSet创建策略路由规则集。 例如：
CreatePolicyRouteRuleSet name=name vRouterUuid=74cc4fed46f633f2a618b0e06d122377

参数（Parameters）

名字 描述 可选的 可选的参数值 起始支持版本
name 资源名称 3.6.0
description 资源的详细描述 是 3.6.0
vRouterUuid 路由器uuid 3.6.0
type 是
  • User
  • EgressWhereComeFrom
 3.9.0
resourceUuid 是 3.6.0
tagUuids 标签UUID列表 是 3.6.0
userTags 用户标签，请参见 创建用户标签(CreateUserTag) 是 3.6.0
systemTags 系统标签，请参见 创建系统标签(CreateSystemTag) 是 3.6.0
timeout 是

删除策略路由规则集(DeletePolicyRouteRuleSet)

用户可以使用DeletePolicyRouteRuleSet删除策略路由规则集。 例如：
DeletePolicyRouteRuleSet uuid=f430004bc0ed315c89eb7909a48d27e7

参数（Parameters）

名字 描述 可选的 可选的参数值 起始支持版本
uuid 资源的UUID，唯一标示该资源 3.6.0
deleteMode 删除模式 是 3.6.0
userTags 用户标签，请参见 创建用户标签(CreateUserTag) 是 3.6.0
systemTags 系统标签，请参见 创建系统标签(CreateSystemTag) 是 3.6.0
timeout 是

更新策略路由规则集属性(UpdatePolicyRouteRuleSet)

用户可以使用UpdatePolicyRouteRuleSet更新策略路由规则集属性。 例如：
UpdatePolicyRouteRuleSet uuid=e58212f4cd0c3f2f96d27dde19de1383 name=name1

参数（Parameters）

名字 描述 可选的 可选的参数值 起始支持版本
uuid 资源的UUID，唯一标示该资源 3.6.0
name 资源名称 是 3.6.0
description 资源的详细描述 是 3.6.0
userTags 用户标签，请参见 创建用户标签(CreateUserTag) 是 3.6.0
systemTags 系统标签，请参见 创建系统标签(CreateSystemTag) 是 3.6.0
timeout 是

查询策略路由规则集(QueryPolicyRouteRuleSet)

管理员可以使用QueryPolicyRouteRuleSet查询策略路由规则集。例如：
QueryPolicyRouteRuleSet

原生域查询（Primitive Fields of Query）

请参见策略路由规则集清单(PolicyRouteRuleSet Inventory)。

查询策略路由规则集网络关联(QueryPolicyRouteRuleSetL3Ref)

管理员可以使用QueryPolicyRouteRuleSetL3Ref查询策略路由规则集网络关联。例如：
QueryPolicyRouteRuleSetL3Ref

原生域查询（Primitive Fields of Query）

请参见策略路由规则集网络关联清单(PolicyRouteRuleSetL3Ref Inventory)。

查询策略路由规则集与单节点路由器关联(QueryPolicyRouteRuleSetVRouterRef)

管理员可以使用QueryPolicyRouteRuleSetVRouterRef查询策略路由规则集与单节点路由器关联。例如：
QueryPolicyRouteRuleSetVRouterRef

原生域查询（Primitive Fields of Query）

请参见策略路由规则集与单节点路由器关联清单(PolicyRouteRuleSetVRouterRef Inventory)。

创建策略路由规则集规则(CreatePolicyRouteRule)

用户可以使用CreatePolicyRouteRule创建策略路由规则集规则。 例如：
CreatePolicyRouteRule ruleSetUuid=ec2472bf205931318e02a2bb5356c0ee tableUuid=b4c03beba98c3502ac53d784dd9bfe61 ruleNumber=1001.0

参数（Parameters）

名字 描述 可选的 可选的参数值 起始支持版本
ruleSetUuid 策略路由规则集uuid 3.6.0
tableUuid 策略路由表uuid 3.6.0
ruleNumber 规则优先级 3.6.0
destIp 目标ip 是 3.6.0
sourceIp 源ip 是 3.6.0
destPort 目标端口 是 3.6.0
sourcePort 源端口 是 3.6.0
protocol 协议 是 3.6.0
resourceUuid 是 3.6.0
tagUuids 标签UUID列表 是 3.6.0
userTags 用户标签，请参见 创建用户标签(CreateUserTag) 是 3.6.0
systemTags 系统标签，请参见 创建系统标签(CreateSystemTag) 是 3.6.0
timeout 是

删除策略路由规则集规则(DeletePolicyRouteRule)

用户可以使用DeletePolicyRouteRule删除策略路由规则集规则。 例如：
DeletePolicyRouteRule uuid=b02689c3b5513b8db2bb5f45a8c7b169

参数（Parameters）

名字 描述 可选的 可选的参数值 起始支持版本
uuid 资源的UUID，唯一标示该资源 3.6.0
deleteMode 是 3.6.0
userTags 用户标签，请参见 创建用户标签(CreateUserTag) 是 3.6.0
systemTags 系统标签，请参见 创建系统标签(CreateSystemTag) 是 3.6.0
timeout 是

创建策略路由表(CreatePolicyRouteTable)

用户可以使用CreatePolicyRouteTable创建策略路由表。 例如：
CreatePolicyRouteTable vRouterUuid=efe77450940f3dfe9023f2589fdeda25 number=1.0

参数（Parameters）

名字 描述 可选的 可选的参数值 起始支持版本
vRouterUuid 路由器uuid 3.6.0
number 表名 3.6.0
description 资源的详细描述 是 3.6.0
resourceUuid 是 3.6.0
tagUuids 标签UUID列表 是 3.6.0
userTags 用户标签，请参见 创建用户标签(CreateUserTag) 是 3.6.0
systemTags 系统标签，请参见 创建系统标签(CreateSystemTag) 是 3.6.0
timeout 是

删除策略路由表(DeletePolicyRouteTable)

用户可以使用DeletePolicyRouteTable删除策略路由表。 例如：
DeletePolicyRouteTable uuid=4c24bf6b15d3338ab1d66eac97eec58b

参数（Parameters）

名字 描述 可选的 可选的参数值 起始支持版本
uuid 资源的UUID，唯一标示该资源 3.6.0
deleteMode 是 3.6.0
userTags 用户标签，请参见 创建用户标签(CreateUserTag) 是 3.6.0
systemTags 系统标签，请参见 创建系统标签(CreateSystemTag) 是 3.6.0
timeout 是

查询策略路由表(QueryPolicyRouteTable)

管理员可以使用QueryPolicyRouteTable查询策略路由表。例如：
QueryPolicyRouteTable

原生域查询（Primitive Fields of Query）

请参见 策略路由表清单(PolicyRouteTable Inventory)。

查询策略路由表与单节点路由器关联(QueryPolicyRouteTableVRouterRef)

管理员可以使用QueryPolicyRouteTableVRouterRef查询策略路由表与单节点路由器关联。例如：
QueryPolicyRouteTableVRouterRef

原生域查询（Primitive Fields of Query）

请参见 策略路由表与单节点路由器关联清单(PolicyRouteTableVRouterRef Inventory)。

创建策略路由(CreatePolicyRouteTableRouteEntry)

用户可以使用CreatePolicyRouteTableRouteEntry创建策略路由。 例如：
CreatePolicyRouteTableRouteEntry tableUuid=ef44a453884a3b93867d6ec0b7dd5716 destinationCidr=192.168.1.0/24 nextHopIp=192.168.1.1

参数（Parameters）

名字 描述 可选的 可选的参数值 起始支持版本
tableUuid 策略路由表uuid 3.6.0
destinationCidr 目标ip cidr 3.6.0
nextHopIp 下一跳ip 3.6.0
distance 优先级 是 3.6.0
resourceUuid 是 3.6.0
tagUuids 标签UUID列表 是 3.6.0
userTags 用户标签，请参见 创建用户标签(CreateUserTag) 是 3.6.0
systemTags 系统标签，请参见 创建系统标签(CreateSystemTag) 是 3.6.0
timeout 是

删除策略路由(DeletePolicyRouteTableRouteEntry)

用户可以使用DeletePolicyRouteTableRouteEntry删除策略路由。 例如：
DeletePolicyRouteTableRouteEntry uuid=7e28a7059fb33a8bb2d7c61b7951303e

参数（Parameters）

名字 描述 可选的 可选的参数值 起始支持版本
uuid 资源的UUID，唯一标示该资源 3.6.0
deleteMode 3.6.0
userTags 用户标签，请参见 创建用户标签(CreateUserTag) 是 3.6.0
systemTags 系统标签，请参见 创建系统标签(CreateSystemTag) 是 3.6.0
timeout 是

查询策略路由(QueryPolicyRouteTableRouteEntry)

管理员可以使用QueryPolicyRouteTableRouteEntry查询策略路由。例如：
QueryPolicyRouteTableRouteEntry

原生域查询（Primitive Fields of Query）

请参见策略路由清单(PolicyRouteTableRouteEntry Inventory)。

查询策略路由规则(QueryPolicyRouteRule)

管理员可以使用QueryPolicyRouteRule查询策略路由规则。例如：
QueryPolicyRouteRule

原生域查询（Primitive Fields of Query）

请参见策略路由规则清单(PolicyRouteRule Inventory)。

网络加载策略路由规则集(AttachPolicyRouteRuleSetToL3)

用户可以使用AttachPolicyRouteRuleSetToL3对网络加载策略路由规则集。 例如：
AttachPolicyRouteRuleSetToL3 l3Uuid=1e6eb259093e3fa2a30c837ae69d259c ruleSetUuid=8748b8be922938bbb430ed9cbe3e4e46

参数（Parameters）

名字 描述 可选的 可选的参数值 起始支持版本
l3Uuid 三层网络uuid 3.6.0
ruleSetUuid 策略路由规则集uuid 3.6.0
userTags 用户标签，请参见 创建用户标签(CreateUserTag) 是 3.6.0
systemTags 系统标签，请参见 创建系统标签(CreateSystemTag) 是 3.6.0
timeout 是

网络解绑策略路由(DetachPolicyRouteRuleSetFromL3)

用户可以使用DetachPolicyRouteRuleSetFromL3对网络解绑策略路由。 例如：
DetachPolicyRouteRuleSetFromL3 l3Uuid=1e6eb259093e3fa2a30c837ae69d259c ruleSetUuid=8748b8be922938bbb430ed9cbe3e4e46

参数（Parameters）

名字 描述 可选的 可选的参数值 起始支持版本
l3Uuid 三层网络uuid 3.6.0
ruleSetUuid 策略规则集uuid 3.6.0
userTags 用户标签，请参见 创建用户标签(CreateUserTag) 是 3.6.0
systemTags 系统标签，请参见 创建系统标签(CreateSystemTag) 是 3.6.0
timeout 是

获取虚拟路由器的策略路由集合(GetPolicyRouteRuleSetFromVirtualRouter)

用户可以使用GetPolicyRouteRuleSetFromVirtualRouter获取虚拟路由器的策略路由集合。 例如：
GetPolicyRouteRuleSetFromVirtualRouter vmInstanceUuid=de191bb7f4763ce580fd7e2ed457cde8

参数（Parameters）

名字 描述 可选的 可选的参数值 起始支持版本
vmInstanceUuid 云主机UUID 3.9.0
userTags 用户标签，请参见 创建用户标签(CreateUserTag) 是 3.9.0
systemTags 系统标签，请参见 创建系统标签(CreateSystemTag) 是 3.9.0
timeout 是

标签（Tags）

  • 用户可以使用resourceType=PolicyRouteRuleSetVO创建策略路由规则集用户标签。 例如：
    CreateUserTag resourceType=PolicyRouteRuleSetVO tag=golden-ResourceStack
resourceUuid=74cc4fed46f633f2a618b0e06d122377
  • 用户可以使用resourceType=PolicyRouteRuleVO创建策略路由规则集规则用户标签。 例如：
    CreateUserTag resourceType=PolicyRouteRuleVO tag=golden-ResourceStack
resourceUuid=ec2472bf205931318e02a2bb5356c0ee
  • 用户可以使用resourceType=PolicyRouteTableRouteEntryVO创建策略路由用户标签。 例如：
    CreateUserTag resourceType=PolicyRouteTableRouteEntryVO tag=golden-ResourceStack
resourceUuid=f44a453884a3b93867d6ec0b7dd5716
上一篇组播路由下一篇网络服务
CLI命令使用手册 | 5.4.12 | ZStack Cloud · ZCF | ZStack 资源中心