翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
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"
}
}
レスポンス要素
アクションが成功すると、サービスは 200 HTTP レスポンスを送り返します。
次のデータは、 サービスによって JSON 形式で返されます。
- associatedWithJob
-
デバイスの注文時に使用されるジョブの ID。
型: 文字列
- deviceCapacities
-
デバイスのハードウェア仕様。
型: Capacity オブジェクトの配列
配列メンバー: 最小数は 0 項目です。最大数は 100 項目です。
- deviceState
-
デバイスの現在の状態。
型: 文字列
有効な値:
UNLOCKED | LOCKED | UNLOCKING
- deviceType
-
AWS Snow Family デバイスのタイプ。
型: 文字列
- lastReachedOutAt
-
デバイスが最後に AWS クラウドに連絡した日時。デバイスがオンラインであることを示します。
型: タイムスタンプ
- lastUpdatedAt
-
デバイスが最後にアップデートを AWS クラウドにプッシュした日時。デバイスキャッシュがいつ更新されたかを示します。
型: タイムスタンプ
- 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
以下の資料も参照してください。
言語固有の のいずれかAPIでこれを使用する方法の詳細については AWS SDKs、以下を参照してください。