Apache CloudStack 4.0.0-incubating Root Admin API Reference
listPrivateGateways
List private gateways
Request parameters
Parameter Name | Description | Required |
account | List resources by account. Must be used with the domainId parameter. | false |
domainid | list only resources belonging to the domain specified | false |
id | list private gateway by id | false |
ipaddress | list gateways by ip address | false |
isrecursive | defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. | false |
keyword | List by keyword | false |
listall | If 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 | false |
page | false | |
pagesize | false | |
projectid | list objects by project | false |
state | list gateways by state | false |
vlan | list gateways by vlan | false |
vpcid | list gateways by vpc | false |
Response Tags
Response Name | Description |
id | the id of the private gateway |
account | the account associated with the private gateway |
domain | the domain associated with the private gateway |
domainid | the ID of the domain associated with the private gateway |
gateway | the gateway |
ipaddress | the private gateway's ip address |
netmask | the private gateway's netmask |
physicalnetworkid | the physical network id |
project | the project name of the private gateway |
projectid | the project id of the private gateway |
state | State of the gateway, can be Creating, Ready, Deleting |
vlan | the vlan of the private gateway |
vpcid | VPC the private gateaway belongs to |
zoneid | zone id of the private gateway |
zonename | the name of the zone the private gateway belongs to |