DescribeDevice - AWS Snowball

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

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 Snow Family 裝置的類型。

類型:字串

lastReachedOutAt

當裝置上次聯絡 時 AWS 雲端。表示裝置已上線。

類型:Timestamp

lastUpdatedAt

當裝置上次推送更新至 時 AWS 雲端。指示重新整理裝置快取的時間。

類型:Timestamp

managedDeviceArn

裝置的 Amazon Resource Name (ARN)。

類型:字串

managedDeviceId

您檢查資訊的裝置的 ID。

類型:字串

長度限制:長度下限為 1。長度上限為 64。

physicalNetworkInterfaces

裝置上可用的網路介面。

類型:PhysicalNetworkInterface 物件陣列

software

裝置上安裝的軟體。

類型:SoftwareInformation 物件

tags

您指派給資源的選用中繼資料。您可以使用標籤以不同方式分類資源,例如依用途、擁有者或環境。

類型:字串到字串映射

錯誤

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

AccessDeniedException

您沒有足夠的存取權來執行此動作。

HTTP 狀態碼:403

InternalServerException

處理請求時發生非預期的錯誤。

HTTP 狀態碼:500

ResourceNotFoundException

請求參考不存在的資源。

HTTP 狀態碼:404

ThrottlingException

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

HTTP 狀態碼:429

ValidationException

輸入無法滿足 AWS 服務指定的限制條件。

HTTP 狀態碼:400

另請參閱

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