Reply-To: dev@cloudstack.apache.org Delivered-To: mailing list commits@cloudstack.apache.org Received: (qmail 10300 invoked by uid 99); 12 May 2015 07:20:28 -0000 Received: from git1-us-west.apache.org (HELO git1-us-west.apache.org) (140.211.11.23) by apache.org (qpsmtpd/0.29) with ESMTP; Tue, 12 May 2015 07:20:28 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id BC4A5E17DD; Tue, 12 May 2015 07:20:28 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: sebgoa@apache.org To: commits@cloudstack.apache.org Date: Tue, 12 May 2015 07:21:09 -0000 Message-Id: <3e7dec6bd67c449a92635039482ec3da@git.apache.org> In-Reply-To: <2584744b3895405fa98bef3e158d33b5@git.apache.org> References: <2584744b3895405fa98bef3e158d33b5@git.apache.org> X-Mailer: ASF-Git Admin Mailer Subject: [43/51] [partial] cloudstack-www git commit: Adding API html pages http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/5c2e0541/source/api/apidocs-4.0.0/domain_admin/listDiskOfferings.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.0.0/domain_admin/listDiskOfferings.html b/source/api/apidocs-4.0.0/domain_admin/listDiskOfferings.html new file mode 100644 index 0000000..191a728 --- /dev/null +++ b/source/api/apidocs-4.0.0/domain_admin/listDiskOfferings.html @@ -0,0 +1,118 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack 4.0.0-incubating Domain Admin API Reference + +

listDiskOfferings

Lists all available disk offerings.

+ +

Request parameters

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

Parameter Name	Description	Required
domainid	the ID of the domain of the disk offering.	false
id	ID of the disk offering	false
keyword	List by keyword	false
name	name of the disk offering	false
page		false
pagesize		false

Response Tags

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

Response Name	Description
id	unique ID of the disk offering
created	the date this disk offering was created
disksize	the size of the disk offering in GB
displaytext	an alternate display text of the disk offering.
domain	the domain name this disk offering belongs to. Ignore this information as it is not currently applicable.
domainid	the domain ID this disk offering belongs to. Ignore this information as it is not currently applicable.
iscustomized	true if disk offering uses custom size, false otherwise
name	the name of the disk offering
storagetype	the storage type for this disk offering
tags	the tags for the disk offering

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/5c2e0541/source/api/apidocs-4.0.0/domain_admin/listDomainChildren.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.0.0/domain_admin/listDomainChildren.html b/source/api/apidocs-4.0.0/domain_admin/listDomainChildren.html new file mode 100644 index 0000000..00f2db4 --- /dev/null +++ b/source/api/apidocs-4.0.0/domain_admin/listDomainChildren.html @@ -0,0 +1,115 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack 4.0.0-incubating Domain Admin API Reference + +

listDomainChildren

Lists all children domains belonging to a specified domain

+ +

Request parameters

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

Parameter Name	Description	Required
id	list children domain by parent domain ID.	false
isrecursive	to return the entire tree, use the value "true". To return the first level children, use the value "false".	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
name	list children domains by name	false
page		false
pagesize		false

Response Tags

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

Response Name	Description
id	the ID of the domain
haschild	whether the domain has one or more sub-domains
level	the level of the domain
name	the name of the domain
networkdomain	the network domain
parentdomainid	the domain ID of the parent domain
parentdomainname	the domain name of the parent domain
path	the path of the domain

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/5c2e0541/source/api/apidocs-4.0.0/domain_admin/listDomains.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.0.0/domain_admin/listDomains.html b/source/api/apidocs-4.0.0/domain_admin/listDomains.html new file mode 100644 index 0000000..0904d95 --- /dev/null +++ b/source/api/apidocs-4.0.0/domain_admin/listDomains.html @@ -0,0 +1,115 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack 4.0.0-incubating Domain Admin API Reference + +

listDomains

