X-Mailer: ASF-Git Admin Mailer Subject: [35/51] [partial] cloudstack-www git commit: 4.7.0 api http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/3ebf9423/content/api/apidocs-4.7/domain_admin/listNetworkOfferings.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.7/domain_admin/listNetworkOfferings.html b/content/api/apidocs-4.7/domain_admin/listNetworkOfferings.html new file mode 100644 index 0000000..1dbc38d --- /dev/null +++ b/content/api/apidocs-4.7/domain_admin/listNetworkOfferings.html @@ -0,0 +1,235 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack v4.7.0 Domain Admin API Reference + +

listNetworkOfferings

Lists all available network offerings.

+ +

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter Name	Description	Required
availability	the availability of network offering. Default value is required	false
displaytext	list network offerings by display text	false
forvpc	the network offering can be used only for network creation inside the VPC	false
guestiptype	list network offerings by guest type: shared or isolated	false
id	list network offerings by ID	false
isdefault	true if need to list only default network offerings. Default value is false	false
istagged	true if offering has tags specified	false
keyword	List by keyword	false
name	list network offerings by name	false
networkid	the ID of the network. Pass this in if you want to see the available network offering that a network can be changed to.	false
page		false
pagesize		false
sourcenatsupported	true if need to list only netwok offerings where source NAT is supported, false otherwise	false
specifyipranges	true if need to list only network offerings which support specifying ip ranges	false
specifyvlan	the tags for the network offering.	false
state	list network offerings by state	false
supportedservices	list network offerings supporting certain services	false
tags	list network offerings by tags	false
traffictype	list by traffic type	false
zoneid	list network offerings available for network creation in specific zone	false

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Response Name	Description
id	the id of the network offering
availability	availability of the network offering
conservemode	true if network offering is ip conserve mode enabled
created	the date this network offering was created
details	additional key/value details tied with network offering
displaytext	an alternate display text of the network offering.
egressdefaultpolicy	true if guest network default egress policy is allow; false if default egress policy is deny
forvpc	true if network offering can be used by VPC networks only
guestiptype	guest type of the network offering, can be Shared or Isolated
isdefault	true if network offering is default, false otherwise
ispersistent	true if network offering supports persistent networks, false otherwise
maxconnections	maximum number of concurrents connections to be handled by lb
name	the name of the network offering
networkrate	data transfer rate in megabits per second allowed.
serviceofferingid	the ID of the service offering used by virtual router provider
specifyipranges	true if network offering supports specifying ip ranges, false otherwise
specifyvlan	true if network offering supports vlans, false otherwise
state	state of the network offering. Can be Disabled/Enabled/Inactive
supportsstrechedl2subnet	true if network offering supports network that span multiple zones
tags	the tags for the network offering
traffictype	the traffic type for the network offering, supported types are Public, Management, Control, Guest, Vlan or Storage.
*service()**	the list of supported services
name	the service name
*capability()**	the list of capabilities
canchooseservicecapability	can this service capability value can be choosable while creatine network offerings
name	the capability name
value	the capability value
*provider()**	the service provider name
id	uuid of the network provider
canenableindividualservice	true if individual services can be enabled/disabled
destinationphysicalnetworkid	the destination physical network
name	the provider name
physicalnetworkid	the physical network this belongs to
servicelist	services for this provider
state	state of the network provider

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/3ebf9423/content/api/apidocs-4.7/domain_admin/listNetworks.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.7/domain_admin/listNetworks.html b/content/api/apidocs-4.7/domain_admin/listNetworks.html new file mode 100644 index 0000000..8761c60 --- /dev/null +++ b/content/api/apidocs-4.7/domain_admin/listNetworks.html @@ -0,0 +1,352 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack v4.7.0 Domain Admin API Reference + +

listNetworks

Lists all available networks.

