Browse code
Add doc for inspect swarm
Signed-off-by: Eivin Giske Skaaren <eivin@sysmystic.com>
Eivin Giske Skaaren authored on 2016/08/16 18:28:13Showing 2 changed files
| ... | ... |
@@ -4085,6 +4085,54 @@ JSON Parameters: |
| 4085 | 4085 |
|
| 4086 | 4086 |
## 3.8 Swarm |
| 4087 | 4087 |
|
| 4088 |
+### Inspect swarm |
|
| 4089 |
+ |
|
| 4090 |
+ |
|
| 4091 |
+`GET /swarm` |
|
| 4092 |
+ |
|
| 4093 |
+Inspect swarm |
|
| 4094 |
+ |
|
| 4095 |
+**Example response**: |
|
| 4096 |
+ |
|
| 4097 |
+ HTTP/1.1 200 OK |
|
| 4098 |
+ Content-Type: application/json |
|
| 4099 |
+ |
|
| 4100 |
+ {
|
|
| 4101 |
+ "CreatedAt" : "2016-08-15T16:00:20.349727406Z", |
|
| 4102 |
+ "Spec" : {
|
|
| 4103 |
+ "Dispatcher" : {
|
|
| 4104 |
+ "HeartbeatPeriod" : 5000000000 |
|
| 4105 |
+ }, |
|
| 4106 |
+ "Orchestration" : {
|
|
| 4107 |
+ "TaskHistoryRetentionLimit" : 10 |
|
| 4108 |
+ }, |
|
| 4109 |
+ "CAConfig" : {
|
|
| 4110 |
+ "NodeCertExpiry" : 7776000000000000 |
|
| 4111 |
+ }, |
|
| 4112 |
+ "Raft" : {
|
|
| 4113 |
+ "LogEntriesForSlowFollowers" : 500, |
|
| 4114 |
+ "HeartbeatTick" : 1, |
|
| 4115 |
+ "SnapshotInterval" : 10000, |
|
| 4116 |
+ "ElectionTick" : 3 |
|
| 4117 |
+ }, |
|
| 4118 |
+ "TaskDefaults" : {},
|
|
| 4119 |
+ "Name" : "default" |
|
| 4120 |
+ }, |
|
| 4121 |
+ "JoinTokens" : {
|
|
| 4122 |
+ "Worker" : "SWMTKN-1-1h8aps2yszaiqmz2l3oc5392pgk8e49qhx2aj3nyv0ui0hez2a-6qmn92w6bu3jdvnglku58u11a", |
|
| 4123 |
+ "Manager" : "SWMTKN-1-1h8aps2yszaiqmz2l3oc5392pgk8e49qhx2aj3nyv0ui0hez2a-8llk83c4wm9lwioey2s316r9l" |
|
| 4124 |
+ }, |
|
| 4125 |
+ "ID" : "70ilmkj2f6sp2137c753w2nmt", |
|
| 4126 |
+ "UpdatedAt" : "2016-08-15T16:32:09.623207604Z", |
|
| 4127 |
+ "Version" : {
|
|
| 4128 |
+ "Index" : 51 |
|
| 4129 |
+ } |
|
| 4130 |
+ } |
|
| 4131 |
+ |
|
| 4132 |
+**Status codes**: |
|
| 4133 |
+ |
|
| 4134 |
+- **200** - no error |
|
| 4135 |
+ |
|
| 4088 | 4136 |
### Initialize a new swarm |
| 4089 | 4137 |
|
| 4090 | 4138 |
|
| ... | ... |
@@ -4109,6 +4109,54 @@ JSON Parameters: |
| 4109 | 4109 |
|
| 4110 | 4110 |
## 3.8 Swarm |
| 4111 | 4111 |
|
| 4112 |
+### Inspect swarm |
|
| 4113 |
+ |
|
| 4114 |
+ |
|
| 4115 |
+`GET /swarm` |
|
| 4116 |
+ |
|
| 4117 |
+Inspect swarm |
|
| 4118 |
+ |
|
| 4119 |
+**Example response**: |
|
| 4120 |
+ |
|
| 4121 |
+ HTTP/1.1 200 OK |
|
| 4122 |
+ Content-Type: application/json |
|
| 4123 |
+ |
|
| 4124 |
+ {
|
|
| 4125 |
+ "CreatedAt" : "2016-08-15T16:00:20.349727406Z", |
|
| 4126 |
+ "Spec" : {
|
|
| 4127 |
+ "Dispatcher" : {
|
|
| 4128 |
+ "HeartbeatPeriod" : 5000000000 |
|
| 4129 |
+ }, |
|
| 4130 |
+ "Orchestration" : {
|
|
| 4131 |
+ "TaskHistoryRetentionLimit" : 10 |
|
| 4132 |
+ }, |
|
| 4133 |
+ "CAConfig" : {
|
|
| 4134 |
+ "NodeCertExpiry" : 7776000000000000 |
|
| 4135 |
+ }, |
|
| 4136 |
+ "Raft" : {
|
|
| 4137 |
+ "LogEntriesForSlowFollowers" : 500, |
|
| 4138 |
+ "HeartbeatTick" : 1, |
|
| 4139 |
+ "SnapshotInterval" : 10000, |
|
| 4140 |
+ "ElectionTick" : 3 |
|
| 4141 |
+ }, |
|
| 4142 |
+ "TaskDefaults" : {},
|
|
| 4143 |
+ "Name" : "default" |
|
| 4144 |
+ }, |
|
| 4145 |
+ "JoinTokens" : {
|
|
| 4146 |
+ "Worker" : "SWMTKN-1-1h8aps2yszaiqmz2l3oc5392pgk8e49qhx2aj3nyv0ui0hez2a-6qmn92w6bu3jdvnglku58u11a", |
|
| 4147 |
+ "Manager" : "SWMTKN-1-1h8aps2yszaiqmz2l3oc5392pgk8e49qhx2aj3nyv0ui0hez2a-8llk83c4wm9lwioey2s316r9l" |
|
| 4148 |
+ }, |
|
| 4149 |
+ "ID" : "70ilmkj2f6sp2137c753w2nmt", |
|
| 4150 |
+ "UpdatedAt" : "2016-08-15T16:32:09.623207604Z", |
|
| 4151 |
+ "Version" : {
|
|
| 4152 |
+ "Index" : 51 |
|
| 4153 |
+ } |
|
| 4154 |
+ } |
|
| 4155 |
+ |
|
| 4156 |
+**Status codes**: |
|
| 4157 |
+ |
|
| 4158 |
+- **200** - no error |
|
| 4159 |
+ |
|
| 4112 | 4160 |
### Initialize a new swarm |
| 4113 | 4161 |
|
| 4114 | 4162 |
|