Lists domains and provides detailed information for listed domains

+ +

Request parameters

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

Parameter Name	Description	Required
id	List domain by domain ID.	false
keyword	List by keyword	false
level	List domains by domain level.	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
name	List domain by domain name.	false
page		false
pagesize		false

Response Tags

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

Response Name	Description
id	the ID of the domain
haschild	whether the domain has one or more sub-domains
level	the level of the domain
name	the name of the domain
networkdomain	the network domain
parentdomainid	the domain ID of the parent domain
parentdomainname	the domain name of the parent domain
path	the path of the domain

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/5c2e0541/source/api/apidocs-4.0.0/domain_admin/listEventTypes.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.0.0/domain_admin/listEventTypes.html b/source/api/apidocs-4.0.0/domain_admin/listEventTypes.html new file mode 100644 index 0000000..0610217 --- /dev/null +++ b/source/api/apidocs-4.0.0/domain_admin/listEventTypes.html @@ -0,0 +1,73 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack 4.0.0-incubating Domain Admin API Reference + +

listEventTypes

List Event Types

+ +

Request parameters

+ + + + +

Parameter Name

Description

Required

Response Tags

+ + + + + + + +

Response Name	Description
name	Event Type

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/5c2e0541/source/api/apidocs-4.0.0/domain_admin/listEvents.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.0.0/domain_admin/listEvents.html b/source/api/apidocs-4.0.0/domain_admin/listEvents.html new file mode 100644 index 0000000..a7c2710 --- /dev/null +++ b/source/api/apidocs-4.0.0/domain_admin/listEvents.html @@ -0,0 +1,154 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack 4.0.0-incubating Domain Admin API Reference + +

listEvents

A command to list events.

+ +

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
duration	the duration of the event	false
enddate	the end date range of the list you want to retrieve (use format "yyyy-MM-dd" or the new format "yyyy-MM-dd HH:mm:ss")	false
entrytime	the time the event was entered	false
id	the ID of the event	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
level	the event level (INFO, WARN, ERROR)	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
startdate	the start date range of the list you want to retrieve (use format "yyyy-MM-dd" or the new format "yyyy-MM-dd HH:mm:ss")	false
type	the event type (see event types)	false

Response Tags

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

