Retrieve system details
Suggest changes
GET /account/{accountId}/providers/cloudmanager_cbs/api/v1/backup/working-environment
Retrieves the details of all systems that are backed up using the NetApp Backup and Recovery service within an account. It retrieves the backup enablement status, archive storage class, archive after days, catalog enablement status, auto enablement status, maximum transfer status, backup policy details, cloud storage pool, and remote MetroCluster ID.
Token usage: NetApp Console user token.
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
partial |
boolean |
query |
False |
Returns only a partial response for the systems |
object-store-details |
boolean |
query |
False |
A filter to include/exclude fields named provider-access-key and ip-space
|
capacity-details |
boolean |
query |
False |
A filter to include/exclude fields named used-capacity-gb, charging-capacity,logical-used-size,backed-up-volume-count
|
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": [
{
"name": "string",
"id": "string",
"clusterId": "string",
"region": "string",
"status": "string",
"ontap-version": "string",
"backup-enablement-status": "string",
"type": "string",
"provider": "string",
"provider-account-id": "string",
"provider-account-name": "string",
"bucket": "string",
"archive-storage-class": "string",
"resource-group": "string",
"storage-account": "string",
"storage-server": "string",
"used-capacity-gb": "string",
"charging-capacity": "string",
"logical-used-size": "string",
"backed-up-volume-count": "string",
"total-volumes-count": "string",
"backup-policy-count": "string",
"failed-backup-volume-count": "string",
"object-lock": "string",
"backup-policy": {
"name": "string",
"rule": [
{
"label": "string",
"retention": "string"
}
],
"archive-after-days": "string"
},
"ip-space": "string",
"provider-access-key": "string",
"storage-grid-id": "string",
"sgws-archival": {
"cloud-storage-pool": {
"provider": "string",
"provider-account-id": "string",
"region": "string",
"access-key": "string",
"archive-storage-class": "string"
}
},
"remote-mcc-id": "string",
"architecture": "string",
"snapshot-policy": "string",
"replication-target": {
"id": "string",
"name": "string",
"policy-name": "string",
"prefix": "string",
"suffix": "string",
"svm": "string",
"aggregate": [
"string"
]
},
"rsw-scan-interval": "string"
}
]
}Definitions
See Definitions
rule
| Name | Type | Required | Description |
|---|---|---|---|
label |
string |
False |
|
retention |
string |
False |
backup-policy
| Name | Type | Required | Description |
|---|---|---|---|
name |
string |
False |
|
rule |
array[rule] |
False |
|
archive-after-days |
string |
False |
license
| Name | Type | Required | Description |
|---|---|---|---|
free-trial-end |
number |
False |
|
eligible |
boolean |
False |
cloud-storage-pool
| Name | Type | Required | Description |
|---|---|---|---|
provider |
string |
True |
Cloud provider where the cloud storage pool is hosted |
provider-account-id |
string |
True |
Cloud provider account ID where the cloud storage pool is hosted |
region |
string |
True |
Cloud provider region where the cloud storage pool is hosted |
access-key |
string |
False |
|
archive-storage-class |
string |
False |
Storage class of a cloud storage pool to store archived objects |
sgws-archival
| Name | Type | Required | Description |
|---|---|---|---|
cloud-storage-pool |
False |
replication-target
| Name | Type | Required | Description |
|---|---|---|---|
id |
string |
False |
|
name |
string |
False |
|
policy-name |
string |
False |
|
prefix |
string |
False |
|
suffix |
string |
False |
|
svm |
string |
False |
|
aggregate |
array[string] |
False |
object-store-size
| Name | Type | Required | Description |
|---|---|---|---|
standard |
number |
False |
|
archive |
number |
False |
keyDetails
JSON data containing data specific to Customer Managed Encryption Keys
cmek
| Name | Type | Required | Description |
|---|---|---|---|
enabled |
boolean |
False |
|
keyDetails |
False |
JSON data containing data specific to Customer Managed Encryption Keys |
working-environment
| Name | Type | Required | Description |
|---|---|---|---|
name |
string |
False |
|
id |
string |
False |
|
clusterId |
string |
False |
|
region |
string |
False |
|
status |
string |
False |
|
ontap-version |
string |
False |
|
backup-enablement-status |
string |
False |
|
type |
string |
False |
|
provider |
string |
False |
|
provider-account-id |
string |
False |
|
provider-account-name |
string |
False |
|
bucket |
string |
False |
|
archive-storage-class |
string |
False |
|
resource-group |
string |
False |
|
storage-account |
string |
False |
|
storage-server |
string |
False |
|
used-capacity-gb |
string |
False |
|
charging-capacity |
string |
False |
|
logical-used-size |
string |
False |
|
backed-up-volume-count |
string |
False |
|
total-volumes-count |
string |
False |
|
backup-policy-count |
string |
False |
|
failed-backup-volume-count |
string |
False |
|
catalog-enabled |
boolean |
False |
|
object-lock |
string |
False |
|
max-transfer-rate |
number |
False |
|
backup-policy |
False |
||
private-endpoint-required |
boolean |
False |
|
license |
False |
||
ip-space |
string |
False |
|
provider-access-key |
string |
False |
|
delete-yearly-snapshots |
boolean |
False |
|
export-existing-snapshots |
boolean |
False |
|
storage-grid-id |
string |
False |
|
sgws-archival |
False |
||
remote-mcc-id |
string |
False |
|
architecture |
string |
False |
|
snapshot-policy |
string |
False |
|
replication-target |
False |
||
fix-mismatch-labels |
boolean |
False |
|
rsw-scheduled-scan |
boolean |
False |
|
rsw-scan-interval |
string |
False |
|
object-store-size |
False |
||
cmek |
False |