StopServer - AWS Transfer Family

本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。

StopServer

將啟用檔案傳輸通訊協定之伺服器的狀態從 ONLINE變更為 OFFLINEOFFLINE 伺服器無法接受和處理檔案傳輸任務。與伺服器綁定的資訊,例如伺服器和使用者屬性,不受停止伺服器的影響。

注意

停止伺服器不會減少或影響您的檔案傳輸通訊協定端點計費;您必須刪除伺服器才能停止計費。

狀態 STOPPING表示伺服器處於中繼狀態,可能是無法完全回應,或並非完全離線。的值STOP_FAILED可以指示錯誤條件。

此呼叫不會傳回任何回應。

請求語法

{ "ServerId": "string" }

請求參數

如需所有動作的一般參數資訊,請參閱《Common Parameters》。

請求接受下列JSON格式的資料。

ServerId

您停止之伺服器的系統指派唯一識別碼。

類型:字串

長度限制條件:固定長度為 19。

模式:s-([0-9a-f]{17})

必要:是

回應元素

如果動作成功,服務會傳回 200 HTTP 回應,其中內HTTP文為空白。

錯誤

如需所有動作常見錯誤的資訊,請參閱常見錯誤

InternalServiceError

當 AWS Transfer Family 服務發生錯誤時,就會擲回此例外狀況。

HTTP 狀態碼:500

InvalidRequestException

當用戶端提交格式錯誤的請求時,就會擲回此例外狀況。

HTTP 狀態碼:400

ResourceNotFoundException

當 AWS Transfer Family 服務找不到資源時,就會擲回此例外狀況。

HTTP 狀態碼:400

ServiceUnavailableException

請求失敗,因為 AWS Transfer Family 服務無法使用。

HTTP 狀態碼:500

ThrottlingException

由於請求調節,因此請求遭到拒絕。

HTTP 狀態碼:400

範例

範例

下列範例會停止伺服器。

請求範例

{ "ServerId": "s-01234567890abcdef" }

範例

這是此API呼叫的範例回應。

回應範例

{ "ServerId": "s-01234567890abcdef" }

另請參閱

如需在其中一種語言特定 API中使用此功能的詳細資訊 AWS SDKs,請參閱下列內容: