ListAccounts
Suggest changes
PDFs
You can use ListAccounts to get the entire list of storage tenant accounts, with optional paging support. Element accounts enable access to volumes.
Parameters
This method has the following input parameters:
| Name | Description | Type | Default value | Required |
|---|---|---|---|---|
includeStorageContainers |
Virtual volume storage containers are included in the response by default. To exclude storage containers, set to false. |
boolean |
true |
No |
startAccountID |
Starting accountID to return. If no account exists with this accountID, the next account by accountID order is used as the start of the list. To page through the list, pass the accountID of the last account in the previous response + 1. |
integer |
None |
No |
limit |
Maximum number of account objects to return. |
integer |
None |
No |
Return value
This method has the following return value:
Name |
Description |
Type |
accounts |
The list of accounts. |
account array |
Request example
Requests for this method are similar to the following example:
{
"method": "ListAccounts",
"params": {
"startAccountID" : 0,
"limit" : 1000
},
"id" : 1
}
Response example
This method returns a response similar to the following example:
{
"result" : {
"accounts": [
{
"attributes": {},
"username": "jamesw",
"targetSecret": "168#5A757ru268)",
"volumes": [],
"enableChap": false,
"status": "active",
"accountID": 16,
"storageContainerID": "abcdef01-1234-5678-90ab-cdef01234567",
"initiatorSecret": "168#5A757ru268)"
},
{
"attributes": {},
"username": "jimmyd",
"targetSecret": "targetsecret",
"volumes": [],
"enableChap": true,
"status": "active",
"accountID": 5,
"storageContainerID": "abcdef01-1234-5678-90ab-cdef01234567",
"initiatorSecret": "initiatorsecret"
}
]
}
}
New since version
9.6