Retrieves details of a specific snapshot copy policy schedule
Suggest changes
PDFs
learn more
-
[
doc /storage/snapshot-policies/{snapshot_policyuuid}/schedules](#docs-storage-storage_snapshot-policies_{snapshot_policyuuid}_schedules)
GET /storage/snapshot-policies/{snapshot_policy.uuid}/schedules/{schedule.uuid}
Introduced In: 9.8
Retrieves details of a specific Snapshot copy policy schedule.
Related ONTAP commands
-
snapshot policy show
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
snapshot_policy.uuid |
string |
path |
True |
Snapshot copy policy UUID |
schedule.uuid |
string |
path |
True |
Snapshot copy policy schedule ID |
fields |
array[string] |
query |
False |
Specify the fields to return. |
Response
Status: 200, Ok| Name | Type | Description |
|---|---|---|
_links |
||
count |
integer |
The number of Snapshot copies to maintain for this schedule. |
prefix |
string |
The prefix to use while creating Snapshot copies at regular intervals. |
schedule |
||
snapmirror_label |
string |
Label for SnapMirror operations |
snapshot_policy |
This is a reference to the Snapshot copy policy. |
Example response
{
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"prefix": "string",
"schedule": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "weekly",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
},
"snapmirror_label": "string",
"snapshot_policy": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "default",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
}
}Error
Status: Default, Error| Name | Type | Description |
|---|---|---|
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 |
|---|---|---|
self |
schedule
| Name | Type | Description |
|---|---|---|
_links |
||
name |
string |
Job schedule name |
uuid |
string |
Job schedule UUID |
snapshot_policy
This is a reference to the Snapshot copy policy.
| Name | Type | Description |
|---|---|---|
_links |
||
name |
string |
|
uuid |
string |
error_arguments
| Name | Type | Description |
|---|---|---|
code |
string |
Argument code |
message |
string |
Message argument |
error
| Name | Type | Description |
|---|---|---|
arguments |
array[error_arguments] |
Message arguments |
code |
string |
Error code |
message |
string |
Error message |
target |
string |
The target parameter that caused the error. |