APIs somente de borda para uso com dispositivos de borda do AWS IoT SiteWise

Além das APIs AWS IoT SiteWise que estão disponíveis na borda, existem outras específicas para borda. Essas APIs específicas para borda são descritas abaixo.

Authenticate

Obtém as credenciais do gateway SiteWise Edge. Você precisará adicionar usuários locais ou se conectar ao seu sistema usando LDAP ou um grupo de usuários Linux. Para obter mais informações sobre como adicionar usuários, consulte LDAP ou grupo de usuários Linux.

Sintaxe da solicitação

POST /authenticate HTTP/1.1
Content-type: application/json
{
  "username": "string",
  "password": "string",
  "authMechanism": "string"
}

Parâmetros da solicitação de URI

A solicitação não usa nenhum parâmetro de URI.

Corpo da solicitação

A solicitação aceita os dados a seguir no formato JSON.

username

O nome de usuário usado para validar a chamada de solicitação.

Tipo: sequência

Obrigatório: Sim

password

A senha do usuário solicitando as credenciais.

Tipo: sequência

Obrigatório: Sim

authMechanism

O método de autenticação para validar esse usuário no host.

Tipo: string

Valores válidos: ldap, linux, winnt

Obrigatório: sim

Sintaxe da resposta

HTTP/1.1 200
Content-type: application/json
{
  "accessKeyId": "string",
  "secretAccessKey": "string",
  "sessionToken": "string",
  "region": "edge"
}

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.

accessKeyId

O ID da chave de acesso que identifica as credenciais de segurança temporárias.

Restrições de tamanho: tamanho mínimo de 16. Comprimento máximo de 128.

Padrão: [\w]*

secretAccessKey

A chave de acesso secreta para assinar solicitações.

Tipo: string

sessionToken

O token que os usuários devem passar para a API do serviço para usar as credenciais temporárias.

Tipo: string

região

A região que você está direcionando para chamadas de API.

Tipo: CONSTANT - edge

Erros

IllegalArgumentException

A solicitação foi rejeitada porque o documento do corpo fornecido estava malformado. A mensagem de erro descreve o erro específico.

Código de Status HTTP: 400

AccessDeniedException

O usuário não tem credenciais válidas com base no provedor de identidade atual. A mensagem de erro descreve o mecanismo de autenticação.

Código de Status HTTP: 403

TooManyRequestsException

A solicitação atingiu o limite de tentativas de autenticação. A mensagem de erro contém a quantidade de tempo de espera até que novas tentativas de autenticação sejam feitas.

Código de Status HTTP: 429