Cosmic User 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 |
| 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 |
| 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 |