In-Reply-To: <5283adb4534947b2863df23d6ce4b93d@git.apache.org> References: <5283adb4534947b2863df23d6ce4b93d@git.apache.org> X-Mailer: ASF-Git Admin Mailer Subject: [38/53] [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/getUploadParamsForVolume.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.7/domain_admin/getUploadParamsForVolume.html b/content/api/apidocs-4.7/domain_admin/getUploadParamsForVolume.html new file mode 100644 index 0000000..a772801 --- /dev/null +++ b/content/api/apidocs-4.7/domain_admin/getUploadParamsForVolume.html @@ -0,0 +1,112 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

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

getUploadParamsForVolume

Upload a data disk to the cloudstack cloud.

+ +

Request parameters

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

Parameter Name	Description	Required
format	the format for the volume/template. Possible values include QCOW2, OVA, and VHD.	true
name	the name of the volume/template	true
zoneid	the ID of the zone the volume/template is to be hosted on	true
account	an optional accountName. Must be used with domainId.	false
checksum	the MD5 checksum value of this volume/template	false
diskofferingid	the ID of the disk offering. This must be a custom sized offering since during upload of volume/template size is unknown.	false
domainid	an optional domainId. If the account parameter is used, domainId must also be used.	false
imagestoreuuid	Image store uuid	false
projectid	Upload volume/template for the project	false

Response Tags

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

Response Name	Description
id	the template/volume ID
expires	the timestamp after which the signature expires
metadata	encrypted data to be sent in the POST request.
postURL	POST url to upload the file to
signature	signature to be sent in the POST request.

+ +

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

+ +

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

getVMPassword

Returns an encrypted password for the VM

+ +

Request parameters

+ + + + + + + +

Parameter Name	Description	Required
id	The ID of the virtual machine	true

Response Tags

+ + + + + + + +

Response Name	Description
encryptedpassword	The base64 encoded encrypted password of the VM

+ +

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

+ +

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

getVirtualMachineUserData

Returns user data associated with the VM

+ +

Request parameters

+ + + + + + + +

Parameter Name	Description	Required
virtualmachineid	The ID of the virtual machine	true

Response Tags

+ + + + + + + + + + +

Response Name	Description
userdata	Base 64 encoded VM user data
virtualmachineid	the ID of the virtual machine

+ +

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

+ +

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

issueNuageVspResourceRequest

Issues a Nuage VSP REST API resource request

+ +

Request parameters

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

Parameter Name	Description	Required
method	the Nuage VSP REST API method type	true
networkofferingid	the network offering id	true
resource	the resource in Nuage VSP	true
zoneid	the Zone ID for the network	true
childresource	the child resource in Nuage VSP	false
physicalnetworkid	the ID of the physical network in to which Nuage VSP Controller is added	false
resourcefilter	the resource filter in Nuage VSP	false
resourceid	the ID of the resource in Nuage VSP	false

Response Tags

+ + + + + + + +

Response Name	Description
resourceinfo	the details of the Nuage VSP resource

+ +

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

+ +

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

listAccounts

Lists accounts and provides detailed account information for listed accounts

+ +

Request parameters

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

Parameter Name	Description	Required
accounttype	list accounts by account type. Valid account types are 1 (admin), 2 (domain-admin), and 0 (user).	false
domainid	list only resources belonging to the domain specified	false
id	list account by account ID	false
iscleanuprequired	list accounts by cleanuprequired attribute (values are true or false)	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 account by account name	false
page		false
pagesize		false
state	list accounts by state. Valid states are enabled, disabled, and locked.	false

Response Tags

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

Response Name	Description
id	the id of the account
accountdetails	details for the account
accounttype	account type (admin, domain-admin, user)
cpuavailable	the total number of cpu cores available to be created for this account
cpulimit	the total number of cpu cores the account can own
cputotal	the total number of cpu cores owned by account
defaultzoneid	the default zone of the account
domain	name of the Domain the account belongs too
domainid	id of the Domain the account belongs too
groups	the list of acl groups that account belongs to
ipavailable	the total number of public ip addresses available for this account to acquire
iplimit	the total number of public ip addresses this account can acquire
iptotal	the total number of public ip addresses allocated for this account
iscleanuprequired	true if the account requires cleanup
isdefault	true if account is default, false otherwise
memoryavailable	the total memory (in MB) available to be created for this account
memorylimit	the total memory (in MB) the account can own
memorytotal	the total memory (in MB) owned by account
name	the name of the account
networkavailable	the total number of networks available to be created for this account
networkdomain	the network domain
networklimit	the total number of networks the account can own
networktotal	the total number of networks owned by account
primarystorageavailable	the total primary storage space (in GiB) available to be used for this account
primarystoragelimit	the total primary storage space (in GiB) the account can own
primarystoragetotal	the total primary storage space (in GiB) owned by account
projectavailable	the total number of projects available for administration by this account
projectlimit	the total number of projects the account can own
projecttotal	the total number of projects being administrated by this account
receivedbytes	the total number of network traffic bytes received
secondarystorageavailable	the total secondary storage space (in GiB) available to be used for this account
secondarystoragelimit	the total secondary storage space (in GiB) the account can own
secondarystoragetotal	the total secondary storage space (in GiB) owned by account
sentbytes	the total number of network traffic bytes sent
snapshotavailable	the total number of snapshots available for this account
snapshotlimit	the total number of snapshots which can be stored by this account
snapshottotal	the total number of snapshots stored by this account
state	the state of the account
templateavailable	the total number of templates available to be created by this account
templatelimit	the total number of templates which can be created by this account
templatetotal	the total number of templates which have been created by this account
vmavailable	the total number of virtual machines available for this account to acquire
vmlimit	the total number of virtual machines that can be deployed by this account
vmrunning	the total number of virtual machines running for this account
vmstopped	the total number of virtual machines stopped for this account
vmtotal	the total number of virtual machines deployed by this account
volumeavailable	the total volume available for this account
volumelimit	the total volume which can be used by this account
volumetotal	the total volume being used by this account
vpcavailable	the total number of vpcs available to be created for this account
vpclimit	the total number of vpcs the account can own
vpctotal	the total number of vpcs owned by account
*user()**	the list of users associated with account
id	the user ID
account	the account name of the user
accountid	the account ID of the user
accounttype	the account type of the user
apikey	the api key of the user
created	the date and time the user account was created
domain	the domain name of the user
domainid	the domain ID of the user
email	the user email address
firstname	the user firstname
iscallerchilddomain	the boolean value representing if the updating target is in caller's child domain
isdefault	true if user is default, false otherwise
lastname	the user lastname
secretkey	the secret key of the user
state	the user state
timezone	the timezone user was created in
username	the user name

+ +

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

+ +

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

listAffinityGroupTypes

Lists affinity group types available

+ +

Request parameters

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

Parameter Name	Description	Required
keyword	List by keyword	false
page		false
pagesize		false

Response Tags

+ + + + + + + +

Response Name	Description
type	the type of the affinity group

+ +

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

+ +

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

listAffinityGroups

Lists affinity 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 affinity 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
name	lists affinity groups by name	false
page		false
pagesize		false
projectid	list objects by project	false
type	lists affinity groups by type	false
virtualmachineid	lists affinity groups by virtual machine ID	false

Response Tags

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

Response Name	Description
id	the ID of the affinity group
account	the account owning the affinity group
description	the description of the affinity group
domain	the domain name of the affinity group
domainid	the domain ID of the affinity group
name	the name of the affinity group
project	the project name of the affinity group
projectid	the project ID of the affinity group
type	the type of the affinity group
virtualmachineIds	virtual machine IDs associated with this affinity group

+ +

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

+ +

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

listAndSwitchSamlAccount

Lists and switches to other SAML accounts owned by the SAML user

+ +

Request parameters

+ + + + + + + + + + +

Parameter Name	Description	Required
domainid	Domain uuid	false
userid	User uuid	false

Response Tags

+ + + + + + + + + + +

Response Name	Description
displaytext	any text associated with the success or failure
success	true if operation is executed successfully

+ +

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

+ +

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

listApis

lists all available apis on the server, provided by the Api Discovery plugin

+ +

Request parameters

+ + + + + + + +

Parameter Name	Description	Required
name	API name	false

Response Tags

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

Response Name	Description
description	description of the api
isasync	true if api is asynchronous
name	the name of the api command
related	comma separated related apis
since	version of CloudStack the api was introduced in
type	response field type
*params()**	the list params the api accepts
description	description of the api parameter
length	length of the parameter
name	the name of the api parameter
related	comma separated related apis to get the parameter
required	true if this parameter is required for the api request
since	version of CloudStack the api was introduced in
type	parameter type
*response()**	api response fields
description	description of the api response field
name	the name of the api response field
response	api response fields
type	response field type

+ +

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

+ +

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

listAsyncJobs

Lists all pending asynchronous jobs 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
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
startdate	the start date of the async job	false

Response Tags

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

Response Name	Description
accountid	the account that executed the async command
cmd	the async command executed
created	the created date of the job
jobinstanceid	the unique ID of the instance/entity object related to the job
jobinstancetype	the instance/entity object related to the job
jobprocstatus	the progress information of the PENDING job
jobresult	the result reason
jobresultcode	the result code for the job
jobresulttype	the result type
jobstatus	the current job status-should be 0 for PENDING
userid	the user that executed the async command
jobid	the ID of the async job

+ +

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

+ +

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

listAutoScalePolicies

Lists autoscale policies.

+ +

Request parameters

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

Parameter Name	Description	Required
account	list resources by account. Must be used with the domainId parameter.	false
action	the action to be executed if all the conditions evaluate to true for the specified duration.	false
conditionid	the ID of the condition of the policy	false
domainid	list only resources belonging to the domain specified	false
id	the ID of the autoscale policy	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
vmgroupid	the ID of the autoscale vm group	false

Response Tags

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

Response Name	Description
id	the autoscale policy ID
account	the account owning the autoscale policy
action	the action to be executed if all the conditions evaluate to true for the specified duration.
conditions	the list of IDs of the conditions that are being evaluated on every interval
domain	the domain name of the autoscale policy
domainid	the domain ID of the autoscale policy
duration	the duration for which the conditions have to be true before action is taken
project	the project name of the autoscale policy
projectid	the project id autoscale policy
quiettime	the cool down period for which the policy should not be evaluated after the action has been taken

+ +

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

+ +

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

listAutoScaleVmGroups

Lists autoscale 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
fordisplay	list resources by display flag; only ROOT admin is eligible to pass this parameter	false
id	the ID of the autoscale vm group	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
lbruleid	the ID of the loadbalancer	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
policyid	the ID of the policy	false
projectid	list objects by project	false
vmprofileid	the ID of the profile	false
zoneid	the availability zone ID	false

Response Tags

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

Response Name	Description
id	the autoscale vm group ID
account	the account owning the instance group
domain	the domain name of the vm profile
domainid	the domain ID of the vm profile
fordisplay	is group for display to the regular user
interval	the frequency at which the conditions have to be evaluated
lbruleid	the load balancer rule ID
maxmembers	the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.
minmembers	the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.
project	the project name of the vm profile
projectid	the project id vm profile
scaledownpolicies	list of scaledown autoscale policies
scaleuppolicies	list of scaleup autoscale policies
state	the current state of the AutoScale Vm Group
vmprofileid	the autoscale profile that contains information about the vms in the vm group.

+ +

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

+ +

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

listAutoScaleVmProfiles

Lists autoscale vm profiles.

+ +

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	the ID of the autoscale vm profile	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
otherdeployparams	the otherdeployparameters of the autoscale vm profile	false
page		false
pagesize		false
projectid	list objects by project	false
serviceofferingid	list profiles by service offering id	false
templateid	the templateid of the autoscale vm profile	false
zoneid	availability zone for the auto deployed virtual machine	false

Response Tags

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

Response Name	Description
id	the autoscale vm profile ID
account	the account owning the instance group
autoscaleuserid	the ID of the user used to launch and destroy the VMs
destroyvmgraceperiod	the time allowed for existing connections to get closed before a vm is destroyed
domain	the domain name of the vm profile
domainid	the domain ID of the vm profile
fordisplay	is profile for display to the regular user
otherdeployparams	parameters other than zoneId/serviceOfferringId/templateId to be used while deploying a virtual machine
project	the project name of the vm profile
projectid	the project id vm profile
serviceofferingid	the service offering to be used while deploying a virtual machine
templateid	the template to be used while deploying a virtual machine
zoneid	the availability zone to be used while deploying a virtual machine

+ +

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

+ +

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

listCapabilities

Lists capabilities

+ +

Request parameters

+ + + + +

Parameter Name

Description

Required

Response Tags

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

Response Name	Description
allowusercreateprojects	true if regular user is allowed to create projects
allowuserexpungerecovervm	true if the user can recover and expunge virtualmachines, false otherwise
allowuserviewdestroyedvm	true if the user is allowed to view destroyed virtualmachines, false otherwise
apilimitinterval	time interval (in seconds) to reset api count
apilimitmax	Max allowed number of api requests within the specified interval
cloudstackversion	version of the cloud stack
customdiskofferingmaxsize	maximum size that can be specified when create disk from disk offering with custom size
customdiskofferingminsize	minimum size that can be specified when create disk from disk offering with custom size
kvmsnapshotenabled	true if snapshot is supported for KVM host, false otherwise
projectinviterequired	If invitation confirmation is required when add account to project
regionsecondaryenabled	true if region wide secondary is enabled, false otherwise
securitygroupsenabled	true if security groups support is enabled, false otherwise
supportELB	true if region supports elastic load balancer on basic zones
userpublictemplateenabled	true if user and domain admins can set templates to be shared, false otherwise

+ +

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

+ +

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

listConditions

List Conditions for the specific user

+ +

Request parameters

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

Parameter Name	Description	Required
account	list resources by account. Must be used with the domainId parameter.	false
counterid	Counter-id of the condition.	false
domainid	list only resources belonging to the domain specified	false
id	ID of the Condition.	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
policyid	the ID of the policy	false

Response Tags

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

Response Name	Description
id	the id of the Condition
account	the owner of the Condition.
counter	Details of the Counter.
domain	the domain name of the owner.
domainid	the domain id of the Condition owner
project	the project name of the Condition
projectid	the project id of the Condition.
relationaloperator	Relational Operator to be used with threshold.
threshold	Threshold Value for the counter.
zoneid	zone id of counter

+ +