

本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

# 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>
Sno AWS w Family 设备的类型。  
类型：字符串

 ** [lastReachedOutAt](#API_devicemanagement_DescribeDevice_ResponseSyntax) **   <a name="Snowball-devicemanagement_DescribeDevice-response-lastReachedOutAt"></a>
设备上次联系 AWS 云的时间。表示设备处于联机状态。  
类型：时间戳

 ** [lastUpdatedAt](#API_devicemanagement_DescribeDevice_ResponseSyntax) **   <a name="Snowball-devicemanagement_DescribeDevice-response-lastUpdatedAt"></a>
设备上次将更新推送到 AWS 云的时间。表示设备缓存何时刷新。  
类型：时间戳

 ** [managedDeviceArn](#API_devicemanagement_DescribeDevice_ResponseSyntax) **   <a name="Snowball-devicemanagement_DescribeDevice-response-managedDeviceArn"></a>
设备的 Amazon 资源名称（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>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/snow-device-management-2021-08-04/DescribeDevice) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/snow-device-management-2021-08-04/DescribeDevice) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/snow-device-management-2021-08-04/DescribeDevice) 
+  [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/snow-device-management-2021-08-04/DescribeDevice) 
+  [AWS Python 软件开发工具包](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) 