Response Name	Description
id	the ID of the event
account	the account name for the account that owns the object being acted on in the event (e.g. the owner of the virtual machine, ip address, or security group)
created	the date the event was created
description	a brief description of the event
domain	the name of the account's domain
domainid	the id of the account's domain
level	the event level (INFO, WARN, ERROR)
parentid	whether the event is parented
project	the project name of the address
projectid	the project id of the ipaddress
state	the state of the event
type	the type of the event (see event types)
username	the name of the user who performed the action (can be different from the account if an admin is performing an action for a user, e.g. starting/stopping a user's virtual machine)

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/5c2e0541/source/api/apidocs-4.0.0/domain_admin/listFirewallRules.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.0.0/domain_admin/listFirewallRules.html b/source/api/apidocs-4.0.0/domain_admin/listFirewallRules.html new file mode 100644 index 0000000..ed7af7d --- /dev/null +++ b/source/api/apidocs-4.0.0/domain_admin/listFirewallRules.html @@ -0,0 +1,166 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack 4.0.0-incubating Domain Admin API Reference + +

listFirewallRules

Lists all firewall 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
id	Lists rule with the specified ID.	false
ipaddressid	the id of IP address of the firwall 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
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 firewall rule
cidrlist	the cidr list to forward traffic from
endport	the ending port of firewall rule's port range
icmpcode	error code for this icmp message
icmptype	type of the icmp message being sent
ipaddress	the public ip address for the firewall rule
ipaddressid	the public ip address id for the firewall rule
protocol	the protocol of the firewall rule
startport	the starting port of firewall rule's port range
state	the state of the 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/5c2e0541/source/api/apidocs-4.0.0/domain_admin/listHypervisors.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.0.0/domain_admin/listHypervisors.html b/source/api/apidocs-4.0.0/domain_admin/listHypervisors.html new file mode 100644 index 0000000..fac6f27 --- /dev/null +++ b/source/api/apidocs-4.0.0/domain_admin/listHypervisors.html @@ -0,0 +1,76 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack 4.0.0-incubating Domain Admin API Reference + +

listHypervisors

List hypervisors

+ +

Request parameters

+ + + + + + + +

Parameter Name	Description	Required
zoneid	the zone id for listing hypervisors.	false

Response Tags

+ + + + + + + +

Response Name	Description
name	Hypervisor name

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/5c2e0541/source/api/apidocs-4.0.0/domain_admin/listInstanceGroups.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.0.0/domain_admin/listInstanceGroups.html b/source/api/apidocs-4.0.0/domain_admin/listInstanceGroups.html new file mode 100644 index 0000000..24f4112 --- /dev/null +++ b/source/api/apidocs-4.0.0/domain_admin/listInstanceGroups.html @@ -0,0 +1,124 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack 4.0.0-incubating Domain Admin API Reference + +

listInstanceGroups

Lists vm groups

+ +

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 instance groups 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
name	list instance groups by name	false
page		false
pagesize		false
projectid	list objects by project	false

Response Tags

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

Response Name	Description
id	the id of the instance group
account	the account owning the instance group
created	time and date the instance group was created
domain	the domain name of the instance group
domainid	the domain ID of the instance group
name	the name of the instance group
project	the project name of the group
projectid	the project id of the group

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/5c2e0541/source/api/apidocs-4.0.0/domain_admin/listIpForwardingRules.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.0.0/domain_admin/listIpForwardingRules.html b/source/api/apidocs-4.0.0/domain_admin/listIpForwardingRules.html new file mode 100644 index 0000000..1fe6663 --- /dev/null +++ b/source/api/apidocs-4.0.0/domain_admin/listIpForwardingRules.html @@ -0,0 +1,175 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack 4.0.0-incubating Domain Admin API Reference + +

listIpForwardingRules

List the ip forwarding rules

+ +

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	Lists rule with the specified ID.	false
ipaddressid	list the rule belonging to this public 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
virtualmachineid	Lists all rules applied to the specified Vm.	false

Response Tags

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

Response Name	Description
id	the ID of the port forwarding rule
cidrlist	the cidr list to forward traffic from
ipaddress	the public ip address for the port forwarding rule
ipaddressid	the public ip address id for the port forwarding rule
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
*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/5c2e0541/source/api/apidocs-4.0.0/domain_admin/listIsoPermissions.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.0.0/domain_admin/listIsoPermissions.html b/source/api/apidocs-4.0.0/domain_admin/listIsoPermissions.html new file mode 100644 index 0000000..2875b60 --- /dev/null +++ b/source/api/apidocs-4.0.0/domain_admin/listIsoPermissions.html @@ -0,0 +1,88 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack 4.0.0-incubating Domain Admin API Reference + +

listIsoPermissions

List template visibility and all accounts that have permissions to view this template.

+ +

Request parameters

+ + + + + + + +

Parameter Name	Description	Required
id	the template ID	true

Response Tags

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

Response Name	Description
id	the template ID
account	the list of accounts the template is available for
domainid	the ID of the domain to which the template belongs
ispublic	true if this template is a public template, false otherwise
projectids	the list of projects the template is available for

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/5c2e0541/source/api/apidocs-4.0.0/domain_admin/listIsos.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.0.0/domain_admin/listIsos.html b/source/api/apidocs-4.0.0/domain_admin/listIsos.html new file mode 100644 index 0000000..33ee291 --- /dev/null +++ b/source/api/apidocs-4.0.0/domain_admin/listIsos.html @@ -0,0 +1,259 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack 4.0.0-incubating Domain Admin API Reference + +

listIsos

Lists all available ISO files.

+ +

Request parameters

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

Parameter Name	Description	Required
account	List resources by account. Must be used with the domainId parameter.	false
bootable	true if the ISO is bootable, false otherwise	false
domainid	list only resources belonging to the domain specified	false
hypervisor	the hypervisor for which to restrict the search	false
id	list all isos by id	false
isofilter	possible values are "featured", "self", "self-executable","executable", and "community". * featured-ISOs that are featured and are publicself-ISOs that have been registered/created by the owner. * selfexecutable-ISOs that have been registered/created by the owner that can be used to deploy a new VM. * executable-all ISOs that can be used to deploy a new VM * community-ISOs that are public.	false
ispublic	true if the ISO is publicly available to all users, false otherwise.	false
isready	true if this ISO is ready to be deployed	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
name	list all isos by name	false
page		false
pagesize		false
projectid	list objects by project	false
tags	List resources by tags (key/value pairs)	false
zoneid	the ID of the zone	false

Response Tags

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

Response Name	Description
id	the template ID
account	the account name to which the template belongs
accountid	the account id to which the template belongs
bootable	true if the ISO is bootable, false otherwise
checksum	checksum of the template
created	the date this template was created
crossZones	true if the template is managed across all Zones, false otherwise
details	additional key/value details tied with template
displaytext	the template display text
domain	the name of the domain to which the template belongs
domainid	the ID of the domain to which the template belongs
format	the format of the template.
hostid	the ID of the secondary storage host for the template
hostname	the name of the secondary storage host for the template
hypervisor	the hypervisor on which the template runs
isextractable	true if the template is extractable, false otherwise
isfeatured	true if this template is a featured template, false otherwise
ispublic	true if this template is a public template, false otherwise
isready	true if the template is ready to be deployed from, false otherwise.
name	the template name
ostypeid	the ID of the OS type for this template.
ostypename	the name of the OS type for this template.
passwordenabled	true if the reset password feature is enabled, false otherwise
project	the project name of the template
projectid	the project id of the template
removed	the date this template was removed
size	the size of the template
sourcetemplateid	the template ID of the parent template if present
status	the status of the template
templatetag	the tag of this template
templatetype	the type of the template
zoneid	the ID of the zone for this template
zonename	the name of the zone for this template
*tags()**	the list of resource tags associated with tempate
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
jobid	the ID of the latest async job acting on this object
jobstatus	the current status of the latest async job acting on this object

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/5c2e0541/source/api/apidocs-4.0.0/domain_admin/listLBStickinessPolicies.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.0.0/domain_admin/listLBStickinessPolicies.html b/source/api/apidocs-4.0.0/domain_admin/listLBStickinessPolicies.html new file mode 100644 index 0000000..2607ed7 --- /dev/null +++ b/source/api/apidocs-4.0.0/domain_admin/listLBStickinessPolicies.html @@ -0,0 +1,127 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack 4.0.0-incubating Domain Admin API Reference + +

listLBStickinessPolicies

Lists LBStickiness policies.

+ +

Request parameters

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

Parameter Name	Description	Required
lbruleid	the ID of the load balancer rule	true
keyword	List by keyword	false
page		false
pagesize		false

Response Tags

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

Response Name	Description
account	the account of the Stickiness policy
description	the description of the Stickiness policy
domain	the domain of the Stickiness policy
domainid	the domain ID of the Stickiness policy
lbruleid	the LB rule ID
name	the name of the Stickiness policy
state	the state of the policy
zoneid	the id of the zone the Stickiness policy belongs to
*stickinesspolicy()**	the list of stickinesspolicies
id	the LB Stickiness policy ID
description	the description of the Stickiness policy
methodname	the method name of the Stickiness policy
name	the name of the Stickiness policy
params	the params of the policy
state	the state of the policy

+ +