

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

# CloseServers
<a name="CloseServers"></a>

關閉一或多個 Amazon DCV 伺服器。關閉 Amazon DCV 伺服器時，您會讓它無法用於 Amazon DCV 工作階段放置。您無法在*已關閉*的伺服器上建立 Amazon DCV 工作階段。關閉伺服器可確保其中沒有任何工作階段正在執行，且使用者無法在其中建立新的工作階段。

**Topics**
+ [請求參數](#request)
+ [回應參數](#response)
+ [範例](#example)

## 請求參數
<a name="request"></a>

**`ServerId`**  
要關閉的伺服器 ID。  
類型：字串  
必要：是

**`Force`**  
強制關閉操作。如果您指定 `true`，即使伺服器有執行中的工作階段，也會關閉。工作階段會繼續執行。  
類型：布林值  
必要：否

## 回應參數
<a name="response"></a>

**`RequestId`**  
請求的唯一 ID。

**`SuccessfulList`**  
有關已成功關閉的 Amazon DCV 伺服器的資訊。此資料結構包含下列巢狀回應參數：    
**`ServerId`**  
已成功關閉的伺服器 ID。

**`UnsuccessfulList`**  
無法關閉的 Amazon DCV 伺服器相關資訊。此資料結構包含下列巢狀回應參數：    
**`CloseServerRequestData`**  
失敗的原始請求的相關資訊。此資料結構包含下列巢狀回應參數：    
**`ServerId`**  
無法關閉的 Amazon DCV 伺服器 ID。  
**`Force`**  
請求的力參數。  
**`FailureCode`**  
失敗的程式碼。  
**`FailureReason`**  
失敗的原因。

## 範例
<a name="example"></a>

------
#### [ Python ]

**請求**  
下列範例會關閉兩個 Amazon DCV 伺服器 (`serverId1` 和 `serverId2`)。伺服器`serverId2`不存在，並導致失敗。

```
from swagger_client.models import CloseServerRequestData

def get_servers_api():
    api_instance = swagger_client.ServersApi(swagger_client.ApiClient(get_client_configuration()))
    set_request_headers(api_instance.api_client)
    return api_instance

def close_servers(server_ids):
    request = [CloseServerRequestData(server_id=server_id) for server_id in server_ids]
    print('Close Servers Request:', request)
    api_instance = get_servers_api()
    api_response = api_instance.close_servers(body=request)
    print('Close Servers Response:', api_response)
    open_servers(server_ids)

def main():
    close_servers(["serverId1", "serverId2"])
```

**回應**  
以下是範例輸出。

```
{
    "RequestId": "4d7839b2-a03c-4b34-a40d-06c8b21099e6",
    "SuccessfulList": [
        {
            "ServerId": "serverId1"
        }
    ],
    "UnsuccessfulList": [
        {
            "OpenServerRequestData": {
                "ServerId": "serverId2"
            },
            "FailureCode": "DCV_SERVER_NOT_FOUND",
            "FailureReason": "Dcv server not found."
        }
    ]
}
```

------