IBM Security Key Lifecycle Manager, Version 3.0.1

Replication Start REST Service

Use Replication Start REST Service to start the replication server for replicating the current IBM Security Key Lifecycle Manager active files on clone servers based on a configured schedule.

Note: IBM Security Key Lifecycle Manager data is replicated based on a configured schedule only when new cryptographic objects are added to the master server.

Operation: POST
URL: https://<host>:<port>/SKLM/rest/v1/replicate/start

依預設，IBM Security Key Lifecycle Manager 伺服器會接聽非安全埠 80 (HTTP) 及安全埠 443 (HTTPS) 以進行通訊。在 IBM Security Key Lifecycle Manager 安裝期間，您可以修改這些預設埠。如果您要使用 HTTP 或 HTTPS 的預設埠，則該埠是 URL 的選用部分。

Request

要求參數

參數	說明
host	指定 IBM Security Key Lifecycle Manager 伺服器的 IP 位址或主機名稱。
port	指定 IBM Security Key Lifecycle Manager 伺服器在其上接聽要求的埠號。

要求標頭

標頭名稱	值
Content-Type	`application/json`
Accept	`application/json`
Authorization	`SKLMAuth userAuthId=<authIdValue>`
Accept-Language	IBM Security Key Lifecycle Manager 支援的任何有效語言環境。例如：`en` 或 `de`

Response

回應標頭

標頭名稱	值和說明
狀態碼	200 正常要求成功。回應主體包含所要求的表示法。 400 不當要求未以正確格式提供鑑別資訊。 401 未獲授權鑑別認證遺漏或不正確。 500 內部伺服器錯誤由於伺服器上的非預期狀況而導致要求處理失敗。
Content-Type	`application/json`
Content-Language	回應訊息的語言環境。

Success response body

JSON object with the following specification:

JSON property name	Description
code	Returns the value that is specified by the message property.
message	Returns the status message that indicates the success or failure of the replication task: `CTGKM2207W` `IBM Security Key Lifecycle Manager replication task is already up.` `CTGKM2205I` `IBM Security Key Lifecycle Manager replication task started successfully.` `CTGKM2206E` `IBM Security Key Lifecycle Manager replication task failed to start.`

錯誤回應主體

具有下列規格的 JSON 物件。

JSON 內容名稱	說明
code	傳回應用程式錯誤碼。
message	傳回說明錯誤的訊息。

Examples

Service request to start the replication task

POST https://localhost:<port>/SKLM/rest/v1/replicate/start
Content-Type: application/json
Accept: application/json
Authorization: SKLMAuth userAuthId=139aeh34567m

Success response

Status Code : 200 OK
{"code": "CTGKM2205I","message": "CTGKM2205I IBM Security Key 
Lifecycle Manager replication task started successfully."}}

Service request to start the replication task without specifying the configuration file

POST https://localhost:<port>/SKLM/rest/v1/replicate/start
Content-Type: application/json
Accept : application/json
Authorization: SKLMAuth userAuthId=139aeh34567m

Error response

Status Code : 200 OK
{"code": "CTGKM2222E","message": "CTGKM2222E No valid replication 
config file exists."}

Feedback