As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.
DescribeDevice
Verifica as informações específicas do dispositivo, como o tipo de dispositivo, a versão do software, os endereços IP e o status do bloqueio.
Sintaxe da Solicitação
POST /managed-device/managedDeviceId/describe HTTP/1.1
Parâmetros da Solicitação de URI
A solicitação usa os seguintes parâmetros de URI:
- managedDeviceId
-
O ID do dispositivo do qual você está verificando as informações.
Restrições de tamanho: tamanho mínimo 1. Comprimento máximo de 64.
Obrigatório: Sim
Corpo da Solicitação
Essa solicitação não tem corpo.
Sintaxe da Resposta
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"
}
}Elementos de Resposta
Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.
Os dados a seguir são retornados no formato JSON pelo serviço.
- associatedWithJob
-
O ID do trabalho usado ao fazer o pedido do dispositivo.
Tipo: sequência
- deviceCapacities
-
As especificações de hardware do dispositivo.
Tipo: matriz de objetos Capacity
Membros da Matriz: número mínimo de 0 itens. Número máximo de 100 itens.
- deviceState
-
O estado atual do dispositivo.
Tipo: sequências
Valores Válidos:
UNLOCKED | LOCKED | UNLOCKING - deviceType
-
O tipo de dispositivo da família AWS Snow.
Tipo: sequência
- lastReachedOutAt
-
Quando o dispositivo entrou em contato pela última vez com o Nuvem AWS. Indica que o dispositivo está online.
Tipo: carimbo de data/hora
- lastUpdatedAt
-
Quando o dispositivo enviou pela última vez uma atualização para o Nuvem AWS. Indica quando o cache do dispositivo foi atualizado.
Tipo: carimbo de data/hora
- managedDeviceArn
-
O nome de recurso da Amazon (ARN) do dispositivo.
Tipo: sequência
- managedDeviceId
-
O ID do dispositivo do qual você está verificando as informações.
Tipo: sequência
Restrições de tamanho: tamanho mínimo 1. Comprimento máximo de 64.
- physicalNetworkInterfaces
-
As interfaces de rede disponíveis no dispositivo.
Tipo: matriz de objetos PhysicalNetworkInterface
- software
-
O software instalado no dispositivo.
Tipo: objeto SoftwareInformation
-
Metadados opcional que você atribui a um recurso. Você pode usar tags para categorizar um recurso de diferentes formas, como por finalidade, proprietário ou ambiente.
Tipo: mapa de string para string
Erros
Para obter informações sobre os erros comuns a todas as ações, consulte Erros comuns.
- AccessDeniedException
-
Você não tem acesso suficiente para executar essa ação.
Código de Status HTTP: 403
- InternalServerException
-
Ocorreu um erro inesperado ao processar a solicitação.
Código de Status HTTP: 500
- ResourceNotFoundException
-
A solicitação faz referência a um recurso que não existe.
Código de Status HTTP: 404
- ThrottlingException
-
A solicitação foi negada devido ao controle de limitação.
Código de Status HTTP: 429
- ValidationException
-
A entrada não satisfaz as restrições especificadas por um AWS serviço.
Código de Status HTTP: 400
Consulte também
Para obter mais informações sobre como usar essa API em um dos AWS SDKs específicos da linguagem, consulte o seguinte:
