These docs are for Rancher 1.6, if you are looking for Rancher 2.x docs, see
here.
instance
Resource Fields
Writeable Fields
| Field |
Type |
Create |
Update |
Default |
Notes |
| description |
string |
Optional |
Yes |
- |
|
| name |
string |
Optional |
Yes |
- |
|
Read Only Fields
| Field |
Type |
Notes |
| accountId |
account |
The unique identifier for the associated account |
| created |
date |
The date of when the instance was created. |
| externalId |
string |
|
| hostId |
host |
The unique identifier for the associated host |
| id |
int |
The unique identifier for the instance |
| kind |
string |
|
| removed |
date |
The date of when the instance was removed |
| state |
enum |
The current state of the instance. The options are creating, error, erroring, migrating, purged, purging, removed, removing, requested, restarting, restoring, running, starting, stopped, stopping, updating-running, updating-stopped. |
| transitioning |
enum |
Whether or not the instance is in a transitioning state |
| transitioningMessage |
string |
The message to show while in a transitioning state |
| transitioningProgress |
int |
The percentage remaining in the transitioning process of the instance |
| uuid |
string |
The universally unique identifier for the instance. This will always be unique across Rancher installations. |