使用管理 REST API 來關閉應用程式、REST API 及整合服務

您可以使用 IBM® App Connect Enterprise 管理 REST API 來關閉部署在整合伺服器上的具名應用程式、REST API 及整合服務。 要關閉的應用程式、REST API 或整合服務必須已部署在整合伺服器上。

開始之前

請閱讀下列主題:

關於此作業

關閉的動作會終止與應用程式、REST API 或整合服務相關聯的所有連線和執行緒。 應用程式、REST API 或整合服務會保留在整合伺服器的執行時期映像檔中,並且可以使用啟動動作來重新啟動,而不需要重新部署。 無需停止並重新啟動整合伺服器,即可重新啟動應用程式、REST API 或整合服務。

在整合伺服器上關閉應用程式

程序

關閉應用程式。

  • 若為獨立整合伺服器:
    POST http://hostname:port/apiv2/applications/applicationName/teardown

    例如,若要關閉稱為 HTTPInputApplication的應用程式,請使用下列 curl 指令:

    curl -X POST http://hostname:port/apiv2/applications/HTTPInputApplication/teardown

    如果指令成功,則會傳回 HTTP 狀態碼 200。 未傳回任何回應訊息。

    若要驗證關閉要求是否成功,請使用 GET API 呼叫,如 使用管理 REST API 來顯示應用程式、REST API 及整合服務中所述。 在 API 呼叫中的深度查詢參數上指定值 2 ,以取得顯示要求是否成功的資訊。 例如,使用下列 curl 指令:
    curl -X GET http://hostname:port/apiv2/applications?depth=2
    如需針對此類 API 呼叫所傳回回應的範例,請參閱 檢查是否已在獨立整合伺服器上完成關閉動作
  • 對於由整合節點管理的整合伺服器:
    POST http://hostname:port/apiv2/servers/integrationServerName/applications/applicationName/teardown

    例如,若要關閉由整合節點管理且稱為 HTTPInputApplication 部署在整合伺服器 ACESERV1上的應用程式,請使用下列 curl 指令:

    curl -X POST http://hostname:port/apiv2/servers/ACESERV1/applications/HTTPInputApplication/teardown

    如果指令成功,則會傳回 HTTP 狀態碼 200。 未傳回任何回應訊息。

    若要驗證關閉要求是否成功,請使用 GET API 呼叫,如 使用管理 REST API 來顯示應用程式、REST API 及整合服務中所述。 在 API 呼叫中的深度查詢參數上指定值 2 ,以取得顯示要求是否成功的資訊。 例如,使用下列 curl 指令:
    curl -X GET http://hostname:port/apiv2servers/ACESERV1/applications?depth=2
    如需針對這類 API 呼叫所傳回的回應範例,請參閱 檢查是否已在整合節點所管理的整合伺服器上完成關閉動作

在整合伺服器上關閉 REST API

程序

關閉 REST API。

  • 若為獨立整合伺服器:
    POST http://hostname:port/apiv2/rest-apis/rest-apiName/teardown

    如果指令成功,則會傳回 HTTP 狀態碼 200。 未傳回任何回應訊息。

    若要驗證關閉要求是否成功,請使用 GET API 呼叫,如 使用管理 REST API 來顯示應用程式、REST API 及整合服務中所述。 在 API 呼叫中的深度查詢參數上指定值 2 ,以取得顯示要求是否成功的資訊。

  • 對於由整合節點管理的整合伺服器:
    POST http://hostname:port/apiv2/servers/integrationServerName/rest-apis/rest-apiName/teardown

    如果指令成功,則會傳回 HTTP 狀態碼 200。 未傳回任何回應訊息。

    若要驗證關閉要求是否成功,請使用 GET API 呼叫,如 使用管理 REST API 來顯示應用程式、REST API 及整合服務中所述。 在 API 呼叫中的深度查詢參數上指定值 2 ,以取得顯示要求是否成功的資訊。

關閉整合伺服器上的整合服務

程序

關閉整合服務。

  • 若為獨立整合伺服器:
    POST http://hostname:port/apiv2/services/integrationServiceName/teardown

    如果指令成功,則會傳回 HTTP 狀態碼 200。 未傳回任何回應訊息。

    若要驗證關閉要求是否成功,請使用 GET API 呼叫,如 使用管理 REST API 來顯示應用程式、REST API 及整合服務中所述。 在 API 呼叫中的深度查詢參數上指定值 2 ,以取得顯示要求是否成功的資訊。

  • 對於由整合節點管理的整合伺服器:
    POST http://hostname:port/apiv2/servers/integrationServerName/services/integrationServiceName/teardown

    如果指令成功,則會傳回 HTTP 狀態碼 200。 未傳回任何回應訊息。

    若要驗證關閉要求是否成功,請使用 GET API 呼叫,如 使用管理 REST API 來顯示應用程式、REST API 及整合服務中所述。 在 API 呼叫中的深度查詢參數上指定值 2 ,以取得顯示要求是否成功的資訊。
    curl -X GET http://hostname:port/apiv2/servers/integrationServerName/services?depth=2