In-Reply-To: <2584744b3895405fa98bef3e158d33b5@git.apache.org> References: <2584744b3895405fa98bef3e158d33b5@git.apache.org> X-Mailer: ASF-Git Admin Mailer Subject: [41/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/listProjectInvitations.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.0.0/domain_admin/listProjectInvitations.html b/source/api/apidocs-4.0.0/domain_admin/listProjectInvitations.html new file mode 100644 index 0000000..639d2bc --- /dev/null +++ b/source/api/apidocs-4.0.0/domain_admin/listProjectInvitations.html @@ -0,0 +1,127 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

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

listProjectInvitations

Lists projects and provides detailed information for listed projects

+ +

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

+ +

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

+ +

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

listProjects

Lists projects and provides detailed information for listed projects

+ +

Request parameters

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

Parameter Name	Description	Required
account	List resources by account. Must be used with the domainId parameter.	false
displaytext	list projects by display text	false
domainid	list only resources belonging to the domain specified	false
id	list projects by project 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 projects by name	false
page		false
pagesize		false
state	list projects by state	false
tags	List projects by tags (key/value pairs)	false

Response Tags

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

Response Name	Description
id	the id of the project
account	the account name of the project's owner
displaytext	the displaytext of the project
domain	the domain name where the project belongs to
domainid	the domain id the project belongs to
name	the name of the project
state	the state of the 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/5c2e0541/source/api/apidocs-4.0.0/domain_admin/listPublicIpAddresses.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.0.0/domain_admin/listPublicIpAddresses.html b/source/api/apidocs-4.0.0/domain_admin/listPublicIpAddresses.html new file mode 100644 index 0000000..df2be84 --- /dev/null +++ b/source/api/apidocs-4.0.0/domain_admin/listPublicIpAddresses.html @@ -0,0 +1,250 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

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

listPublicIpAddresses

Lists all public ip addresses

+ +

Request parameters

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

Parameter Name	Description	Required
account	List resources by account. Must be used with the domainId parameter.	false
allocatedonly	limits search results to allocated public IP addresses	false
associatednetworkid	lists all public IP addresses associated to the network specified	false
domainid	list only resources belonging to the domain specified	false
forloadbalancing	list only ips used for load balancing	false
forvirtualnetwork	the virtual network for the IP address	false
id	lists ip address by id	false
ipaddress	lists the specified IP address	false
isrecursive	defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.	false
issourcenat	list only source nat ip addresses	false
isstaticnat	list only static nat ip addresses	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	lists all public IP addresses by physical network id	false
projectid	list objects by project	false
tags	List resources by tags (key/value pairs)	false
vlanid	lists all public IP addresses by VLAN ID	false
vpcid	List ips belonging to the VPC	false
zoneid	lists all public IP addresses by Zone ID	false

Response Tags

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

Response Name	Description
id	public IP address id
account	the account the public IP address is associated with
allocated	date the public IP address was acquired
associatednetworkid	the ID of the Network associated with the IP address
associatednetworkname	the name of the Network associated with the IP address
domain	the domain the public IP address is associated with
domainid	the domain ID the public IP address is associated with
forvirtualnetwork	the virtual network for the IP address
ipaddress	public IP address
issourcenat	true if the IP address is a source nat address, false otherwise
isstaticnat	true if this ip is for static nat, false otherwise
issystem	true if this ip is system ip (was allocated as a part of deployVm or createLbRule)
networkid	the ID of the Network where ip belongs to
physicalnetworkid	the physical network this belongs to
project	the project name of the address
projectid	the project id of the ipaddress
purpose	purpose of the IP address. In Acton this value is not null for Ips with isSystem=true, and can have either StaticNat or LB value
state	State of the ip address. Can be: Allocatin, Allocated and Releasing
virtualmachinedisplayname	virutal machine display name the ip address is assigned to (not null only for static nat Ip)
virtualmachineid	virutal machine id the ip address is assigned to (not null only for static nat Ip)
virtualmachinename	virutal machine name the ip address is assigned to (not null only for static nat Ip)
vlanid	the ID of the VLAN associated with the IP address
vlanname	the VLAN associated with the IP address
vpcid	VPC the ip belongs to
zoneid	the ID of the zone the public IP address belongs to
zonename	the name of the zone the public IP address belongs to
*tags()**	the list of resource tags associated with ip address
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/listRemoteAccessVpns.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.0.0/domain_admin/listRemoteAccessVpns.html b/source/api/apidocs-4.0.0/domain_admin/listRemoteAccessVpns.html new file mode 100644 index 0000000..e616ee8 --- /dev/null +++ b/source/api/apidocs-4.0.0/domain_admin/listRemoteAccessVpns.html @@ -0,0 +1,127 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

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

listRemoteAccessVpns

Lists remote access vpns

+ +

Request parameters

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

Parameter Name	Description	Required
publicipid	public ip address id of the vpn server	true
account	List resources by account. Must be used with the domainId parameter.	false
domainid	list only resources belonging to the domain specified	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

Response Tags

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

Response Name	Description
account	the account of the remote access vpn
domain	the domain name of the account of the remote access vpn
domainid	the domain id of the account of the remote access vpn
iprange	the range of ips to allocate to the clients
presharedkey	the ipsec preshared key
project	the project name of the vpn
projectid	the project id of the vpn
publicip	the public ip address of the vpn server
publicipid	the public ip address of the vpn server
state	the state of the rule

+ +

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

+ +

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

listResourceLimits

Lists resource limits.

+ +

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 resource limits 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 objects by project	false
resourcetype	Type of resource to update. Values are 0, 1, 2, 3, and 4. 0 - Instance. Number of instances a user can create. 1 - IP. Number of public IP addresses a user can own. 2 - Volume. Number of disk volumes a user can create.3 - Snapshot. Number of snapshots a user can create.4 - Template. Number of templates that a user can register/create.	false

Response Tags

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

Response Name	Description
account	the account of the resource limit
domain	the domain name of the resource limit
domainid	the domain ID of the resource limit
max	the maximum number of the resource. A -1 means the resource currently has no limit.
project	the project name of the resource limit
projectid	the project id of the resource limit
resourcetype	resource type. Values include 0, 1, 2, 3, 4. See the resourceType parameter for more information on these values.

+ +

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

+ +

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

listRouters

List routers.

+ +

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
forvpc	if true is passed for this parameter, list only VPC routers	false
hostid	the host ID of the router	false
id	the ID of the disk router	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	the name of the router	false
networkid	list by network id	false
page		false
pagesize		false
podid	the Pod ID of the router	false
projectid	list objects by project	false
state	the state of the router	false
vpcid	List networks by VPC	false
zoneid	the Zone ID of the router	false

Response Tags

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

Response Name	Description
id	the id of the router
account	the account associated with the router
created	the date and time the router was created
dns1	the first DNS for the router
dns2	the second DNS for the router
domain	the domain associated with the router
domainid	the domain ID associated with the router
gateway	the gateway for the router
guestipaddress	the guest IP address for the router
guestmacaddress	the guest MAC address for the router
guestnetmask	the guest netmask for the router
guestnetworkid	the ID of the corresponding guest network
hostid	the host ID for the router
hostname	the hostname for the router
isredundantrouter	if this router is an redundant virtual router
linklocalip	the link local IP address for the router
linklocalmacaddress	the link local MAC address for the router
linklocalnetmask	the link local netmask for the router
linklocalnetworkid	the ID of the corresponding link local network
name	the name of the router
networkdomain	the network domain for the router
podid	the Pod ID for the router
project	the project name of the address
projectid	the project id of the ipaddress
publicip	the public IP address for the router
publicmacaddress	the public MAC address for the router
publicnetmask	the public netmask for the router
publicnetworkid	the ID of the corresponding public network
redundantstate	the state of redundant virtual router
scriptsversion	the version of scripts
serviceofferingid	the ID of the service offering of the virtual machine
serviceofferingname	the name of the service offering of the virtual machine
state	the state of the router
templateid	the template ID for the router
templateversion	the version of template
vpcid	VPC the network belongs to
zoneid	the Zone ID for the router
zonename	the Zone name for the router
*nic()**	the list of nics associated with the router
id	the ID of the nic
broadcasturi	the broadcast uri of the nic
gateway	the gateway of the nic
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
traffictype	the traffic type of the nic
type	the type of the nic

+ +

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

+ +

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

listSSHKeyPairs

List registered keypairs

+ +

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
fingerprint	A public key fingerprint to look for	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	A key pair name to look for	false
page		false
pagesize		false
projectid	list objects by project	false

Response Tags

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

Response Name	Description
fingerprint	Fingerprint of the public key
name	Name of the keypair
privatekey	Private key

+ +

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

+ +

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

listSecurityGroups

Lists security 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 the security group by the id provided	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
securitygroupname	lists security groups by name	false
tags	List resources by tags (key/value pairs)	false
virtualmachineid	lists security groups by virtual machine id	false

Response Tags

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

Response Name	Description
id	the ID of the security group
account	the account owning the security group
description	the description of the security group
domain	the domain name of the security group
domainid	the domain ID of the security group
name	the name of the security group
project	the project name of the group
projectid	the project id of the group
*egressrule()**	the list of egress rules associated with the security group
account	account owning the security group rule
cidr	the CIDR notation for the base IP address of the security group rule
endport	the ending IP of the security group rule
icmpcode	the code for the ICMP message response
icmptype	the type of the ICMP message response
protocol	the protocol of the security group rule
ruleid	the id of the security group rule
securitygroupname	security group name
startport	the starting IP of the security group rule
*ingressrule()**	the list of ingress rules associated with the security group
account	account owning the security group rule
cidr	the CIDR notation for the base IP address of the security group rule
endport	the ending IP of the security group rule
icmpcode	the code for the ICMP message response
icmptype	the type of the ICMP message response
protocol	the protocol of the security group rule
ruleid	the id of the security group rule
securitygroupname	security group name
startport	the starting IP of the security group 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
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/listServiceOfferings.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.0.0/domain_admin/listServiceOfferings.html b/source/api/apidocs-4.0.0/domain_admin/listServiceOfferings.html new file mode 100644 index 0000000..b5f7ac1 --- /dev/null +++ b/source/api/apidocs-4.0.0/domain_admin/listServiceOfferings.html @@ -0,0 +1,151 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

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

listServiceOfferings

Lists all available service offerings.

+ +

Request parameters

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

Parameter Name	Description	Required
domainid	the ID of the domain associated with the service offering	false
id	ID of the service offering	false
issystem	is this a system vm offering	false
keyword	List by keyword	false
name	name of the service offering	false
page		false
pagesize		false
systemvmtype	the system VM type. Possible types are "consoleproxy", "secondarystoragevm" or "domainrouter".	false
virtualmachineid	the ID of the virtual machine. Pass this in if you want to see the available service offering that a virtual machine can be changed to.	false

Response Tags

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

Response Name	Description
id	the id of the service offering
cpunumber	the number of CPU
cpuspeed	the clock rate CPU speed in Mhz
created	the date this service offering was created
defaultuse	is this a default system vm offering
displaytext	an alternate display text of the service offering.
domain	Domain name for the offering
domainid	the domain id of the service offering
hosttags	the host tag for the service offering
issystem	is this a system vm offering
limitcpuuse	restrict the CPU usage to committed service offering
memory	the memory in MB
name	the name of the service offering
networkrate	data transfer rate in megabits per second allowed.
offerha	the ha support in the service offering
storagetype	the storage type for this service offering
systemvmtype	is this a the systemvm type for system vm offering
tags	the tags for the service offering

+ +

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

+ +

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

listSnapshotPolicies

Lists snapshot policies.

+ +

Request parameters

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

Parameter Name	Description	Required
volumeid	the ID of the disk volume	true
keyword	List by keyword	false
page		false
pagesize		false

Response Tags

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

Response Name	Description
id	the ID of the snapshot policy
intervaltype	the interval type of the snapshot policy
maxsnaps	maximum number of snapshots retained
schedule	time the snapshot is scheduled to be taken.
timezone	the time zone of the snapshot policy
volumeid	the ID of the disk volume

+ +

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

+ +

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

listSnapshots

Lists all available snapshots for the account.

+ +

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 snapshot by snapshot ID	false
intervaltype	valid values are HOURLY, DAILY, WEEKLY, and MONTHLY.	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	lists snapshot by snapshot name	false
page		false
pagesize		false
projectid	list objects by project	false
snapshottype	valid values are MANUAL or RECURRING.	false
tags	List resources by tags (key/value pairs)	false
volumeid	the ID of the disk volume	false

Response Tags

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

Response Name	Description
id	ID of the snapshot
account	the account associated with the snapshot
created	the date the snapshot was created
domain	the domain name of the snapshot's account
domainid	the domain ID of the snapshot's account
intervaltype	valid types are hourly, daily, weekly, monthy, template, and none.
name	name of the snapshot
project	the project name of the snapshot
projectid	the project id of the snapshot
snapshottype	the type of the snapshot
state	the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage
volumeid	ID of the disk volume
volumename	name of the disk volume
volumetype	type of the disk volume
*tags()**	the list of resource tags associated with snapshot
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

+ +