Retrieve a relationship
Suggest changes
GET /api/relationships-v2/{id}
Retrieves a relationship.
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
id |
string |
path |
True |
Relationship Id |
x-account-id |
string |
header |
True |
NetApp tenancy account Id |
Response
Status: 200, Default Response| Name | Type | Required | Description |
|---|---|---|---|
id |
string |
True |
Relationship ID |
isCM |
string |
False |
Was the relationship created via CloudManager |
dataBroker |
string |
False |
Data Broker ID |
relationshipId |
string |
False |
Relationship ID |
source |
True |
||
target |
True |
||
encryption |
False |
||
group |
string |
False |
Group ID |
settings |
False |
||
activity |
False |
||
createdAt |
number |
True |
Relationship Creation time |
customHeaders |
False |
Custom headers for the relationship |
|
extraInformation |
False |
||
tags |
array[tags] |
False |
Definitions
See Definitions
credentials
CIFS credentials
| Name | Type | Required | Description |
|---|---|---|---|
username |
string |
True |
User name |
password |
string |
True |
password |
domain |
string |
False |
Domain |
cifs
CIFS Details
| Name | Type | Required | Description |
|---|---|---|---|
host |
string |
True |
CIFS host |
share |
string |
True |
CIFS share |
provider |
string |
True |
CIFS type |
path |
string |
False |
CIFS path |
version |
string |
False |
Supported CIFS versions |
workingEnvironmentId |
string |
False |
Relevant working environment ID |
credentials |
False |
CIFS credentials |
nfs
NFS Details
| Name | Type | Required | Description |
|---|---|---|---|
host |
string |
True |
NFS host |
export |
string |
True |
NFS export |
provider |
string |
True |
NFS type |
path |
string |
False |
NFS path |
version |
string |
False |
Supported NFS versions |
workingEnvironmentId |
string |
False |
Relevant working environment ID |
accessPoint |
string |
False |
EFS access point |
encryption
S3 encryption
| Name | Type | Required | Description |
|---|---|---|---|
protocol |
string |
False |
Encryption type |
keyId |
string |
False |
Encryption key ARN in case it is KMS encryption |
| Name | Type | Required | Description |
|---|---|---|---|
key |
string |
False |
Tag Key |
value |
string |
False |
Tag Value |
glacier
Glacier storage class restore information (available only for s3 as source endpoint)
| Name | Type | Required | Description |
|---|---|---|---|
days |
number |
True |
Lifetime of the active copy in days |
tier |
string |
True |
Glacier retrieval tier at which the restore will be processed |
deepArchive
Deep Archive storage class restore information (available only for s3 as source endpoint)
| Name | Type | Required | Description |
|---|---|---|---|
days |
number |
True |
Lifetime of the active copy in days |
tier |
string |
True |
Deep Archive retrieval tier at which the restore will be processed |
s3
S3 details
| Name | Type | Required | Description |
|---|---|---|---|
host |
string |
False |
SGWS or IBM or ONTAP host |
port |
integer |
False |
SGWS or IBM or ONTAP port |
bucket |
string |
True |
Bucket |
prefix |
string |
False |
Prefix |
region |
string |
False |
Bucket region |
encryption |
False |
S3 encryption |
|
privateLinkDns |
string |
False |
AWS S3 Private Link DNS |
tags |
array[tags] |
False |
|
storageClass |
string |
False |
S3 Storage Class |
provider |
string |
True |
Object Storage Type |
workingEnvironmentId |
string |
False |
Relevant working environment ID - for storageGrid working environment |
glacier |
False |
Glacier storage class restore information (available only for s3 as source endpoint) |
|
deepArchive |
False |
Deep Archive storage class restore information (available only for s3 as source endpoint) |
local
Local object details
| Name | Type | Required | Description |
|---|---|---|---|
path |
string |
True |
Local Path |
azure
Azure Blob Storage Details
| Name | Type | Required | Description |
|---|---|---|---|
container |
string |
True |
Azure Blob Storage container name |
storageAccountName |
string |
False |
Azure Blob Storage account name |
prefix |
string |
False |
Container blob prefix |
path |
string |
False |
Container path, used in azure data lake storage |
tags |
array[tags] |
False |
|
blobTier |
string |
False |
Blob tier type |
provider |
string |
True |
Azure type |
gcp
| Name | Type | Required | Description |
|---|---|---|---|
bucket |
string |
True |
GCP Bucket |
prefix |
string |
False |
GCP Bucket prefix |
tags |
array[tags] |
False |
|
storageClass |
string |
False |
GCP Storage Class |
kmsKeyName |
string |
False |
GCP Kms name |
provider |
string |
True |
GCP Type |
gdrive
| Name | Type | Required | Description |
|---|---|---|---|
driveId |
string |
True |
Drive Id |
driveName |
string |
False |
Drive Name |
folderId |
string |
False |
Google Drive folderId |
path |
string |
False |
Folder path |
provider |
string |
True |
Google Drive Type |
tags |
array[tags] |
False |
|
subject |
string |
True |
subject - user email |
sftp
| Name | Type | Required | Description |
|---|---|---|---|
host |
string |
True |
SFTP host |
port |
integer |
True |
SFTP port number |
path |
string |
False |
Directory path |
rootDirectory |
string |
True |
Root Directory path |
provider |
string |
True |
SFTP Type |
box
| Name | Type | Required | Description |
|---|---|---|---|
rootDirectory |
string |
False |
Root Directory |
path |
string |
False |
path |
folderId |
string |
True |
Folder Id |
clientId |
string |
True |
Client Id |
appName |
string |
False |
Box Application Name |
enterpriseId |
string |
False |
Enterprise Id |
provider |
string |
True |
Box Type |
source
| Name | Type | Required | Description |
|---|---|---|---|
protocol |
string |
False |
Endpoint protocol |
cifs |
False |
CIFS Details |
|
nfs |
False |
NFS Details |
|
s3 |
False |
S3 details |
|
local |
False |
Local object details |
|
azure |
False |
Azure Blob Storage Details |
|
gcp |
False |
||
gdrive |
False |
||
sftp |
False |
||
box |
False |
encryption
S3 encryption
| Name | Type | Required | Description |
|---|---|---|---|
protocol |
string |
False |
Encryption type |
keyId |
string |
False |
Encryption key arn in case it is kms encryption |
target
| Name | Type | Required | Description |
|---|---|---|---|
protocol |
string |
False |
Endpoint protocol |
cifs |
False |
CIFS Details |
|
nfs |
False |
NFS Details |
|
s3 |
False |
S3 details |
|
local |
False |
Local object details |
|
azure |
False |
Azure Blob Storage Details |
|
gcp |
False |
||
gdrive |
False |
||
sftp |
False |
||
box |
False |
initiator
Initiator details
| Name | Type | Required | Description |
|---|---|---|---|
dataBrokerId |
string |
False |
Data Broker Id |
groupId |
string |
False |
Group Id |
encryptionType |
string |
False |
Data Broker network location - if initiator is src, listener must be trg |
listener
Listener details
| Name | Type | Required | Description |
|---|---|---|---|
dataBrokerId |
string |
False |
Data Broker Id |
groupId |
string |
False |
Group Id |
encryptionType |
string |
False |
Data Broker network location - if initiator is src, listener must be trg |
encryption
| Name | Type | Required | Description |
|---|---|---|---|
initiator |
False |
Initiator details |
|
listener |
False |
Listener details |
fileTypes
The file types that is included in the relationship
| Name | Type | Required | Description |
|---|---|---|---|
files |
boolean |
False |
Include files |
directories |
boolean |
False |
Include directories |
symlinks |
boolean |
False |
Include symbolic links |
hardlinks |
boolean |
False |
include hard links |
compareBy
The file attributes that should be compared
| Name | Type | Required | Description |
|---|---|---|---|
uid |
boolean |
False |
uid ( relevant when source or target is file system ) |
gid |
boolean |
False |
gid ( relevant when source or target is file system ) |
mtime |
boolean |
False |
mtime |
mode |
boolean |
False |
mode |
copyProperties
The object properties that should be copied
| Name | Type | Required | Description |
|---|---|---|---|
metadata |
boolean |
False |
copy metadata ( cloud to cloud ) |
tags |
boolean |
False |
copy tags ( cloud to cloud only S3 compatible ) |
files
Settings related to files.
| Name | Type | Required | Description |
|---|---|---|---|
excludeExtensions |
array[string] |
False |
Excluded extensions array (For example - [".log", ".tar.gz"]) |
excludeByRegex |
array[string] |
False |
Excluded files by regex (For example - ".txt." will exclude the files file.doc.txt.gz) |
minSize |
integer |
False |
Minimum file size (in bytes). Only files of equal or larger size will be transferred by the relationship |
maxSize |
integer |
False |
Maximum file size (in bytes). Only files of equal or smaller size will be transferred by the relationship |
minDate |
string |
False |
Data broker will sync files that were last modified after this date. The date must be an ISO 8601 valid date. For example - '2012-02-21' |
maxDate |
["null", "string"] |
False |
Data broker will sync files that were last modified before this date. Insert 'null' to sync all future files. The date must be an ISO 8601 valid date |
minCreationDate |
string |
False |
Data broker will sync files that were created after this date. The date must be an ISO 8601 valid date. For example - '2012-02-21' |
maxCreationDate |
["null", "string"] |
False |
Data broker will sync files that were created before this date. Insert 'null' to sync all future files. The date must be an ISO 8601 valid date |
directories
Settings related to directories.
| Name | Type | Required | Description |
|---|---|---|---|
excludeNames |
array[string] |
False |
Excluded directories names array (For example - ["dir1"]) |
schedule
Sync schedule settings.
| Name | Type | Required | Description |
|---|---|---|---|
syncInDays |
integer |
False |
Days interval for sync scheduler |
syncInHours |
integer |
False |
|
syncInMinutes |
integer |
False |
|
isEnabled |
boolean |
False |
Activate automatic scheduler |
nextTime |
string |
False |
The first time the relationship should run |
syncWhenCreated |
boolean |
False |
Start the sync upon creation |
cm
Cloud Manager notifications
| Name | Type | Required | Description |
|---|---|---|---|
done |
boolean |
False |
Should send notification about DONE status |
failed |
boolean |
False |
Should send notification about FAILED status |
aborted |
boolean |
False |
Should send notification about ABORTED status |
running_continuously |
boolean |
False |
Should send notification about RUNNING_CONTINUOUSLY status |
notifications
Notifications settings.
| Name | Type | Required | Description |
|---|---|---|---|
cm |
False |
Cloud Manager notifications |
scheduleAbort
Schedule abort settings.
| Name | Type | Required | Description |
|---|---|---|---|
abortInDays |
integer |
False |
Days interval for abort scheduler |
abortInHours |
integer |
False |
Hours interval for abort scheduler |
abortInMinutes |
integer |
False |
Minutes interval for abort scheduler |
isEnabled |
boolean |
False |
Activate automatic scheduler abort |
settings
| Name | Type | Required | Description |
|---|---|---|---|
gracePeriod |
number |
True |
Grace period time ( seconds ) |
deleteOnSource |
boolean |
True |
Enable delete on source |
deleteOnTarget |
boolean |
True |
Enable delete on target |
objectTagging |
boolean |
True |
Use S3 tagging to store object metadata |
retries |
integer |
True |
number of retries |
copyAcl |
boolean |
False |
Enable acl copy |
copyData |
boolean |
True |
Copy data only |
continuousSync |
boolean |
False |
Listen to object notifications |
fileTypes |
True |
The file types that is included in the relationship |
|
compareBy |
True |
The file attributes that should be compared |
|
copyProperties |
False |
The object properties that should be copied |
|
files |
True |
Settings related to files. |
|
directories |
True |
Settings related to directories. |
|
schedule |
True |
Sync schedule settings. |
|
notifications |
False |
Notifications settings. |
|
scheduleAbort |
True |
Schedule abort settings. |
topFiveMostCommonRelationshipErrors
| Name | Type | Required | Description |
|---|---|---|---|
step |
string |
False |
Sync step that failed - TRANSFER or SCAN |
errorCode |
string |
False |
Error code |
counter |
number |
False |
Number of errors |
description |
string |
False |
Error description |
errors
| Name | Type | Required | Description |
|---|---|---|---|
dataBrokerId |
string |
False |
Data Broker with initialized error |
reason |
string |
False |
Error |
activity
| Name | Type | Required | Description |
|---|---|---|---|
syncType |
string |
False |
field for UI - to indicate if we copy only acl or copy also data |
status |
string |
False |
Relationship status |
type |
string |
False |
Relationship phase - Initial copy or sync |
bytesMarkedForCopy |
number |
False |
Bytes marked for copy |
filesMarkedForCopy |
number |
False |
Files marked for copy |
dirsMarkedForCopy |
number |
False |
Directories marked for copy |
filesCopied |
number |
False |
Files copied |
bytesCopied |
number |
False |
Bytes copied |
dirsCopied |
number |
False |
Directories copied |
filesFailed |
number |
False |
files failed to copy |
bytesFailed |
number |
False |
Bytes failed to copy |
dirsFailed |
number |
False |
Directories failed to copy |
filesMarkedForRemove |
number |
False |
Files marked for remove |
bytesMarkedForRemove |
number |
False |
Byes marked for remove |
dirsMarkedForRemove |
number |
False |
Directories marked for remove |
filesRemoved |
number |
False |
Files removed |
bytesRemoved |
number |
False |
Bytes removed |
dirsRemoved |
number |
False |
Directories removed |
bytesRemovedFailed |
number |
False |
Bytes failed to remove |
filesRemovedFailed |
number |
False |
Filed failed to remove |
filesMarkedForIgnore |
number |
False |
Files marked for ignore |
dirsScanned |
number |
False |
Directories scanned |
filesScanned |
number |
False |
Files scanned |
bytesScanned |
number |
False |
Bytes scanned |
dirsFailedToScan |
number |
False |
Directories failed to scan |
timeEstimation |
number |
False |
Time estimation until the end of the sync |
progress |
number |
False |
Relationship progress |
endTime |
string |
False |
End time |
startTime |
string |
False |
Start time |
executionTime |
number |
False |
Execution time |
failureMessage |
string |
False |
Failure message |
lastMessageTime |
string |
False |
Last message time |
topFiveMostCommonRelationshipErrors |
False |
||
errors |
array[errors] |
False |
customHeaders
Custom headers for the relationship
| Name | Type | Required | Description |
|---|---|---|---|
x-netapp-external-request-id-src |
string |
False |
Source request id header |
x-netapp-external-request-id-trg |
string |
False |
Target request id header |
x-source-edge |
string |
False |
Edge cluster uuid |
x-target-edge |
string |
False |
Edge cluster uuid |
x-sync-source |
string |
False |
Is source Edge |
x-sync-target |
string |
False |
is target Edge |
extraInformation
| Name | Type | Required | Description |
|---|---|---|---|
dataSenseQueryUid |
string |
False |
Data sense query uid |
connectorId |
string |
False |
Connector Id ( for data sense query ) |