+ +

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter Name	Description	Required
account	list resources by account. Must be used with the domainId parameter.	false
acltype	list networks by ACL (access control list) type. Supported values are account and domain	false
canusefordeploy	list networks available for VM deployment	false
displaynetwork	list resources by display flag; only ROOT admin is eligible to pass this parameter	false
domainid	list only resources belonging to the domain specified	false
forvpc	the network belongs to VPC	false
id	list networks by ID	false
isrecursive	defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.	false
issystem	true if network is system, false otherwise	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
physicalnetworkid	list networks by physical network id	false
projectid	list objects by project	false
restartrequired	list networks by restartRequired	false
specifyipranges	true if need to list only networks which support specifying IP ranges	false
supportedservices	list networks supporting certain services	false
tags	List resources by tags (key/value pairs)	false
traffictype	type of the traffic	false
type	the type of the network. Supported values are: isolated and shared	false
vpcid	List networks by VPC	false
zoneid	the zone ID of the network	false

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Response Name	Description
id	the id of the network
account	the owner of the network
aclid	ACL Id associated with the VPC network
acltype	acl type - access type to the network
broadcastdomaintype	Broadcast domain type of the network
broadcasturi	broadcast uri of the network. This parameter is visible to ROOT admins only
canusefordeploy	list networks available for vm deployment
cidr	Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR
displaynetwork	an optional field, whether to the display the network to the end user or not.
displaytext	the displaytext of the network
dns1	the first DNS for the network
dns2	the second DNS for the network
domain	the domain name of the network owner
domainid	the domain id of the network owner
gateway	the network's gateway
ip6cidr	the cidr of IPv6 network
ip6gateway	the gateway of IPv6 network
isdefault	true if network is default, false otherwise
ispersistent	list networks that are persistent
issystem	true if network is system, false otherwise
name	the name of the network
netmask	the network's netmask
networkcidr	the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE
networkdomain	the network domain
networkofferingavailability	availability of the network offering the network is created from
networkofferingconservemode	true if network offering is ip conserve mode enabled
networkofferingdisplaytext	display text of the network offering the network is created from
networkofferingid	network offering id the network is created from
networkofferingname	name of the network offering the network is created from
physicalnetworkid	the physical network id
project	the project name of the address
projectid	the project id of the ipaddress
related	related to what other network configuration
reservediprange	the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes
restartrequired	true network requires restart
specifyipranges	true if network supports specifying ip ranges, false otherwise
state	state of the network
strechedl2subnet	true if network can span multiple zones
subdomainaccess	true if users from subdomains can access the domain level network
traffictype	the traffic type of the network
type	the type of the network
vlan	The vlan of the network. This parameter is visible to ROOT admins only
vpcid	VPC the network belongs to
zoneid	zone id of the network
zonename	the name of the zone the network belongs to
zonesnetworkspans	If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans
*service()**	the list of services
name	the service name
*capability()**	the list of capabilities
canchooseservicecapability	can this service capability value can be choosable while creatine network offerings
name	the capability name
value	the capability value
*provider()**	the service provider name
id	uuid of the network provider
canenableindividualservice	true if individual services can be enabled/disabled
destinationphysicalnetworkid	the destination physical network
name	the provider name
physicalnetworkid	the physical network this belongs to
servicelist	services for this provider
state	state of the network provider
*tags()**	the list of resource tags associated with network
account	the account associated with the tag
customer	customer associated with the tag
domain	the domain associated with the tag
domainid	the ID of the domain associated with the tag
key	tag key name
project	the project name where tag belongs to
projectid	the project id the tag belongs to
resourceid	id of the resource
resourcetype	resource type
value	tag value

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/3ebf9423/content/api/apidocs-4.7/domain_admin/listNics.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.7/domain_admin/listNics.html b/content/api/apidocs-4.7/domain_admin/listNics.html new file mode 100644 index 0000000..3f1b2b0 --- /dev/null +++ b/content/api/apidocs-4.7/domain_admin/listNics.html @@ -0,0 +1,145 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack v4.7.0 Domain Admin API Reference + +

