Retrieve systems
Suggest changes
GET /account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment
Retrieves a list of systems and their details. This API endpoint retrieves the name, region, status, type, cloud-provider, provider-accountId, ontap-version, and total-volumes-count information.
Token usage: NetApp Console user token.
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
partial |
boolean |
query |
False |
Returns only a partial response without volumes count for systems |
cache |
boolean |
query |
False |
Return systems with minimal fields using cache by default, if not found in cache triggers live call to fetch details |
accountId |
string |
path |
True |
Account ID |
authorization |
string |
header |
True |
User token |
X-Agent-Id |
string |
header |
True |
Request identifier |
Response
Status: 200, Default response| Name | Type | Required | Description |
|---|---|---|---|
working-environment |
array[working-environment] |
False |
Example response
{
"working-environment": [
{
"id": "string",
"cluster-uuid": "string",
"name": "string",
"error": "string",
"region": "string",
"status": "string",
"ontap-version": "string",
"type": "string",
"provider": "string",
"provider-account-id": "string",
"total-volumes-count": "string"
}
]
}Definitions
See Definitions
working-environment
| Name | Type | Required | Description |
|---|---|---|---|
id |
string |
False |
|
cluster-uuid |
string |
False |
|
name |
string |
False |
|
error |
string |
False |
|
region |
string |
False |
|
status |
string |
False |
|
ontap-version |
string |
False |
|
type |
string |
False |
|
provider |
string |
False |
|
provider-account-id |
string |
False |
AWS account ID/ Azure subscription ID / Google Cloud project ID |
total-volumes-count |
string |
False |