Apache CloudStack 4.20.0.0 Root Admin API Reference

listStaticRoutes

Lists all static routes

Request parameters

Parameter NameDescriptionRequired
accountlist resources by account. Must be used with the domainId parameter.false
domainidlist only resources belonging to the domain specifiedfalse
gatewayidlist static routes by gateway idfalse
idlist static route by idfalse
isrecursivedefaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.false
keywordList by keywordfalse
listallIf set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.false
pagefalse
pagesizefalse
projectidlist objects by project; if projectid=-1 lists All VMsfalse
statelist static routes by statefalse
tagsList resources by tags (key/value pairs)false
vpcidlist static routes by vpc idfalse

Response Tags

Response NameDescription
idthe ID of static route
accountthe account associated with the static route
cidrstatic route CIDR
domainthe domain associated with the static route
domainidthe ID of the domain associated with the static route
domainpaththe domain path associated with the static route
gatewayidVPC gateway the route is created for
projectthe project name of the static route
projectidthe project id of the static route
statethe state of the static route
vpcidVPC the static route belongs to
tags(*)the list of resource tags associated with static route
accountthe account associated with the tag
customercustomer associated with the tag
domainthe domain associated with the tag
domainidthe ID of the domain associated with the tag
domainpathpath of the Domain associated with the tag
keytag key name
projectthe project name where tag belongs to
projectidthe project id the tag belongs to
resourceidid of the resource
resourcetyperesource type
valuetag value