find routingPolicyRule
GET/projects/:projectId/zones/:zoneName/routingpolicies/:routingPolicyId/rules
find routingPolicyRule
Request
Path Parameters
Project Identifier
Zone name
Responses
- 200
- 400
- 401
- 403
- 404
- 405
- 500
- 503
Ok
- application/json
- Schema
- Example (from schema)
Schema
Array [
Array [
]
Array [
]
Array [
]
Array [
]
]
hRef to the Routing Policy rule details.
Name of the routing policy rule. Must be unique within routing policy.
Description of the routing policy rule.
Possible values: <= 10
List of Community Tags to match.
Match only if all Community Tags are present.
matchExtCommunityVpns
object[]
Possible values: <= 99
List of VPN whose extended communities must be matched.
VPN name. This attribute can not be updated.
Possible values: [any-to-any
, client
, server
]
VN role in the VPN.
Match only if all extended communities are present.
Possible values: [bgpaas
, bgp-bb
, direct
, static-interface-route
, static-network-route
], <= 9
List of protocols to match.
Possible values: <= 10
List of subnets to match (exact match only)
Possible values: <= 10
List of subnets to match (exact match or longer subnets)
Possible values: <= 10
Subnet to match list (longer subnets only)
Possible values: <= 10
List of Community Tags to set on the routes (this will replace the original list of Community Tags on the routes). NB: some Community Tags are protected and could be rejected.
Possible values: <= 10
List of Community Tags to add on the routes. NB: some Community Tags are protected and could be rejected.
Possible values: <= 10
List of Community Tags to remove from the routes (does not apply to the Community Tags added by the same rule).
setExtCommunityVpns
object[]
Possible values: <= 99
List of VPN whose extended communities must be set on the routes.
VPN name. This attribute can not be updated.
Possible values: [any-to-any
, client
, server
]
VN role in the VPN.
addExtCommunityVpns
object[]
Possible values: <= 99
List of VPN whose extended communities must be added to the routes.
VPN name. This attribute can not be updated.
Possible values: [any-to-any
, client
, server
]
VN role in the VPN.
removeExtCommunityVpns
object[]
Possible values: <= 99
List of VPN whose extended communities must be removed from the routes list.
VPN name. This attribute can not be updated.
Possible values: [any-to-any
, client
, server
]
VN role in the VPN.
Possible values: <= 99
List of Autonomous Systems (2 or 4 bytes) to add at the beginning of the Autonomous System path list (AS append).
Possible values: <= 100000
Local preference to set.
Possible values: <= 100000
MED to set
Possible values: [reject
, next
, accept
]
Action on the flow
[
{
"hRef": "string",
"name": "string",
"description": "string",
"matchCommunityTags": [
"string"
],
"matchAllCommunityTags": true,
"matchExtCommunityVpns": [
{
"vpnName": "string",
"vnRole": "any-to-any"
}
],
"matchAllExtCommunityVpns": true,
"matchProtocols": [
"bgpaas"
],
"matchExactSubnetIps": [
"string"
],
"matchOrlongerSubnetIps": [
"0"
],
"matchLongerSubnetIps": [
"string"
],
"setCommunityTags": [
"string"
],
"addCommunityTags": [
"string"
],
"removeCommunityTags": [
"string"
],
"setExtCommunityVpns": [
{
"vpnName": "string",
"vnRole": "any-to-any"
}
],
"addExtCommunityVpns": [
{
"vpnName": "string",
"vnRole": "any-to-any"
}
],
"removeExtCommunityVpns": [
{
"vpnName": "string",
"vnRole": "any-to-any"
}
],
"expandAutonomousSystems": [
"string"
],
"setLocalPreference": 0,
"setMed": 0,
"action": "reject"
}
]
Bad Request
Request is not valid
- application/json
- Schema
- Example (from schema)
Schema
An integer coding the error type. This is given to caller so he can translate them if required.
A short localized string that describes the error.
(optional) A long localized error description if needed. It can contain precise information about which parameter is missing, or what are the identifier acceptable values.
{
"code": 0,
"message": "string",
"description": "string"
}
Unauthorized
Credentials are missing
- application/json
- Schema
- Example (from schema)
Schema
An integer coding the error type. This is given to caller so he can translate them if required.
A short localized string that describes the error.
(optional) A long localized error description if needed. It can contain precise information about which parameter is missing, or what are the identifier acceptable values.
{
"code": 0,
"message": "string",
"description": "string"
}
Forbidden
Valid credentials but not enough privileges to perform the operation
- application/json
- Schema
- Example (from schema)
Schema
An integer coding the error type. This is given to caller so he can translate them if required.
A short localized string that describes the error.
(optional) A long localized error description if needed. It can contain precise information about which parameter is missing, or what are the identifier acceptable values.
{
"code": 0,
"message": "string",
"description": "string"
}
Not Found
Unknown resource or service
- application/json
- Schema
- Example (from schema)
Schema
An integer coding the error type. This is given to caller so he can translate them if required.
A short localized string that describes the error.
(optional) A long localized error description if needed. It can contain precise information about which parameter is missing, or what are the identifier acceptable values.
{
"code": 0,
"message": "string",
"description": "string"
}
Method Not Allowed
Operation is not valid according to the state of the resource
- application/json
- Schema
- Example (from schema)
Schema
An integer coding the error type. This is given to caller so he can translate them if required.
A short localized string that describes the error.
(optional) A long localized error description if needed. It can contain precise information about which parameter is missing, or what are the identifier acceptable values.
{
"code": 0,
"message": "string",
"description": "string"
}
Internal Server Error
Unexpected error, please contact support
- application/json
- Schema
- Example (from schema)
Schema
An integer coding the error type. This is given to caller so he can translate them if required.
A short localized string that describes the error.
(optional) A long localized error description if needed. It can contain precise information about which parameter is missing, or what are the identifier acceptable values.
{
"code": 0,
"message": "string",
"description": "string"
}
Service Unavailable
Service probably in maintenance. Please retry later.
- application/json
- Schema
- Example (from schema)
Schema
An integer coding the error type. This is given to caller so he can translate them if required.
A short localized string that describes the error.
(optional) A long localized error description if needed. It can contain precise information about which parameter is missing, or what are the identifier acceptable values.
{
"code": 0,
"message": "string",
"description": "string"
}