Parameters
#poolstringRequired
Pool name or ID.
snapshotstringRequired
Snapshot name or ID.
organizationstring
Organization name or ID. A credential, named resource or sole membership can select the organization for you.
Returns
#dataobjectAlways present
A pool snapshot change and its per-Computer operations.
Show 5 attributesHide attributes
deleted_sinceobject[]
Computers deleted since capture, which cannot be restored in place. Computers created since capture are unchanged. May be omitted.
Show 1 attributeHide attributes
itemsobject
A Computer, pool or snapshot reference.
Show 2 attributesHide attributes
idstringAlways present
Referenced object's stable ID.
namestringAlways present
Referenced object's name.
operationobjectAlways present
Group tracking the Computer operations.
Show 10 attributesHide attributes
completed_atstring (date-time)
When the group finished. Absent while unfinished. May be omitted.
created_atstring (date-time)Always present
When the grouped change was accepted.
idstringAlways present
Group ID for
operation view.kindstringAlways present
Grouped change.
messagestring
An explanation of the group's progress or failure. May be omitted.
operationsobject[] | nullAlways present
Member Computer operations.
Show 1 attributeHide attributes
itemsobject
An accepted change to one Computer. Work continues after the request disconnects.
Show 9 attributesHide attributes
bystring
Requester's email address, or user ID if no email is recorded. Omitted for your own requests. May be omitted.
completed_atstring (date-time)
When the operation reached its final state. Absent while unfinished. May be omitted.
computer_idstringAlways present
Computer's stable ID.
created_atstring (date-time)
When Heaven accepted the change. May be omitted.
error_codestring
Recorded failure code. May be omitted.
idstringAlways present
Operation ID for
operation view.kindstringAlways present
Change being tracked.
messagestring
An explanation of the recorded failure and any next action. May be omitted.
statestringAlways present
accepted means saved and unfinished. complete means the change finished. failed means it could not finish. superseded means a newer change replaced it before completion. Values: "accepted", "complete", "failed", "superseded".pool_idstring
Pool this change concerns. May be omitted.
statestringAlways present
accepted while work remains, complete when all work succeeds, or failed when a step fails or a member operation fails or is superseded. Values: "accepted", "complete", "failed", "superseded".stepsobject[]
Other steps, in execution order. May be omitted.
Show 1 attributeHide attributes
itemsobject
A step in a grouped change outside its Computer operations.
Show 5 attributesHide attributes
kindstringAlways present
Action taken by this step.
messagestring
Progress or failure details for this step. May be omitted.
pool_idstring
Affected pool's ID. May be omitted.
statestringAlways present
Step's recorded progress or outcome.
subjectstring
Affected object, such as an organization being left. May be omitted.
subjectstring
Other object the change concerns, such as a pool snapshot's name. May be omitted.
pool_snapshotobjectAlways present
Pool snapshot being changed.
Show 3 attributesHide attributes
idstringAlways present
Pool snapshot's ID.
namestringAlways present
Pool snapshot's name.
poolobjectAlways present
Pool's ID and name.
Show 2 attributesHide attributes
idstringAlways present
Referenced object's stable ID.
namestringAlways present
Referenced object's name.
request_idstringAlways present
Request ID for this pool snapshot change.
resultsobject[] | nullAlways present
Each Computer's operation or refusal.
Show 1 attributeHide attributes
itemsobject
One Computer's part of a pool snapshot change.
Show 4 attributesHide attributes
computerobjectAlways present
Computer whose disk is affected.
Show 2 attributesHide attributes
idstringAlways present
Referenced object's stable ID.
namestringAlways present
Referenced object's name.
errorobject
Why this Computer's part was refused. May be omitted.
Show 7 attributesHide attributes
actionobject
A suggested command addressing the problem. May be omitted.
Show 2 attributesHide attributes
commandstringAlways present
Command's catalog name.
linestringAlways present
Complete suggested command line.
kindstringAlways present
Error category.
unknown means the effect is uncertain; reconcile before retrying.messagestringAlways present
What happened and any action needed from you.
operation_idstring
Operation to read before repeating uncertain work. May be omitted.
request_idstring
Request ID identifying the change during reconciliation. May be omitted.
retry_afterinteger
Seconds before retrying a rate-limited request or a refused wait. May be omitted.
urlstring
Payment page for a payment-required response. May be omitted.
operationobject
Accepted operation for this Computer. May be omitted.
Show 9 attributesHide attributes
bystring
Requester's email address, or user ID if no email is recorded. Omitted for your own requests. May be omitted.
completed_atstring (date-time)
When the operation reached its final state. Absent while unfinished. May be omitted.
computer_idstringAlways present
Computer's stable ID.
created_atstring (date-time)
When Heaven accepted the change. May be omitted.
error_codestring
Recorded failure code. May be omitted.
idstringAlways present
Operation ID for
operation view.kindstringAlways present
Change being tracked.
messagestring
An explanation of the recorded failure and any next action. May be omitted.
statestringAlways present
accepted means saved and unfinished. complete means the change finished. failed means it could not finish. superseded means a newer change replaced it before completion. Values: "accepted", "complete", "failed", "superseded".snapshotobject
Its individual snapshot, when one is associated with the result. May be omitted.
Show 2 attributesHide attributes
idstringAlways present
Referenced object's stable ID.
namestringAlways present
Referenced object's name.
Errors
#| Code | Status | What happened |
|---|---|---|
| invalid | 400 | An input is missing or invalid. |
| unauthenticated | 401 | The credential is missing, invalid, expired or revoked. |
| denied | 403 | The caller lacks permission for this action. |
| not_found | 404 | The resource is absent or inaccessible to this caller. |
| conflict | 409 | The request conflicts with the current resource state or an earlier request. |
| over_capacity | 409 | The request exceeds a resource or credential allowance. |
| access_list_full | 409 | The change would exceed the access-list allowance. |
| payment_required | 402 | Payment or credit is required. |
| rate_limited | 429 | The caller's request rate exceeds its limit. |
| busy | 429 | Too much work is in progress to accept this request. |
| unknown | 503 | The outcome is unconfirmed; a change may have happened. |
| unavailable | 503 | The service or requested feature is unavailable. |
Notes
#- API key permission:
pool snapshot delete.