本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。
DescribeDevice
檢查裝置特定資訊，例如裝置類型、軟體版本、IP 位址和鎖定狀態。
請求語法
POST /managed-device/managedDeviceId/describe HTTP/1.1
URI 請求參數
請求會使用下列 URI 參數。
- managedDeviceId
-
您要檢查資訊之裝置的 ID。
長度限制：長度下限為 1。長度上限為 64。
必要：是
請求主體
請求沒有請求主體。
回應語法
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"
}
}回應元素
如果動作成功，則服務傳回 HTTP 200 回應。
服務會傳回下列 JSON 格式的資料。
- associatedWithJob
-
訂購裝置時使用的工作 ID。
類型：字串
- deviceCapacities
-
裝置的硬體規格。
類型：Capacity 物件陣列
陣列成員：項目數下限為 0。項目數上限為 100。
- deviceState
-
裝置的目前狀態。
類型：字串
有效值:
UNLOCKED | LOCKED | UNLOCKING - deviceType
-
AWS 雪系列裝置的類型。
類型：字串
- lastReachedOutAt
-
當設備最後一次聯繫 AWS 雲端. 表示裝置處於連線狀態。
類型：Timestamp
- lastUpdatedAt
-
裝置上次將更新推送至 AWS 雲端. 指出重新整理裝置快取的時間。
類型：Timestamp
- managedDeviceArn
-
設備的 Amazon 資源名稱（ARN）。
類型：字串
- managedDeviceId
-
您檢查資訊的裝置 ID。
類型：字串
長度限制：長度下限為 1。長度上限為 64。
- physicalNetworkInterfaces
-
裝置上可用的網路介面。
類型：PhysicalNetworkInterface 物件陣列
- software
-
裝置上安裝的軟體。
類型：SoftwareInformation 物件
-
您指派給資源的選用中繼資料。您可以使用標籤以不同的方式對資源進行分類，例如依目的、擁有者或環境。
類型：字串到字串映射
錯誤
如需所有動作常見錯誤的資訊，請參閱常見錯誤。
- AccessDeniedException
-
您沒有足夠的存取權限來執行此動作。
HTTP 狀態碼：403
- InternalServerException
-
處理要求時發生未預期的錯誤。
HTTP 狀態碼：500
- ResourceNotFoundException
-
請求引用不存在的資源。
HTTP 狀態碼：404
- ThrottlingException
-
由於請求調節，因此請求遭到拒絕。
HTTP 狀態碼：429
- ValidationException
-
輸入無法滿足 AWS 服務指定的條件約束。
HTTP 狀態碼：400
另請參閱
如需在其中一個特定語言 AWS SDK 中使用此 API 的詳細資訊，請參閱下列內容：
