API MQTT de provisionamento de dispositivos - AWS IoT Core
CreateCertificateFromCsrCreateKeysAndCertificateRegisterThing

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á.

API MQTT de provisionamento de dispositivos

O serviço de Provisionamento de frotas dá suporte às seguintes operações da API MQTT:

Essa API suporta buffers de resposta no formato Concise Binary Object Representation (CBOR) e JavaScript Object Notation (JSON), dependendo do tópico. payload-format Para clareza, os exemplos de resposta e de solicitação nesta seção são mostrados no formato JSON.

payload-format Tipo de dados do formato de resposta
cbor Representação Concisa de Objetos Binários (CBOR)
json JavaScript Notação de objeto (JSON)
Importante

Antes de publicar um tópico de mensagem de solicitação, assine os tópicos de resposta para receber a resposta. As mensagens usadas por esta API usam o protocolo MQTT de publicação/assinatura para fornecer uma interação de solicitação e resposta.

Se você não assinar os tópicos de resposta antes de publicar uma solicitação, talvez não receba os resultados dessa solicitação.

CreateCertificateFromCsr

Cria um certificado a partir de uma solicitação de assinatura de certificado (CSR). AWS IoT fornece certificados de cliente assinados pela autoridade de certificação (CA) raiz da Amazon. O novo certificado tem um status PENDING_ACTIVATION. Quando você chama RegisterThing para provisionar uma coisa com esse certificado, o status do certificado muda para ACTIVE ou INACTIVE conforme descrito no modelo.

Para obter mais informações sobre como criar um certificado de cliente usando seu certificado de Autoridade de Certificação e uma solicitação de assinatura de certificado, consulte Criar um certificado de cliente usando o certificado CA.

nota

Por segurança, o certificateOwnershipToken devolvido pelo CreateCertificateFromCsr expira após uma hora. RegisterThing deve ser chamado antes que certificateOwnershipToken expire. Se o certificado criado por CreateCertificateFromCsr não tiver sido ativado nem anexado a uma política ou a um objeto quando o token expirar, o certificado será excluído. Se o token expirar, o dispositivo poderá chamar CreateCertificateFromCsr novamente para gerar um novo certificado.

Solicitação CreateCertificateFromCsr

Publique uma mensagem com o tópico $aws/certificates/create-from-csr/payload-format.

payload-format

O formato da carga útil da mensagem como cbor ou json.

CreateCertificateFromCsrcarga útil de solicitação

{
    "certificateSigningRequest": "string"
}
certificateSigningRequest

A CSR, no formato PEM.

Resposta CreateCertificateFromCsr

Assine $aws/certificates/create-from-csr/payload-format/accepted.

payload-format

O formato da carga útil da mensagem como cbor ou json.

CreateCertificateFromCsrcarga útil de resposta

{
    "certificateOwnershipToken": "string",
    "certificateId": "string",
    "certificatePem": "string"
}
certificateOwnershipToken

O token para provar a propriedade do certificado durante o provisionamento.

certificateId

O ID do certificado. As operações de gerenciamento de certificado usam apenas um certificateId.

certificatePem

Os dados do certificado, no formato PEM.

CreateCertificateFromCsr erro

Para receber respostas de erro, assine $aws/certificates/create-from-csr/payload-format/rejected.

payload-format

O formato da carga útil da mensagem como cbor ou json.

CreateCertificateFromCsrcarga útil de erro

{
    "statusCode": int,
    "errorCode": "string",
    "errorMessage": "string"
}
statusCode

O código do status.

errorCode

O código do erro.

errorMessage

A mensagem de erro.

CreateKeysAndCertificate

Cria novas chaves e um certificado. AWS IoT fornece certificados de cliente assinados pela autoridade de certificação (CA) raiz da Amazon. O novo certificado tem um status PENDING_ACTIVATION. Quando você chama RegisterThing para provisionar uma coisa com esse certificado, o status do certificado muda para ACTIVE ou INACTIVE conforme descrito no modelo.

nota

Por segurança, o certificateOwnershipToken devolvido pelo CreateKeysAndCertificate expira após uma hora. RegisterThing deve ser chamado antes que certificateOwnershipToken expire. Se o certificado criado por CreateKeysAndCertificate não tiver sido ativado nem anexado a uma política ou a um objeto quando o token expirar, o certificado será excluído. Se o token expirar, o dispositivo poderá chamar CreateKeysAndCertificate novamente para gerar um novo certificado.

Solicitação CreateKeysAndCertificate

Publique uma mensagem em $aws/certificates/create/payload-format com uma carga de mensagem vazia.

payload-format

O formato da carga útil da mensagem como cbor ou json.

Resposta CreateKeysAndCertificate

Assine $aws/certificates/create/payload-format/accepted.

payload-format

O formato da carga útil da mensagem como cbor ou json.

Resposta CreateKeysAndCertificate

{
    "certificateId": "string",
    "certificatePem": "string",
    "privateKey": "string",
    "certificateOwnershipToken": "string"
}
certificateId

O ID do certificado.

certificatePem

Os dados do certificado, no formato PEM.

privateKey

A chave privada.

certificateOwnershipToken

O token para provar a propriedade do certificado durante o provisionamento.

CreateKeysAndCertificate erro

Para receber respostas de erro, assine $aws/certificates/create/payload-format/rejected.

payload-format

O formato da carga útil da mensagem como cbor ou json.

CreateKeysAndCertificatecarga útil de erro

{
    "statusCode": int,
    "errorCode": "string",
    "errorMessage": "string"
}
statusCode

O código do status.

errorCode

O código do erro.

errorMessage

A mensagem de erro.

RegisterThing

Provisiona uma coisa usando um modelo predefinido.

RegisterThing pedido

Publique uma mensagem em $aws/provisioning-templates/templateName/provision/payload-format.

payload-format

O formato da carga útil da mensagem como cbor ou json.

templateName

O nome do modelo provisionado.

RegisterThing carga útil de solicitação

{
    "certificateOwnershipToken": "string",
    "parameters": {
        "string": "string",
        ...
    }
}
certificateOwnershipToken

O token para provar a propriedade do certificado. AWS IoT gera o token quando você cria um certificado por MQTT.

parameters

Opcional. Pares de chave-valor do dispositivo que são usados pelos hooks de pré-provisionamento para avaliar a solicitação de registro.

RegisterThing resposta

Assine $aws/provisioning-templates/templateName/provision/payload-format/accepted.

payload-format

O formato da carga útil da mensagem como cbor ou json.

templateName

O nome do modelo provisionado.

RegisterThing carga útil de resposta

{
    "deviceConfiguration": {
        "string": "string",
        ...
    },
    "thingName": "string"
}
deviceConfiguration

A configuração do dispositivo definida no modelo.

thingName

O nome da coisa da IoT criada durante o provisionamento.

RegisterThing resposta de erro

Para receber respostas de erro, assine $aws/provisioning-templates/templateName/provision/payload-format/rejected.

payload-format

O formato da carga útil da mensagem como cbor ou json.

templateName

O nome do modelo provisionado.

RegisterThing carga útil de resposta de erro

{
    "statusCode": int,
    "errorCode": "string",
    "errorMessage": "string"
}
statusCode

O código do status.

errorCode

O código do erro.

errorMessage

A mensagem de erro.