listNics

list the vm nics IP to NIC

+ +

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter Name	Description	Required
virtualmachineid	the ID of the vm	true
fordisplay	list resources by display flag; only ROOT admin is eligible to pass this parameter	false
keyword	List by keyword	false
networkid	list nic of the specific vm's network	false
nicid	the ID of the nic to to list IPs	false
page		false
pagesize		false

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Response Name	Description
id	the ID of the nic
broadcasturi	the broadcast uri of the nic
deviceid	device id for the network when plugged into the virtual machine
gateway	the gateway of the nic
ip6address	the IPv6 address of network
ip6cidr	the cidr of IPv6 network
ip6gateway	the gateway of IPv6 network
ipaddress	the ip address of the nic
isdefault	true if nic is default, false otherwise
isolationuri	the isolation uri of the nic
macaddress	true if nic is default, false otherwise
netmask	the netmask of the nic
networkid	the ID of the corresponding network
networkname	the name of the corresponding network
secondaryip	the Secondary ipv4 addr of nic
traffictype	the traffic type of the nic
type	the type of the nic
virtualmachineid	Id of the vm to which the nic belongs

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/3ebf9423/content/api/apidocs-4.7/domain_admin/listOsCategories.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.7/domain_admin/listOsCategories.html b/content/api/apidocs-4.7/domain_admin/listOsCategories.html new file mode 100644 index 0000000..932a05c --- /dev/null +++ b/content/api/apidocs-4.7/domain_admin/listOsCategories.html @@ -0,0 +1,91 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack v4.7.0 Domain Admin API Reference + +

listOsCategories

Lists all supported OS categories for this cloud.

+ +

Request parameters

+ + + + + + + + + + + + + + + + + + + +

Parameter Name	Description	Required
id	list Os category by id	false
keyword	List by keyword	false
name	list os category by name	false
page		false
pagesize		false

Response Tags

+ + + + + + + + + + +

Response Name	Description
id	the ID of the OS category
name	the name of the OS category

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/3ebf9423/content/api/apidocs-4.7/domain_admin/listOsTypes.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.7/domain_admin/listOsTypes.html b/content/api/apidocs-4.7/domain_admin/listOsTypes.html new file mode 100644 index 0000000..b251390 --- /dev/null +++ b/content/api/apidocs-4.7/domain_admin/listOsTypes.html @@ -0,0 +1,100 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack v4.7.0 Domain Admin API Reference + +

listOsTypes

Lists all supported OS types for this cloud.

+ +

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + +

Parameter Name	Description	Required
description	list os by description	false
id	list by Os type Id	false
keyword	List by keyword	false
oscategoryid	list by Os Category id	false
page		false
pagesize		false

Response Tags

+ + + + + + + + + + + + + + + + +

Response Name	Description
id	the ID of the OS type
description	the name/description of the OS type
isuserdefined	is the guest OS user defined
oscategoryid	the ID of the OS category

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/3ebf9423/content/api/apidocs-4.7/domain_admin/listOvsElements.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.7/domain_admin/listOvsElements.html b/content/api/apidocs-4.7/domain_admin/listOvsElements.html new file mode 100644 index 0000000..c88156b --- /dev/null +++ b/content/api/apidocs-4.7/domain_admin/listOvsElements.html @@ -0,0 +1,112 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack v4.7.0 Domain Admin API Reference + +

listOvsElements

Lists all available ovs elements.

+ +

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + +

