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

# DescribeDevice
<a name="API_devicemanagement_DescribeDevice"></a>

檢查裝置特定資訊，例如裝置類型、軟體版本、IP 地址和鎖定狀態。

## 請求語法
<a name="API_devicemanagement_DescribeDevice_RequestSyntax"></a>

```
POST /managed-device/managedDeviceId/describe HTTP/1.1
```

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

請求會使用下列 URI 參數。

 ** [managedDeviceId](#API_devicemanagement_DescribeDevice_RequestSyntax) **   <a name="Snowball-devicemanagement_DescribeDevice-request-uri-managedDeviceId"></a>
您正在檢查資訊之裝置的 ID。  
長度限制：長度下限為 1。長度上限為 64。  
必要：是

## 請求主體
<a name="API_devicemanagement_DescribeDevice_RequestBody"></a>

請求沒有請求主體。

## 回應語法
<a name="API_devicemanagement_DescribeDevice_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "associatedWithJob": "string",
   "deviceCapacities": [ 
      { 
         "available": number,
         "name": "string",
         "total": number,
         "unit": "string",
         "used": number
      }
   ],
   "deviceState": "string",
   "deviceType": "string",
   "lastReachedOutAt": number,
   "lastUpdatedAt": number,
   "managedDeviceArn": "string",
   "managedDeviceId": "string",
   "physicalNetworkInterfaces": [ 
      { 
         "defaultGateway": "string",
         "ipAddress": "string",
         "ipAddressAssignment": "string",
         "macAddress": "string",
         "netmask": "string",
         "physicalConnectorType": "string",
         "physicalNetworkInterfaceId": "string"
      }
   ],
   "software": { 
      "installedVersion": "string",
      "installingVersion": "string",
      "installState": "string"
   },
   "tags": { 
      "string" : "string" 
   }
}
```

## 回應元素
<a name="API_devicemanagement_DescribeDevice_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [associatedWithJob](#API_devicemanagement_DescribeDevice_ResponseSyntax) **   <a name="Snowball-devicemanagement_DescribeDevice-response-associatedWithJob"></a>
訂購裝置時所使用的任務 ID。  
類型：字串

 ** [deviceCapacities](#API_devicemanagement_DescribeDevice_ResponseSyntax) **   <a name="Snowball-devicemanagement_DescribeDevice-response-deviceCapacities"></a>
裝置硬體規格。  
類型：[Capacity](API_devicemanagement_Capacity.md) 物件陣列  
陣列成員：項目數下限為 0。項目數上限為 100。

 ** [deviceState](#API_devicemanagement_DescribeDevice_ResponseSyntax) **   <a name="Snowball-devicemanagement_DescribeDevice-response-deviceState"></a>
裝置目前的狀態。  
類型：字串  
有效值:`UNLOCKED | LOCKED | UNLOCKING` 

 ** [deviceType](#API_devicemanagement_DescribeDevice_ResponseSyntax) **   <a name="Snowball-devicemanagement_DescribeDevice-response-deviceType"></a>
 AWS Snow Family 裝置的類型。  
類型：字串

 ** [lastReachedOutAt](#API_devicemanagement_DescribeDevice_ResponseSyntax) **   <a name="Snowball-devicemanagement_DescribeDevice-response-lastReachedOutAt"></a>
當裝置上次聯絡 時 AWS 雲端。表示裝置已上線。  
類型：Timestamp

 ** [lastUpdatedAt](#API_devicemanagement_DescribeDevice_ResponseSyntax) **   <a name="Snowball-devicemanagement_DescribeDevice-response-lastUpdatedAt"></a>
當裝置上次推送更新至 時 AWS 雲端。指出裝置快取重新整理的時間。  
類型：Timestamp

 ** [managedDeviceArn](#API_devicemanagement_DescribeDevice_ResponseSyntax) **   <a name="Snowball-devicemanagement_DescribeDevice-response-managedDeviceArn"></a>
裝置的 Amazon Resource Name (ARN)。  
類型：字串

 ** [managedDeviceId](#API_devicemanagement_DescribeDevice_ResponseSyntax) **   <a name="Snowball-devicemanagement_DescribeDevice-response-managedDeviceId"></a>
您檢查資訊之裝置的 ID。  
類型：字串  
長度限制：長度下限為 1。長度上限為 64。

 ** [physicalNetworkInterfaces](#API_devicemanagement_DescribeDevice_ResponseSyntax) **   <a name="Snowball-devicemanagement_DescribeDevice-response-physicalNetworkInterfaces"></a>
裝置上可用的網路介面。  
類型：[PhysicalNetworkInterface](API_devicemanagement_PhysicalNetworkInterface.md) 物件陣列

 ** [software](#API_devicemanagement_DescribeDevice_ResponseSyntax) **   <a name="Snowball-devicemanagement_DescribeDevice-response-software"></a>
安裝在裝置上的軟體。  
類型：[SoftwareInformation](API_devicemanagement_SoftwareInformation.md) 物件

 ** [tags](#API_devicemanagement_DescribeDevice_ResponseSyntax) **   <a name="Snowball-devicemanagement_DescribeDevice-response-tags"></a>
您指派給資源的選用中繼資料。您可以使用標籤以不同的方式分類資源，例如依用途、擁有者或環境。  
類型：字串到字串映射

## 錯誤
<a name="API_devicemanagement_DescribeDevice_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤類型](CommonErrors.md)。

 ** AccessDeniedException **   
您沒有足夠的存取權來執行此動作。  
HTTP 狀態碼：403

 ** InternalServerException **   
處理請求時發生非預期的錯誤。  
HTTP 狀態碼：500

 ** ResourceNotFoundException **   
請求會參考不存在的資源。  
HTTP 狀態碼：404

 ** ThrottlingException **   
由於請求調節，因此請求遭到拒絕。  
HTTP 狀態碼：429

 ** ValidationException **   
輸入無法滿足 AWS 服務指定的限制條件。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_devicemanagement_DescribeDevice_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/snow-device-management-2021-08-04/DescribeDevice) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/snow-device-management-2021-08-04/DescribeDevice) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/snow-device-management-2021-08-04/DescribeDevice) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/snow-device-management-2021-08-04/DescribeDevice) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/snow-device-management-2021-08-04/DescribeDevice) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/snow-device-management-2021-08-04/DescribeDevice) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/snow-device-management-2021-08-04/DescribeDevice) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/snow-device-management-2021-08-04/DescribeDevice) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/snow-device-management-2021-08-04/DescribeDevice) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/snow-device-management-2021-08-04/DescribeDevice)