本參考主題提供有關用於以下方面的 API 的資訊:登錄 NSX 分散式惡意程式碼防護服務、擷取 NSX 分散式惡意程式碼防護服務的部署規格,以及刪除現有 NSX 分散式惡意程式碼防護服務定義的部署規格。
登錄 NSX 分散式惡意程式碼防護服務
使用 POST API 來登錄 NSX 分散式惡意程式碼防護服務。如果已登錄 NSX 分散式惡意程式碼防護服務,則此 API 會將新的部署規格新增至現有的服務定義中。
在服務登錄期間,此 API 會在內部建立 NSX 分散式惡意程式碼防護服務的服務定義。
- API 要求
-
方法:POST
URI 路徑:napp/api/v1/malware-prevention/svm-spec
要求標頭:不適用
查詢參數:不適用
名稱 | 說明 | 類型 | 備註 |
---|---|---|---|
deployment_spec_name | 部署規格的名稱。服務定義可以包含多個部署規格。每個部署規格的名稱必須是唯一的。 |
字串 |
必要 |
ovf_url | Web 伺服器上 OVF 檔案的完整路徑。 |
字串 |
必要 |
svm_version | 服務虛擬機器的版本號碼。 | 字串 |
必要 |
- 範例要求
-
POST https://{nsx-manager-ip}/napp/api/v1/malware-prevention/svm-spec { "ovf_url" : "http://{webserver-ip}/{path-to-ovf-file}/{filename}.ovf", "deployment_spec_name" : "MPS_Distributed_1", "svm_version" : "3.2" }
- 範例回應 #1
-
使用 POST API 登錄
NSX 分散式惡意程式碼防護服務時的範例回應。
{ "service_id": "5cd8d584-553e-4495-a112-04cdcf44064c", "display_name": "VMWare NSX Distributed Malware Prevention Service", "deployment_specs": { "_links": [], "results": [ { "ovf_url": "http://{webserver-ip}/{path-to-ovf-file}/{filename}.ovf", "deployment_spec_name": "MPS_Distributed_1", "svm_version": "3.2" } ] } } }
- 範例回應 #2
-
使用 POST API 將新的服務部署規格新增至現有服務定義時的範例回應。在這種情況下,回應將列出服務定義的所有部署規格。
例如,如果您想要在每個 ESXi 主機叢集的服務部署中升級 NSX 惡意程式碼防護 SVM,請執行此 POST API,將新的服務部署規格新增至現有的服務定義中。
{ "service_id": "5cd8d584-553e-4495-a112-04cdcf44064c", "display_name": "VMWare NSX Distributed Malware Prevention Service", "deployment_specs": { "_links": [], "results": [ { "ovf_url": "http://{webserver-ip}/{path-to-ovf-file}/{filename2}.ovf", "deployment_spec_name": "MPS_Distributed_2", "svm_version": "3.3" }, { "ovf_url": "http://{webserver-ip}/{path-to-ovf-file}/{filename1}.ovf", "deployment_spec_name": "MPS_Distributed_1", "svm_version": "3.2" } ] } }
擷取 NSX 分散式惡意程式碼防護服務部署規格
使用 GET API 擷取 NSX 分散式惡意程式碼防護服務的服務部署規格。
- 範例回應
-
{ "service_id": "5cd8d584-553e-4495-a112-04cdcf44064c", "display_name": "VMWare NSX Distributed Malware Prevention Service", "deployment_specs": { "_links": [], "results": [ { "ovf_url": "http://{webserver-ip}/{path-to-ovf-file}/{filename}.ovf", "deployment_spec_name": "MPS_Distributed_1", "svm_version": "3.2" } ] } } }
刪除 NSX 分散式惡意程式碼防護服務部署規格
僅在以下情況下使用 DELETE API 刪除 NSX 分散式惡意程式碼防護服務部署規格:您為服務定義新增了多個部署規格,且其中一個部署規格不再有效或者使用於任何服務部署中。
注意: 在以下情況下,請勿使用 DELETE API:
- NSX 分散式惡意程式碼防護服務定義只有一個部署規格。
- 部署規格使用於任何服務部署中。
在這兩種情況下,DELETE API 會失敗。