Create a report
POST /api/v1/accounts/{accountId}/reports
Creates a report.
Parameters
Name | Type | In | Required | Description |
---|---|---|---|---|
accountId |
string |
path |
True |
Tenancy Account Id |
x-agent-id |
string |
header |
True |
Connector ID |
x-workspace-id |
string |
header |
True |
Workspace ID |
Request Body
Name | Type | Required | Description |
---|---|---|---|
name |
string |
True |
Report Name |
endpoint |
True |
Response
Status: 202, Default Response
Name | Type | Required | Description |
---|---|---|---|
id |
string |
True |
Report ID |
name |
string |
True |
Report Name |
endpoint |
True |
||
statistics |
True |
Definitions
See Definitions
nfs
Name | Type | Required | Description |
---|---|---|---|
workingEnvironmentId |
string |
True |
Working Environment ID |
workingEnvironmentName |
string |
True |
Working Environment Name |
volumeName |
string |
True |
Volume Name |
svmName |
string |
False |
SVM Name |
volumeUid |
string |
True |
Volume UUID |
ip |
string |
True |
Data LIF endpoint |
path |
string |
True |
Volume path |
provider |
[nil, nil, nil, nil] |
True |
|
version |
["string", "string", "string", "string"] |
True |
smb
Name | Type | Required | Description |
---|---|---|---|
workingEnvironmentId |
string |
True |
Working Environment ID |
workingEnvironmentName |
string |
True |
Working Environment Name |
volumeName |
string |
True |
Volume Name |
svmName |
string |
False |
SVM Name |
volumeUid |
string |
True |
Volume UUID |
ip |
string |
True |
Data LIF endpoint |
path |
string |
True |
Volume path |
provider |
[nil, nil, nil, nil] |
True |
|
version |
["string", "string", "string", "string", "string"] |
True |
|
username |
string |
False |
|
password |
string |
False |
|
workgroup |
string |
False |
endpoint
Name | Type | Required | Description |
---|---|---|---|
protocol |
[nil, nil] |
True |
|
nfs |
False |
||
smb |
False |
totals
Name | Type | Required | Description |
---|---|---|---|
files |
number |
True |
Total number of files |
directories |
number |
True |
Total number of directories |
symbolicLinks |
number |
True |
Total number of symbolic links |
hardLinks |
number |
True |
Total number of hard links |
others |
number |
True |
|
emptyDirectories |
number |
True |
Total number of empty directories |
emptyFiles |
number |
True |
Total number of empty files |
size |
number |
True |
Total size |
failed |
number |
True |
Total failed items |
allocatedCapacity |
number |
False |
Total allocated capacity on volume |
errors
Name | Type | Required | Description |
---|---|---|---|
counter |
number |
True |
Error counter |
description |
string |
False |
Error description |
errors Hash mapping strings to errors
width
Name | Type | Required | Description |
---|---|---|---|
total |
number |
True |
|
files |
number |
True |
|
directories |
number |
True |
|
hardLinks |
number |
False |
|
symbolicLinks |
number |
False |
|
others |
number |
False |
maximums
Name | Type | Required | Description |
---|---|---|---|
depth |
number |
True |
|
width |
True |
||
path |
number |
True |
topDirectoriesByWidth
Name | Type | Required | Description |
---|---|---|---|
path |
string |
True |
|
count |
number |
True |
topFilesBySize
Name | Type | Required | Description |
---|---|---|---|
path |
string |
True |
|
size |
number |
True |
top
Name | Type | Required | Description |
---|---|---|---|
topDirectoriesByWidth |
array[topDirectoriesByWidth] |
True |
|
topFilesBySize |
array[topFilesBySize] |
True |
atime
Distribution by atime
Name | Type | Required | Description |
---|---|---|---|
0hr-1hr |
number |
True |
|
1hr-1d |
number |
True |
|
1d-1w |
number |
True |
|
1w-1m |
number |
True |
|
1m-1y |
number |
True |
|
1y+ |
number |
True |
ctime
Distribution by ctime
Name | Type | Required | Description |
---|---|---|---|
0hr-1hr |
number |
True |
|
1hr-1d |
number |
True |
|
1d-1w |
number |
True |
|
1w-1m |
number |
True |
|
1m-1y |
number |
True |
|
1y+ |
number |
True |
mtime
Distribution by mtime
Name | Type | Required | Description |
---|---|---|---|
0hr-1hr |
number |
True |
|
1hr-1d |
number |
True |
|
1d-1w |
number |
True |
|
1w-1m |
number |
True |
|
1m-1y |
number |
True |
|
1y+ |
number |
True |
size
Distribution by size
Name | Type | Required | Description |
---|---|---|---|
0mb-1mb |
number |
True |
|
1mb-10mb |
number |
True |
|
10mb-100mb |
number |
True |
|
100mb-1gb |
number |
True |
|
1gb-10gb |
number |
True |
|
10gb-100gb |
number |
True |
|
100gb-1tb |
number |
True |
|
1tb+ |
number |
True |
distributions
Name | Type | Required | Description |
---|---|---|---|
atime |
True |
Distribution by atime |
|
ctime |
True |
Distribution by ctime |
|
mtime |
True |
Distribution by mtime |
|
size |
True |
Distribution by size |
statistics
Name | Type | Required | Description |
---|---|---|---|
status |
[nil, nil, nil] |
True |
|
startTime |
number |
True |
|
endTime |
number |
False |
|
reason |
string |
False |
|
totals |
True |
||
errors |
False |
||
maximums |
True |
||
top |
True |
||
distributions |
True |