Parameter Name	Description	Required
enabled	list network offerings by enabled state	false
id	list ovs elements by id	false
keyword	List by keyword	false
nspid	list ovs elements by network service provider id	false
page		false
pagesize		false

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Response Name	Description
id	the id of the ovs
account	the account associated with the provider
domain	the domain associated with the provider
domainid	the domain ID associated with the provider
enabled	Enabled/Disabled the service provider
nspid	the physical network service provider id of the provider
project	the project name of the address
projectid	the project id of the ipaddress

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/3ebf9423/content/api/apidocs-4.7/domain_admin/listPools.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.7/domain_admin/listPools.html b/content/api/apidocs-4.7/domain_admin/listPools.html new file mode 100644 index 0000000..beec561 --- /dev/null +++ b/content/api/apidocs-4.7/domain_admin/listPools.html @@ -0,0 +1,79 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack v4.7.0 Domain Admin API Reference + +

listPools

List Pool

+ +

Request parameters

+ + + + +

Parameter Name

Description

Required

Response Tags

+ + + + + + + + + + + + + +

Response Name	Description
id	pool id
algorithm	pool algorithm
name	pool name

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/3ebf9423/content/api/apidocs-4.7/domain_admin/listPortForwardingRules.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.7/domain_admin/listPortForwardingRules.html b/content/api/apidocs-4.7/domain_admin/listPortForwardingRules.html new file mode 100644 index 0000000..e3d90b4 --- /dev/null +++ b/content/api/apidocs-4.7/domain_admin/listPortForwardingRules.html @@ -0,0 +1,190 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack v4.7.0 Domain Admin API Reference + +

listPortForwardingRules

Lists all port forwarding rules for an IP address.

+ +

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
fordisplay	list resources by display flag; only ROOT admin is eligible to pass this parameter	false
id	Lists rule with the specified ID.	false
ipaddressid	the ID of IP address of the port forwarding services	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
networkid	list port forwarding rules for certain network	false
page		false
pagesize		false
projectid	list objects by project	false
tags	List resources by tags (key/value pairs)	false

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Response Name	Description
id	the ID of the port forwarding rule
cidrlist	the cidr list to forward traffic from
fordisplay	is firewall for display to the regular user
ipaddress	the public ip address for the port forwarding rule
ipaddressid	the public ip address id for the port forwarding rule
networkid	the id of the guest network the port forwarding rule belongs to
privateendport	the ending port of port forwarding rule's private port range
privateport	the starting port of port forwarding rule's private port range
protocol	the protocol of the port forwarding rule
publicendport	the ending port of port forwarding rule's private port range
publicport	the starting port of port forwarding rule's public port range
state	the state of the rule
virtualmachinedisplayname	the VM display name for the port forwarding rule
virtualmachineid	the VM ID for the port forwarding rule
virtualmachinename	the VM name for the port forwarding rule
vmguestip	the vm ip address for the port forwarding rule
*tags()**	the list of resource tags associated with the rule
account	the account associated with the tag
customer	customer associated with the tag
domain	the domain associated with the tag
domainid	the ID of the domain associated with the tag
key	tag key name
project	the project name where tag belongs to
projectid	the project id the tag belongs to
resourceid	id of the resource
resourcetype	resource type
value	tag value

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/3ebf9423/content/api/apidocs-4.7/domain_admin/listPrivateGateways.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.7/domain_admin/listPrivateGateways.html b/content/api/apidocs-4.7/domain_admin/listPrivateGateways.html new file mode 100644 index 0000000..21d7b45 --- /dev/null +++ b/content/api/apidocs-4.7/domain_admin/listPrivateGateways.html @@ -0,0 +1,160 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack v4.7.0 Domain 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
aclid	ACL Id set for 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
sourcenatsupported	Souce Nat enable status
state	State of the gateway, can be Creating, Ready, Deleting
vlan	the network implementation uri for 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

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/3ebf9423/content/api/apidocs-4.7/domain_admin/listProjectAccounts.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.7/domain_admin/listProjectAccounts.html b/content/api/apidocs-4.7/domain_admin/listProjectAccounts.html new file mode 100644 index 0000000..8ce8c70 --- /dev/null +++ b/content/api/apidocs-4.7/domain_admin/listProjectAccounts.html @@ -0,0 +1,247 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack v4.7.0 Domain Admin API Reference + +

