Harvester
Harvester では、以下のオプションがサポートされています。
nfa1000
Harvester では、以下のオプションがサポートされています。
すべての Harvester の読み取り
この API には、以下のすべての Harvester レコードが表示されます。
リソース
URI http://<nfa odata host>:<nfa odata port>/odata/api/harvesters
メソッド
GET
サンプル リクエスト
http://127.0.0.1:8981/odata/api/harvesters
サンプル レスポンス
{ "@odata.context": "$metadata#harvesters", "value": [ { "HarvesterId": 2, "LastPullCheckpoint": 1545212329, "PortDefinitionsLastDeployed": 0, "HarvesterAddress": "127.0.0.1", "DomainId": 3, "FlowEnabledLastModified": 0, "ManagementServerPort": 8080, "DomainName": "Domain A", "DomainDescription": "Domain A for FellsCargo", "FlowEnabledLastDeployed": 0, "LastPushCheckpoint": 1545212344, "ApplicationMappingLastDeployed": 0, "ReservedSeatingLastDeployed": 0, "TrapDefinitionsLastDeployed": 1541748300, "TenantId": 9, "Description": "Single box configuration" }, { "HarvesterId": 5, "LastPullCheckpoint": 0, "PortDefinitionsLastDeployed": 0, "HarvesterAddress": "127.0.0.1", "DomainId": 1, "FlowEnabledLastModified": 0, "ManagementServerPort": 8080, "DomainName": "Default Domain", "DomainDescription": "The default domain for devices, interfaces, interface addresses and networks.", "FlowEnabledLastDeployed": 0, "LastPushCheckpoint": 0, "ApplicationMappingLastDeployed": 0, "ReservedSeatingLastDeployed": 0, "TrapDefinitionsLastDeployed": 0, "TenantId": 8, "Description": "Test Harvesters2" },]}
単一の Harvester の読み取り
以下の API には、指定したすべての Harvester の詳細が表示されます。
リソース
URI http://<nfa odata host>:<nfa odata port>/odata/api/harvesters(HarvesterId=<Value of the harvester ID>)
メソッド
GET
サンプル リクエスト
http://127.0.0.1:8981/odata/api/harvesters(HarvesterId=2)
サンプル レスポンス
{ "@odata.context": "$metadata#harvesters", "HarvesterId": 2, "HarvesterAddress": "127.0.0.1", "Description": "Single box configuration", "ManagementServerPort": 8080, "FlowEnabledLastModified": 0, "FlowEnabledLastDeployed": 0, "LastPushCheckpoint": 1545212832, "LastPullCheckpoint": 1545212820, "ApplicationMappingLastDeployed": 0, "PortDefinitionsLastDeployed": 0, "ReservedSeatingLastDeployed": 0, "TrapDefinitionsLastDeployed": 1541748300, "DomainId": 3, "DomainName": "Domain A", "DomainDescription": "Domain A for FellsCargo", "TenantId": 9}
Harvester の追加
Harvester でない IP を追加または編集すると、タイムアウト エラーがレスポンスとして返されます。
リソース
URIhttp://<nfa odata host>:<nfa odata port>/odata/api/harvesters
メソッド
POST
ペイロード
{"HarvesterAddress": "<Enter the harvester address that you wish to add >","Description":"<Enter the Description>","DomainId":<Enter the Domain Id>}
サンプル リクエスト
http://127.0.0.1:8981/odata/api/harvesters
サンプル ペイロード
{"HarvesterAddress": "0.0.0.7","Description":"Testing Purpose","DomainId": 1}
サンプル レスポンス
{ "@odata.context": "$metadata#harvesters", "HarvesterId": 9, "HarvesterAddress": "0.0.0.7", "Description": "Testing Purpose", "ManagementServerPort": null, "FlowEnabledLastModified": null, "FlowEnabledLastDeployed": null, "LastPushCheckpoint": null, "LastPullCheckpoint": null, "ApplicationMappingLastDeployed": null, "PortDefinitionsLastDeployed": null, "ReservedSeatingLastDeployed": null, "TrapDefinitionsLastDeployed": null, "DomainId": 1, "DomainName": null, "DomainDescription": null, "TenantId": null}
Harvester の編集
Harvester では、一括編集オプションは使用できません。したがって、一度に 1 つの Harvester を編集する必要があります。
リソース
URIhttp://<nfa odata host>:<nfa odata port>/odata/api/harvesters(HarvesterId=<Value of the harvester ID>)
メソッド
PATCH
ペイロード
{"Description":"<Enter the Description>","DomainId":<Enter the Domain Id>}
サンプル リクエスト
http://127.0.0.1:8981/odata/api/harvesters(HarvesterId=33)
サンプル ペイロード
{"Description":"Single box configuration Modified","DomainId": 3}
サンプル レスポンス
この API に対するレスポンスはありません。
Harvester の削除
一度に 1 つの Harvester のみを削除できます。
要求 URI
http://<nfa odata host>:<nfa odata port>/odata/api/harvesters(HarvesterId=<Value of the harvester ID>)
メソッド
DELETE
サンプル リクエスト
http://127.0.0.1:8981/odata/api/harvesters(HarvesterId=33)
サンプル レスポンス
この API に対するレスポンスはありません。