Skip to main content

Retrieve ongoing SnapMirror transfers for a relationship

Contributors
PDFs

GET /snapmirror/relationships/{relationship.uuid}/transfers

Introduced In: 9.6

Retrieves the list of ongoing SnapMirror transfers for the specified relationship.

  • snapmirror show

Example

GET "/api/snapmirror/relationships/293baa53-e63d-11e8-bff1-005056a793dd/transfers"

Learn more

Parameters

Name Type In Required Description

relationship.uuid

string

path

True

SnapMirror relationship UUID

last_updated_time

string

query

False

Filter by last_updated_time

  • Introduced in: 9.15

checkpoint_size

integer

query

False

Filter by checkpoint_size

total_duration

string

query

False

Filter by total_duration

  • Introduced in: 9.10

end_time

string

query

False

Filter by end_time

  • Introduced in: 9.10

relationship.destination.svm.uuid

string

query

False

Filter by relationship.destination.svm.uuid

relationship.destination.svm.name

string

query

False

Filter by relationship.destination.svm.name

relationship.destination.path

string

query

False

Filter by relationship.destination.path

relationship.destination.consistency_group_volumes.name

string

query

False

Filter by relationship.destination.consistency_group_volumes.name

  • Introduced in: 9.8

relationship.destination.cluster.name

string

query

False

Filter by relationship.destination.cluster.name

  • Introduced in: 9.7

relationship.destination.cluster.uuid

string

query

False

Filter by relationship.destination.cluster.uuid

  • Introduced in: 9.7

relationship.restore

boolean

query

False

Filter by relationship.restore

state

string

query

False

Filter by state

network_compression_ratio

string

query

False

Filter by network_compression_ratio

  • Introduced in: 9.13

throttle

integer

query

False

Filter by throttle

  • Introduced in: 9.9

on_demand_attrs

string

query

False

Filter by on_demand_attrs

  • Introduced in: 9.13

uuid

string

query

False

Filter by uuid

error_info.message

string

query

False

Filter by error_info.message

  • Introduced in: 9.10

error_info.code

integer

query

False

Filter by error_info.code

  • Introduced in: 9.10

snapshot

string

query

False

Filter by snapshot

bytes_transferred

integer

query

False

Filter by bytes_transferred

fields

array[string]

query

False

Specify the fields to return.

max_records

integer

query

False

Limit the number of records returned.

return_records

boolean

query

False

The default is true for GET calls. When set to false, only the number of records is returned.

  • Default value: 1

return_timeout

integer

query

False

The number of seconds to allow the call to execute before returning. When iterating over a collection, the default is 15 seconds. ONTAP returns earlier if either max records or the end of the collection is reached.

  • Default value: 1

  • Max value: 120

  • Min value: 0

order_by

array[string]

query

False

Order results by specified fields and optional [asc

Response

Status: 200, Ok
Name Type Description

_links

_links

num_records

integer

Number of records

records

array[snapmirror_transfer]
Example response 
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "num_records": 1,
  "records": [
    {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "archive_retrieval_priority": "high",
      "bytes_transferred": 0,
      "checkpoint_size": 0,
      "end_time": "2020-12-02 21:36:19 -0500",
      "error_info": {
        "code": 6620046,
        "message": "Transfer aborted"
      },
      "files": [
        {
          "destination_path": "/dirb/file2",
          "source_path": "/dira/file1"
        }
      ],
      "last_updated_time": "2023-09-15 19:58:39 -0400",
      "network_compression_ratio": 61,
      "on_demand_attrs": "read_write_with_user_data_pull",
      "options": [
        {
          "overwrite": 1,
          "preserve_dedup_savings": 1
        }
      ],
      "relationship": {
        "destination": {
          "cluster": {
            "_links": {
              "self": {
                "href": "/api/resourcelink"
              }
            },
            "name": "cluster1",
            "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
          },
          "consistency_group_volumes": [
            {
              "name": "volume1",
              "uuid": "028baa66-41bd-11e9-81d5-00a0986138f7"
            }
          ],
          "ipspace": "Default",
          "path": "svm1:volume1",
          "svm": {
            "_links": {
              "self": {
                "href": "/api/resourcelink"
              }
            },
            "name": "svm1",
            "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
          },
          "uuid": "4ea7a442-86d1-11e0-ae1c-123478563412"
        },
        "uuid": "d2d7ceea-ab52-11e8-855e-00505682a4c7"
      },
      "snapshot": "string",
      "snapshot_retention_period": "P30D",
      "source_snapshot": "string",
      "source_snapshot_uuid": "string",
      "state": "string",
      "throttle": 0,
      "total_duration": "PT28M41S",
      "uuid": "4ea7a442-86d1-11e0-ae1c-123478563412"
    }
  ]
}

Error

Status: Default, Error
Name Type Description

error

returned_error
Example error 
{
  "error": {
    "arguments": [
      {
        "code": "string",
        "message": "string"
      }
    ],
    "code": "4",
    "message": "entry doesn't exist",
    "target": "uuid"
  }
}

Definitions

See Definitions

href

Name Type Description

href

string

_links

Name Type Description

next

href

self

href

_links

Name Type Description

self

href

error_info

Error information for the transfer.