本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。
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
-
Sno Amazon w Family 设备的类型。
类型:字符串
- lastReachedOutAt
-
设备上次联系 Amazon Web Services 云的时间。表示设备处于联机状态。
类型:时间戳
- lastUpdatedAt
-
设备上次将更新推送到 Amazon Web Services 云的时间。表示设备缓存何时刷新。
类型:时间戳
- managedDeviceArn
-
设备的 Amazon 资源名称(ARN)。
类型:字符串
- managedDeviceId
-
您所查看信息的设备的 ID。
类型:字符串
长度限制:长度下限为 1。长度上限为 64。
- physicalNetworkInterfaces
-
设备上可用的网络接口。
类型:PhysicalNetworkInterface 对象数组
- software
-
设备上安装的软件。
类型:SoftwareInformation 对象
-
分配给资源的可选元数据。您可以使用标签按不同的方式(如用途、拥有者或环境)对资源进行分类。
类型:字符串到字符串映射
错误
有关所有操作返回的常见错误的信息,请参阅 常见错误。
- AccessDeniedException
-
您没有足够的访问权限,无法执行该操作。
HTTP 状态代码:403
- InternalServerException
-
处理请求时出现意外错误。
HTTP 状态代码:500
- ResourceNotFoundException
-
该请求引用的资源不存在。
HTTP 状态代码:404
- ThrottlingException
-
由于请求限制而导致请求被拒绝。
HTTP 状态代码:429
- ValidationException
-
输入无法满足 Amazon 服务指定的约束。
HTTP 状态代码:400
另请参阅
有关在特定语言的 Amazon SDK 中使用此 API 的更多信息,请参阅以下内容: