Return-Path: X-Original-To: apmail-cloudstack-commits-archive@www.apache.org Delivered-To: apmail-cloudstack-commits-archive@www.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id F204A185F8 for ; Tue, 12 May 2015 07:20:55 +0000 (UTC) Received: (qmail 11390 invoked by uid 500); 12 May 2015 07:20:29 -0000 Delivered-To: apmail-cloudstack-commits-archive@cloudstack.apache.org Received: (qmail 11321 invoked by uid 500); 12 May 2015 07:20:29 -0000 Mailing-List: contact commits-help@cloudstack.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@cloudstack.apache.org Delivered-To: mailing list commits@cloudstack.apache.org Received: (qmail 10363 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 C3274E07EE; 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:10 -0000 Message-Id: <6c5846dd09c94bef8b4d56e2a7588bc5@git.apache.org> In-Reply-To: <2584744b3895405fa98bef3e158d33b5@git.apache.org> References: <2584744b3895405fa98bef3e158d33b5@git.apache.org> X-Mailer: ASF-Git Admin Mailer Subject: [44/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/disableAccount.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.0.0/domain_admin/disableAccount.html b/source/api/apidocs-4.0.0/domain_admin/disableAccount.html new file mode 100644 index 0000000..3e78a2b --- /dev/null +++ b/source/api/apidocs-4.0.0/domain_admin/disableAccount.html @@ -0,0 +1,244 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.0.0-incubating Domain Admin API Reference + +

+

disableAccount

+

Disables an account

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
lockIf true, only lock the account; else disable the accounttrue
accountDisables specified account.false
domainidDisables specified account in this domain.false
idAccount idfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idthe id of the account
accountdetailsdetails for the account
accounttypeaccount type (admin, domain-admin, user)
defaultzoneidthe default zone of the account
domainname of the Domain the account belongs too
domainidid of the Domain the account belongs too
ipavailablethe total number of public ip addresses available for this account to acquire
iplimitthe total number of public ip addresses this account can acquire
iptotalthe total number of public ip addresses allocated for this account
iscleanuprequiredtrue if the account requires cleanup
namethe name of the account
networkavailablethe total number of networks available to be created for this account
networkdomainthe network domain
networklimitthe total number of networks the account can own
networktotalthe total number of networks owned by account
projectavailablethe total number of projects available for administration by this account
projectlimitthe total number of projects the account can own
projecttotalthe total number of projects being administrated by this account
receivedbytesthe total number of network traffic bytes received
sentbytesthe total number of network traffic bytes sent
snapshotavailablethe total number of snapshots available for this account
snapshotlimitthe total number of snapshots which can be stored by this account
snapshottotalthe total number of snapshots stored by this account
statethe state of the account
templateavailablethe total number of templates available to be created by this account
templatelimitthe total number of templates which can be created by this account
templatetotalthe total number of templates which have been created by this account
vmavailablethe total number of virtual machines available for this account to acquire
vmlimitthe total number of virtual machines that can be deployed by this account
vmrunningthe total number of virtual machines running for this account
vmstoppedthe total number of virtual machines stopped for this account
vmtotalthe total number of virtual machines deployed by this account
volumeavailablethe total volume available for this account
volumelimitthe total volume which can be used by this account
volumetotalthe total volume being used by this account
vpcavailablethe total number of vpcs available to be created for this account
vpclimitthe total number of vpcs the account can own
vpctotalthe total number of vpcs owned by account
user(*)the list of users associated with account
idthe user ID
accountthe account name of the user
accountidthe account ID of the user
accounttypethe account type of the user
apikeythe api key of the user
createdthe date and time the user account was created
domainthe domain name of the user
domainidthe domain ID of the user
emailthe user email address
firstnamethe user firstname
lastnamethe user lastname
secretkeythe secret key of the user
statethe user state
timezonethe timezone user was created in
usernamethe user name
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/5c2e0541/source/api/apidocs-4.0.0/domain_admin/disableStaticNat.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.0.0/domain_admin/disableStaticNat.html b/source/api/apidocs-4.0.0/domain_admin/disableStaticNat.html new file mode 100644 index 0000000..b97092f --- /dev/null +++ b/source/api/apidocs-4.0.0/domain_admin/disableStaticNat.html @@ -0,0 +1,79 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.0.0-incubating Domain Admin API Reference + +

+

disableStaticNat

+

Disables static rule for given ip address

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
ipaddressidthe public IP address id for which static nat feature is being disableedtrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextany text associated with the success or failure
successtrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/5c2e0541/source/api/apidocs-4.0.0/domain_admin/disableUser.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.0.0/domain_admin/disableUser.html b/source/api/apidocs-4.0.0/domain_admin/disableUser.html new file mode 100644 index 0000000..bd116ca --- /dev/null +++ b/source/api/apidocs-4.0.0/domain_admin/disableUser.html @@ -0,0 +1,118 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.0.0-incubating Domain Admin API Reference + +

+

disableUser

+

Disables a user account

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idDisables user by user ID.true
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idthe user ID
accountthe account name of the user
accountidthe account ID of the user
accounttypethe account type of the user
apikeythe api key of the user
createdthe date and time the user account was created
domainthe domain name of the user
domainidthe domain ID of the user
emailthe user email address
firstnamethe user firstname
lastnamethe user lastname
secretkeythe secret key of the user
statethe user state
timezonethe timezone user was created in
usernamethe user name
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/5c2e0541/source/api/apidocs-4.0.0/domain_admin/disassociateIpAddress.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.0.0/domain_admin/disassociateIpAddress.html b/source/api/apidocs-4.0.0/domain_admin/disassociateIpAddress.html new file mode 100644 index 0000000..e38f46d --- /dev/null +++ b/source/api/apidocs-4.0.0/domain_admin/disassociateIpAddress.html @@ -0,0 +1,79 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.0.0-incubating Domain Admin API Reference + +

+

disassociateIpAddress

+

Disassociates an ip address from the account.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idthe id of the public ip address to disassociatetrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextany text associated with the success or failure
successtrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/5c2e0541/source/api/apidocs-4.0.0/domain_admin/enableAccount.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.0.0/domain_admin/enableAccount.html b/source/api/apidocs-4.0.0/domain_admin/enableAccount.html new file mode 100644 index 0000000..1d778a6 --- /dev/null +++ b/source/api/apidocs-4.0.0/domain_admin/enableAccount.html @@ -0,0 +1,241 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.0.0-incubating Domain Admin API Reference + +

+

enableAccount

+

Enables an account

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accountEnables specified account.false
domainidEnables specified account in this domain.false
idAccount idfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idthe id of the account
accountdetailsdetails for the account
accounttypeaccount type (admin, domain-admin, user)
defaultzoneidthe default zone of the account
domainname of the Domain the account belongs too
domainidid of the Domain the account belongs too
ipavailablethe total number of public ip addresses available for this account to acquire
iplimitthe total number of public ip addresses this account can acquire
iptotalthe total number of public ip addresses allocated for this account
iscleanuprequiredtrue if the account requires cleanup
namethe name of the account
networkavailablethe total number of networks available to be created for this account
networkdomainthe network domain
networklimitthe total number of networks the account can own
networktotalthe total number of networks owned by account
projectavailablethe total number of projects available for administration by this account
projectlimitthe total number of projects the account can own
projecttotalthe total number of projects being administrated by this account
receivedbytesthe total number of network traffic bytes received
sentbytesthe total number of network traffic bytes sent
snapshotavailablethe total number of snapshots available for this account
snapshotlimitthe total number of snapshots which can be stored by this account
snapshottotalthe total number of snapshots stored by this account
statethe state of the account
templateavailablethe total number of templates available to be created by this account
templatelimitthe total number of templates which can be created by this account
templatetotalthe total number of templates which have been created by this account
vmavailablethe total number of virtual machines available for this account to acquire
vmlimitthe total number of virtual machines that can be deployed by this account
vmrunningthe total number of virtual machines running for this account
vmstoppedthe total number of virtual machines stopped for this account
vmtotalthe total number of virtual machines deployed by this account
volumeavailablethe total volume available for this account
volumelimitthe total volume which can be used by this account
volumetotalthe total volume being used by this account
vpcavailablethe total number of vpcs available to be created for this account
vpclimitthe total number of vpcs the account can own
vpctotalthe total number of vpcs owned by account
user(*)the list of users associated with account
idthe user ID
accountthe account name of the user
accountidthe account ID of the user
accounttypethe account type of the user
apikeythe api key of the user
createdthe date and time the user account was created
domainthe domain name of the user
domainidthe domain ID of the user
emailthe user email address
firstnamethe user firstname
lastnamethe user lastname
secretkeythe secret key of the user
statethe user state
timezonethe timezone user was created in
usernamethe user name
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/5c2e0541/source/api/apidocs-4.0.0/domain_admin/enableStaticNat.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.0.0/domain_admin/enableStaticNat.html b/source/api/apidocs-4.0.0/domain_admin/enableStaticNat.html new file mode 100644 index 0000000..526d195 --- /dev/null +++ b/source/api/apidocs-4.0.0/domain_admin/enableStaticNat.html @@ -0,0 +1,85 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.0.0-incubating Domain Admin API Reference + +

+

enableStaticNat

+

Enables static nat for given ip address

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
ipaddressidthe public IP address id for which static nat feature is being enabledtrue
virtualmachineidthe ID of the virtual machine for enabling static nat featuretrue
networkidThe network of the vm the static nat will be enabled for. Required when public Ip address is not associated with any Guest network yet (VPC case)false
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextany text associated with the success or failure
successtrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/5c2e0541/source/api/apidocs-4.0.0/domain_admin/enableUser.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.0.0/domain_admin/enableUser.html b/source/api/apidocs-4.0.0/domain_admin/enableUser.html new file mode 100644 index 0000000..7908946 --- /dev/null +++ b/source/api/apidocs-4.0.0/domain_admin/enableUser.html @@ -0,0 +1,118 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.0.0-incubating Domain Admin API Reference + +

+

enableUser

+

Enables a user account

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idEnables user by user ID.true
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idthe user ID
accountthe account name of the user
accountidthe account ID of the user
accounttypethe account type of the user
apikeythe api key of the user
createdthe date and time the user account was created
domainthe domain name of the user
domainidthe domain ID of the user
emailthe user email address
firstnamethe user firstname
lastnamethe user lastname
secretkeythe secret key of the user
statethe user state
timezonethe timezone user was created in
usernamethe user name
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/5c2e0541/source/api/apidocs-4.0.0/domain_admin/extractIso.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.0.0/domain_admin/extractIso.html b/source/api/apidocs-4.0.0/domain_admin/extractIso.html new file mode 100644 index 0000000..ef227d8 --- /dev/null +++ b/source/api/apidocs-4.0.0/domain_admin/extractIso.html @@ -0,0 +1,121 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.0.0-incubating Domain Admin API Reference + +

+

extractIso

+

Extracts an ISO

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idthe ID of the ISO filetrue
modethe mode of extraction - HTTP_DOWNLOAD or FTP_UPLOADtrue
urlthe url to which the ISO would be extractedfalse
zoneidthe ID of the zone where the ISO is originally locatedfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idthe id of extracted object
accountidthe account id to which the extracted object belongs
createdthe time and date the object was created
extractIdthe upload id of extracted object
extractModethe mode of extraction - upload or download
namethe name of the extracted object
statethe state of the extracted object
statusthe status of the extraction
storagetypetype of the storage
uploadpercentagethe percentage of the entity uploaded to the specified location
urlif mode = upload then url of the uploaded entity. if mode = download the url from which the entity can be downloaded
zoneidzone ID the object was extracted from
zonenamezone name the object was extracted from
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/5c2e0541/source/api/apidocs-4.0.0/domain_admin/extractTemplate.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.0.0/domain_admin/extractTemplate.html b/source/api/apidocs-4.0.0/domain_admin/extractTemplate.html new file mode 100644 index 0000000..85c8d72 --- /dev/null +++ b/source/api/apidocs-4.0.0/domain_admin/extractTemplate.html @@ -0,0 +1,121 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.0.0-incubating Domain Admin API Reference + +

+

extractTemplate

+

Extracts a template

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idthe ID of the templatetrue
modethe mode of extraction - HTTP_DOWNLOAD or FTP_UPLOADtrue
urlthe url to which the ISO would be extractedfalse
zoneidthe ID of the zone where the ISO is originally locatedfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idthe id of extracted object
accountidthe account id to which the extracted object belongs
createdthe time and date the object was created
extractIdthe upload id of extracted object
extractModethe mode of extraction - upload or download
namethe name of the extracted object
statethe state of the extracted object
statusthe status of the extraction
storagetypetype of the storage
uploadpercentagethe percentage of the entity uploaded to the specified location
urlif mode = upload then url of the uploaded entity. if mode = download the url from which the entity can be downloaded
zoneidzone ID the object was extracted from
zonenamezone name the object was extracted from
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/5c2e0541/source/api/apidocs-4.0.0/domain_admin/extractVolume.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.0.0/domain_admin/extractVolume.html b/source/api/apidocs-4.0.0/domain_admin/extractVolume.html new file mode 100644 index 0000000..6b2fe9b --- /dev/null +++ b/source/api/apidocs-4.0.0/domain_admin/extractVolume.html @@ -0,0 +1,121 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.0.0-incubating Domain Admin API Reference + +

+

extractVolume

+

Extracts volume

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idthe ID of the volumetrue
modethe mode of extraction - HTTP_DOWNLOAD or FTP_UPLOADtrue
zoneidthe ID of the zone where the volume is locatedtrue
urlthe url to which the volume would be extractedfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idthe id of extracted object
accountidthe account id to which the extracted object belongs
createdthe time and date the object was created
extractIdthe upload id of extracted object
extractModethe mode of extraction - upload or download
namethe name of the extracted object
statethe state of the extracted object
statusthe status of the extraction
storagetypetype of the storage
uploadpercentagethe percentage of the entity uploaded to the specified location
urlif mode = upload then url of the uploaded entity. if mode = download the url from which the entity can be downloaded
zoneidzone ID the object was extracted from
zonenamezone name the object was extracted from
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/5c2e0541/source/api/apidocs-4.0.0/domain_admin/getCloudIdentifier.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.0.0/domain_admin/getCloudIdentifier.html b/source/api/apidocs-4.0.0/domain_admin/getCloudIdentifier.html new file mode 100644 index 0000000..42a40e8 --- /dev/null +++ b/source/api/apidocs-4.0.0/domain_admin/getCloudIdentifier.html @@ -0,0 +1,82 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.0.0-incubating Domain Admin API Reference + +

+

getCloudIdentifier

+

Retrieves a cloud identifier.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
useridthe user ID for the cloud identifiertrue
+
+
+

Response Tags

+ + + + + + + + + + + + + +
Response NameDescription
cloudidentifierthe cloud identifier
signaturethe signed response for the cloud identifier
useridthe user ID for the cloud identifier
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/5c2e0541/source/api/apidocs-4.0.0/domain_admin/getVMPassword.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.0.0/domain_admin/getVMPassword.html b/source/api/apidocs-4.0.0/domain_admin/getVMPassword.html new file mode 100644 index 0000000..0e04738 --- /dev/null +++ b/source/api/apidocs-4.0.0/domain_admin/getVMPassword.html @@ -0,0 +1,76 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.0.0-incubating Domain Admin API Reference + +

+

getVMPassword

+

Returns an encrypted password for the VM

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the virtual machinetrue
+
+
+

Response Tags

+ + + + + + + +
Response NameDescription
encryptedpasswordThe encrypted password of the VM
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/5c2e0541/source/api/apidocs-4.0.0/domain_admin/listAccounts.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.0.0/domain_admin/listAccounts.html b/source/api/apidocs-4.0.0/domain_admin/listAccounts.html new file mode 100644 index 0000000..f585c33 --- /dev/null +++ b/source/api/apidocs-4.0.0/domain_admin/listAccounts.html @@ -0,0 +1,265 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.0.0-incubating Domain Admin API Reference + +

+

listAccounts

+

Lists accounts and provides detailed account information for listed accounts

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accounttypelist accounts by account type. Valid account types are 1 (admin), 2 (domain-admin), and 0 (user).false
domainidlist only resources belonging to the domain specifiedfalse
idlist account by account IDfalse
iscleanuprequiredlist accounts by cleanuprequred attribute (values are true or false)false
isrecursivedefaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.false
keywordList by keywordfalse
listallIf 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 falsefalse
namelist account by account namefalse
pagefalse
pagesizefalse
statelist accounts by state. Valid states are enabled, disabled, and locked.false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idthe id of the account
accountdetailsdetails for the account
accounttypeaccount type (admin, domain-admin, user)
defaultzoneidthe default zone of the account
domainname of the Domain the account belongs too
domainidid of the Domain the account belongs too
ipavailablethe total number of public ip addresses available for this account to acquire
iplimitthe total number of public ip addresses this account can acquire
iptotalthe total number of public ip addresses allocated for this account
iscleanuprequiredtrue if the account requires cleanup
namethe name of the account
networkavailablethe total number of networks available to be created for this account
networkdomainthe network domain
networklimitthe total number of networks the account can own
networktotalthe total number of networks owned by account
projectavailablethe total number of projects available for administration by this account
projectlimitthe total number of projects the account can own
projecttotalthe total number of projects being administrated by this account
receivedbytesthe total number of network traffic bytes received
sentbytesthe total number of network traffic bytes sent
snapshotavailablethe total number of snapshots available for this account
snapshotlimitthe total number of snapshots which can be stored by this account
snapshottotalthe total number of snapshots stored by this account
statethe state of the account
templateavailablethe total number of templates available to be created by this account
templatelimitthe total number of templates which can be created by this account
templatetotalthe total number of templates which have been created by this account
vmavailablethe total number of virtual machines available for this account to acquire
vmlimitthe total number of virtual machines that can be deployed by this account
vmrunningthe total number of virtual machines running for this account
vmstoppedthe total number of virtual machines stopped for this account
vmtotalthe total number of virtual machines deployed by this account
volumeavailablethe total volume available for this account
volumelimitthe total volume which can be used by this account
volumetotalthe total volume being used by this account
vpcavailablethe total number of vpcs available to be created for this account
vpclimitthe total number of vpcs the account can own
vpctotalthe total number of vpcs owned by account
user(*)the list of users associated with account
idthe user ID
accountthe account name of the user
accountidthe account ID of the user
accounttypethe account type of the user
apikeythe api key of the user
createdthe date and time the user account was created
domainthe domain name of the user
domainidthe domain ID of the user
emailthe user email address
firstnamethe user firstname
lastnamethe user lastname
secretkeythe secret key of the user
statethe user state
timezonethe timezone user was created in
usernamethe user name
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/5c2e0541/source/api/apidocs-4.0.0/domain_admin/listAsyncJobs.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.0.0/domain_admin/listAsyncJobs.html b/source/api/apidocs-4.0.0/domain_admin/listAsyncJobs.html new file mode 100644 index 0000000..6262f47 --- /dev/null +++ b/source/api/apidocs-4.0.0/domain_admin/listAsyncJobs.html @@ -0,0 +1,130 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.0.0-incubating Domain Admin API Reference + +

+

listAsyncJobs

+

Lists all pending asynchronous jobs for the account.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accountList resources by account. Must be used with the domainId parameter.false
domainidlist only resources belonging to the domain specifiedfalse
isrecursivedefaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.false
keywordList by keywordfalse
listallIf 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 falsefalse
pagefalse
pagesizefalse
startdatethe start date of the async jobfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
accountidthe account that executed the async command
cmdthe async command executed
created the created date of the job
jobinstanceidthe unique ID of the instance/entity object related to the job
jobinstancetypethe instance/entity object related to the job
jobprocstatusthe progress information of the PENDING job
jobresultthe result reason
jobresultcodethe result code for the job
jobresulttypethe result type
jobstatusthe current job status-should be 0 for PENDING
useridthe user that executed the async command
jobidthe ID of the async job
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/5c2e0541/source/api/apidocs-4.0.0/domain_admin/listCapabilities.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.0.0/domain_admin/listCapabilities.html b/source/api/apidocs-4.0.0/domain_admin/listCapabilities.html new file mode 100644 index 0000000..29daf4c --- /dev/null +++ b/source/api/apidocs-4.0.0/domain_admin/listCapabilities.html @@ -0,0 +1,91 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.0.0-incubating Domain Admin API Reference + +

+

listCapabilities

+

Lists capabilities

+
+
+ +
+
+
+

Request parameters

+ + + + +
Parameter NameDescriptionRequired
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
allowusercreateprojectstrue if regular user is allowed to create projects
cloudstackversionversion of the cloud stack
customdiskofferingmaxsizemaximum size that can be specified when create disk from disk offering with custom size
projectinviterequiredIf invitation confirmation is required when add account to project
securitygroupsenabledtrue if security groups support is enabled, false otherwise
supportELBtrue if region supports elastic load balancer on basic zones
userpublictemplateenabledtrue if user and domain admins can set templates to be shared, false otherwise
+
+
+
+
+
+ +
+
+ +