listProjectAccounts

Lists project's accounts

+ +

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + +

Parameter Name	Description	Required
projectid	ID of the project	true
account	list accounts of the project by account name	false
keyword	List by keyword	false
page		false
pagesize		false
role	list accounts of the project by role	false

Response Tags

Response Name	Description
id	the id of the project
account	the account name of the project's owner
cpuavailable	the total number of cpu cores available to be created for this project
cpulimit	the total number of cpu cores the project can own
cputotal	the total number of cpu cores owned by project
displaytext	the displaytext of the project
domain	the domain name where the project belongs to
domainid	the domain id the project belongs to
ipavailable	the total number of public ip addresses available for this project to acquire
iplimit	the total number of public ip addresses this project can acquire
iptotal	the total number of public ip addresses allocated for this project
memoryavailable	the total memory (in MB) available to be created for this project
memorylimit	the total memory (in MB) the project can own
memorytotal	the total memory (in MB) owned by project
name	the name of the project
networkavailable	the total number of networks available to be created for this project
networklimit	the total number of networks the project can own
networktotal	the total number of networks owned by project
primarystorageavailable	the total primary storage space (in GiB) available to be used for this project
primarystoragelimit	the total primary storage space (in GiB) the project can own
primarystoragetotal	the total primary storage space (in GiB) owned by project
secondarystorageavailable	the total secondary storage space (in GiB) available to be used for this project
secondarystoragelimit	the total secondary storage space (in GiB) the project can own
secondarystoragetotal	the total secondary storage space (in GiB) owned by project
snapshotavailable	the total number of snapshots available for this project
snapshotlimit	the total number of snapshots which can be stored by this project
snapshottotal	the total number of snapshots stored by this project
state	the state of the project
templateavailable	the total number of templates available to be created by this project
templatelimit	the total number of templates which can be created by this project
templatetotal	the total number of templates which have been created by this project
vmavailable	the total number of virtual machines available for this project to acquire
vmlimit	the total number of virtual machines that can be deployed by this project
vmrunning	the total number of virtual machines running for this project
vmstopped	the total number of virtual machines stopped for this project
vmtotal	the total number of virtual machines deployed by this project
volumeavailable	the total volume available for this project
volumelimit	the total volume which can be used by this project
volumetotal	the total volume being used by this project
vpcavailable	the total number of vpcs available to be created for this project
vpclimit	the total number of vpcs the project can own
vpctotal	the total number of vpcs owned by project
*tags()**	the list of resource tags associated with vm
account	the account associated with the tag
customer	customer associated with the tag
domain	the domain associated with the tag
domainid	the ID of the domain associated with the tag
key	tag key name
project	the project name where tag belongs to
projectid	the project id the tag belongs to
resourceid	id of the resource
resourcetype	resource type
value	tag value

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/3ebf9423/content/api/apidocs-4.7/domain_admin/listProjectInvitations.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.7/domain_admin/listProjectInvitations.html b/content/api/apidocs-4.7/domain_admin/listProjectInvitations.html new file mode 100644 index 0000000..f6e2816 --- /dev/null +++ b/content/api/apidocs-4.7/domain_admin/listProjectInvitations.html @@ -0,0 +1,127 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack v4.7.0 Domain Admin API Reference + +

listProjectInvitations

Lists project invitations and provides detailed information for listed invitations

+ +

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter Name	Description	Required
account	list resources by account. Must be used with the domainId parameter.	false
activeonly	if true, list only active invitations - having Pending state and ones that are not timed out yet	false
domainid	list only resources belonging to the domain specified	false
id	list invitations by id	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 by project id	false
state	list invitations by state	false

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Response Name	Description
id	the id of the invitation
account	the account name of the project's owner
domain	the domain name where the project belongs to
domainid	the domain id the project belongs to
email	the email the invitation was sent to
project	the name of the project
projectid	the id of the project
state	the invitation state

+ +